gshock-api 2.0.12

Pythgon API for GShock Watches using BLE

gshock_api

Announcement

The library now supports sending application-level notifications to watches that support it, namely:

• DW-H5600

• GBD-H2000

• GBD-200

• GBD-100

• GBD-800

• GBD-100BAR

• GBX-100

The new API is send_app_notification function. See the examples/api_test.py file for usage examples.

Only the DW-H5600 watch has been tested. If you have any of the watches supporting notifications, please let me know your findings.

Overview

This is a Python API library for G-Shock watches that support Bluetooth Low Energy (BLE) communication.

G(M)W-5600, G(M)W-5000, GA-B2100, GA-B001-1AER, GST-B500, GST-B200, MSG-B100, G-B001, GBD-H1000 (Partial support), MRG-B5000, GCW-B5000, GG-B100, ABL-100WE, Edifice ECB-30, ECB-10, ECB-20, most Edifice watches, most Protrek models.

It can perform the following tasks:

• Set watch’s time

• Set Home Time (Home City)

• Set Alarms

• Set Reminders

• Set watch’s settings.

• Get watch’s name

• Get watch’s battery level

• Get Watch’s temperature

• Get/Set watch’s Timer

• Send notifications to watch (supported models)

Dependencies

This project requires the following Python packages: .. code-block:: sh

pytz bleak

So you can install them using the following command: .. code-block:: sh

pip3 install -r requirements.txt

To understand how to use the library, please refer to the `src/examples` folder.

Virtual Environment Setup

It is recommended that you create a virtual environment to run the tests:

1. Create a virtual environment:

   # Create a virtual environment
   python3 -m venv venv
   
   # Activate it (Mac/Linux)
   source venv/bin/activate
   
   # Install dependencies
   pip3 install -e .

2. Run the tests:

   python3 src/examples/api_tests.py [--multi-watch]

The optional `–multi-watch` parameter forces the library to scan for watches every time it tries to connect to a watch. If not provided, the library will try to connect to the last connected watch only. If you have multiple watches, you should use this parameter.

The optional `–multi-watch` parameter forces the library to scan for watches every time it tries to connect to a watch. If not provided, the library will try to connect to the last connected watch only. If you have multiple watches, you should use this parameter.

Installing the library for your project:

pip3 install gshock-api

See this project using this library to run a time server for G-Shock watches.

See also this blog for using the library in the SXMO mobile environment.

Troubleshooting:

If your watch cannot connect, and the `–multi-watch` parameter is not used, remove the `config.ini` file and try again.