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.40.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.40-py3-none-any.whl (60.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gshock_api-2.0.40.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.40.tar.gz
Algorithm Hash digest
SHA256 982b200fdf6301865e0da6de68e8ac83b236bb40da02c63d44cd4e77e8bc99bc
MD5 7572999d8e9c96e463eb6971580c7ca1
BLAKE2b-256 2e0276386d68efb4f2941e1045250c35a9d7338419d71ec12b152d8c05ed61e4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gshock_api-2.0.40-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.40-py3-none-any.whl
Algorithm Hash digest
SHA256 4e76d09f5fc153adb919ac42f42166aa39dd4af10bcb9d4be67aa3c913058f9d
MD5 b6350b444794be7065e34c7f965e4500
BLAKE2b-256 8a5970d98788998ff13603048bbea71a1f12104815a9d721a452921c846cdb6a

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