Skip to main content

Embody BLE

PyPI Status Python Version License

Tests

pre-commit Black

Features

  • Connects to an EmBody device over BLE (Bluetooth) using Bleak
  • Uses the EmBody protocol to communicate with the device
  • Integrates with the EmBody Protocol Codec project
  • Asynchronous send without having to wait for response
  • Synchronous send where response message is returned
  • Provides callback interfaces for incoming messages, response messages and connect/disconnect
  • Facade method to send/receive BLE messages directly
  • All methods and callbacks are threadsafe
  • Separate threads for send, receive and callback processing
  • Type safe code using ty for type checking
  • High level callback interface for attribute reporting

Requirements

  • Python 3.12-3.13
  • Access to private Aidee Health repositories on Github

Installation

You can install Embody BLE via pip:

$ pip install embody-ble

This adds embody-ble as a library, but also provides the CLI application with the same name.

Usage

A very basic example where you send a message request and get a response:

from embodyble.embodyble import EmbodyBle
from embodyserial.helpers import EmbodySendHelper

embody_ble = EmbodyBle()
send_helper = EmbodySendHelper(sender=embody_ble)
embody_ble.connect()
print(f"Serial no: {send_helper.get_serial_no()}")
embody_ble.shutdown()

If you want to see more of what happens under the hood, activate debug logging before setting up EmbodyBle:

import logging

logging.basicConfig(level=logging.DEBUG)

Using the application from the command line

The application also provides a CLI application that is automatically added to the path when installing via pip.

Once installed with pip, type:

embody-ble --help

To see which options are available.

Note The serial port is automatically detected, but can be overridden by using the --device option.

Example - Attribute reporting

To see how attribute reporting can be configured, have a look at the example in examples/ble_reporting_example.py

You can also test attribute reporting using the cli:

embody-ble --log-level INFO --report-attribute battery_level --report-interval 1
embody-ble --log-level INFO --report-attribute heart_rate --report-interval 1000

Example - List all available EmBody devices

embody-ble --list-devices

Example - List all attribute values

embody-ble --get-all

Example - Get serial no of device

embody-ble --get serialno

Example - List files over serial port

embody-ble --list-files

Example - Set time current time (UTC)

embody-ble --set-time

Logging

This library uses Python's standard logging module and follows best practices for libraries:

For Library Users

The library is silent by default - it won't produce any output unless you configure logging. To enable logging from the library:

import logging

# Enable INFO level logging for embodyble
logging.getLogger('embodyble').setLevel(logging.INFO)
logging.getLogger('embodyble').addHandler(logging.StreamHandler())

# Or configure specific modules
logging.getLogger('embodyble.embodyble').setLevel(logging.DEBUG)

For CLI Users

The CLI configures logging automatically. Use --log-level to control verbosity:

embody-ble --log-level DEBUG --list-devices

Available levels: CRITICAL, WARNING, INFO, DEBUG

Troubleshooting

No known issues registered.

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

embody_ble-1.1.32.tar.gz (19.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

embody_ble-1.1.32-py3-none-any.whl (21.7 kB view details)

Uploaded Python 3

File details

Details for the file embody_ble-1.1.32.tar.gz.

File metadata

  • Download URL: embody_ble-1.1.32.tar.gz
  • Upload date:
  • Size: 19.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for embody_ble-1.1.32.tar.gz
Algorithm Hash digest
SHA256 ce77eab798a639557916181b87c4187177e49bd7d1de1422ddebdd36d1aa3a13
MD5 2d60164c29d451ee8016649e174aecaf
BLAKE2b-256 4650f5d71c42be840560c0d22c7428e116a445385d31dedfc7e5d8949db6bd7d

See more details on using hashes here.

File details

Details for the file embody_ble-1.1.32-py3-none-any.whl.

File metadata

  • Download URL: embody_ble-1.1.32-py3-none-any.whl
  • Upload date:
  • Size: 21.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for embody_ble-1.1.32-py3-none-any.whl
Algorithm Hash digest
SHA256 de2fd30fef366735edce14783be2287b672c8ced2b4b47ab0a6542dd91ee8f82
MD5 d4a9033b464ee3df7a6a4c5fb4ae6bcc
BLAKE2b-256 be8d4f973f505c6d796369d04ac1dce7a25d556d832cf7c58d8cfd58e49248e8

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.1.32 This release

2 files

1.1.31

2 files

1.1.29

2 files

1.1.28

2 files

1.1.27

2 files

1.1.26

2 files

1.1.25

2 files

1.1.24

2 files

1.1.23

2 files

1.1.22

2 files

1.1.20

2 files

1.1.19

2 files

1.1.18

2 files

1.1.17

2 files

1.1.16

2 files

1.1.15

2 files

1.1.14

2 files

1.1.13

2 files

1.1.11

2 files

1.1.10

2 files

1.1.9

2 files

1.1.8

2 files

1.1.7

2 files

1.1.6

2 files

1.1.5

2 files

1.1.4

2 files

1.1.3

2 files

1.1.2

2 files

1.1.1

2 files

1.1.0

2 files

1.0.12

2 files

1.0.11

2 files

1.0.10

2 files

1.0.9

2 files

1.0.8

2 files

1.0.7

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page