Giter VIP home page Giter VIP logo

pybletoolkit's Introduction

PyBLEToolkit

PyBLEToolkit is a Python toolkit designed to provide a streamlined environment for Bluetooth Low Energy (BLE) services using customtkinter. This toolkit simplifies the development of custom BLE service interfaces, enabling developers to focus on functionality and data handling while easily integrating with a GUI framework.

Animated Images

Features

  • Easy GUI Integration: Quickly add custom frames to display and interact with BLE services.
  • Python and customtkinter Based: Uses Python for logic and customtkinter for a user-friendly interface.
  • Extensible Framework: Designed to be flexible, allowing developers to implement and showcase their BLE services seamlessly.

Prerequisites

Before you begin, ensure you have the following installed:

  • Python 3.6 or newer
  • pip (Python package installer)
  • Check requirements.txt for necessary python packages

Usage

After installation, you can start by creating a new BLE service frame. Here are the steps to integrate a new service into the toolkit:

  1. Create two objects: one for the service itself that inherits from AbstractService, and another for the GUI of your service that inherits from AbstractServiceTab. See examples.

  2. Register your service and GUI in the dictionary SERVICE_REGISTER like this:

# Service register mapping services to their corresponding tab classes
SERVICE_REGISTER: Dict[Type[AbstractService], Type[AbstractServiceTab]] = {
    MyServiceObject: MyServiceObjectTab,
    # ...
}

Once registered, you can run the application and connect to your service.

Contributing

We welcome contributions to PyBLEToolkit! To make this project more interesting and useful, we encourage developers to contribute their services with pre-prepared GUIs for various applications. Please document the protocol for data transmission.

If you have suggestions for improvements or new features, feel free to submit a pull request. Check out our CONTRIBUTING for guidelines on how to contribute.

License

This project is licensed under the MIT License—see the LICENSE file for details.

Authors

Acknowledgments

  • Inspiration from the BLE community and various open-source projects that have paved the way for this toolkit, especially Adafruit

pybletoolkit's People

Contributors

muhamm-ad avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.