https://github.com/lupin3000/colmismartring
Read information via Python from Colmi Smart Ring
https://github.com/lupin3000/colmismartring
ble colmi python smart-ring
Last synced: 12 months ago
JSON representation
Read information via Python from Colmi Smart Ring
- Host: GitHub
- URL: https://github.com/lupin3000/colmismartring
- Owner: Lupin3000
- Created: 2025-01-31T09:09:45.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-23T08:09:43.000Z (over 1 year ago)
- Last Synced: 2025-06-18T23:42:00.916Z (about 1 year ago)
- Topics: ble, colmi, python, smart-ring
- Language: Python
- Homepage: https://softwaretester.info
- Size: 22.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Colmi Smart Ring - Python
## Minimum requirements
[](https://python.org)
[](https://docs.python.org/dev/library/asyncio.html)
[](https://bleak.readthedocs.io/en/latest/)
## Installation
> Tested with Colmi Smart Ring R06 (_but should work with mostly all Colmi Smart Rings_).
1. Clone this repository
2. Create Python virtualenv (_recommended_)
3. Install required Python modules/packages (_via requirements.txt_)
```shell
# clone repository
$ git clone https://github.com/Lupin3000/ColmiSmartRing.git
# change into cloned directory
$ cd ColmiSmartRing/
# create virtualenv
$ python -m venv .venv
# activate virtual environment
$ .venv/bin/activate
# update pip (optional)
(.venv) $ pip3 install -U pip
# show content of requirements.txt (optional)
(.venv) $ cat requirements.txt
# install all modules/packages
(.venv) $ pip3 install -r requirements.txt
# list all modules/packages (optional)
(.venv) $ pip3 freeze
```
## Scan for Colmi Smart Ring
> To use all Python scripts, you need the BLE address of your Colmi Smart Ring!
```shell
# scan for smart ring address
(.venv) $ python3 ColmiRingScanner.py
```
Sometimes the scanner will not find the Colmi Smart Ring, please try again! If you found the Colmi Smart Ring and selected it. The Python script will create a new directory (_config_). Inside this newly created directory a new file is created (_colmi_address.py_) with two constants (_RING_NAME and RING_ADDRESS_). These constants are used later by all other Python scripts.
## Read data from Colmi Smart Ring
**Note:** Sometimes the BLE connection will not be established on first run, just try the respective Python script again.
### Accelerometer
> This Python script will read and print continuously the data from accelerometer (_X, Y, Z_).
>> To stop the script and BLE connection press keys: [Ctrl] + [c].
```shell
# read accelerometer data
(.venv) $ python3 ColmiRingAccelerometer.py
```
### Real-time Heart Rate
> This Python script will read max. 5 values and print the average data for heart-rate (_bpm_).
>> To stop the script and BLE connection press keys: [Ctrl] + [c].
```shell
# read heart rate data
(.venv) $ python3 ColmiRingHeartRate.py
```
### Real-time SpO2
> This Python script will read max. 5 values and print the average data for SpO2 (_%_).
>> To stop the script and BLE connection press keys: [Ctrl] + [c].
```shell
# read SpO2 data
(.venv) $ python3 ColmiRingSPO2.py
```