Skip to main content

Python API for GShock Watches using BLE

Project description

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)

Running the tests

To run the test do the following:

uv run src/examples/api_tests.py

or activate venv` first and then run using python:

source .venv/bin/activate
python src/examples/api_tests.py

Installing the library for your project:

Add dependency on this library in your pyproject.toml

dependencies = [
   "gshock-api>=2.0.36",
   ...
]

Troubleshooting:

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

Project details


Download files

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

Source Distribution

gshock_api-2.0.41.tar.gz (47.9 kB view details)

Uploaded Source

Built Distribution

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

gshock_api-2.0.41-py3-none-any.whl (60.6 kB view details)

Uploaded Python 3

File details

Details for the file gshock_api-2.0.41.tar.gz.

File metadata

  • Download URL: gshock_api-2.0.41.tar.gz
  • Upload date:
  • Size: 47.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for gshock_api-2.0.41.tar.gz
Algorithm Hash digest
SHA256 b23405e0b4866657533e8d2e737cea638b919d679e4816df17a86a11bb9d340d
MD5 00cd1d2286e75c949bf7c360b7d8282b
BLAKE2b-256 dc564e64f85a3daace790432bfa9a4a89a827fb9b790bbbdd6c8b62bd9ad2a54

See more details on using hashes here.

File details

Details for the file gshock_api-2.0.41-py3-none-any.whl.

File metadata

  • Download URL: gshock_api-2.0.41-py3-none-any.whl
  • Upload date:
  • Size: 60.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for gshock_api-2.0.41-py3-none-any.whl
Algorithm Hash digest
SHA256 240ab67ee7cfb874f056fe566a3a9c3d14e90e92c7cee740f9351fe4a229a79f
MD5 52d602c5c6256bd8f84feb2414205e00
BLAKE2b-256 e57f7faae08913fdbd0e6d0986df56d51d44e796047621663ec9b155b30c9a8d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page