Elara6331/itd
4
6
Fork 12
Code Issues 8 Pull Requests 1 Projects Releases 11 Wiki Activity

Update readme

Browse Source
This commit is contained in:
Elara 2021-10-22 17:12:46 -07:00
parent 869f487456
commit b63960ed88
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -15,7 +15,7 @@
- Notification transliteration - Notification transliteration
- Call Notifications (ModemManager) - Call Notifications (ModemManager)
- Music control - Music control
- Get info from watch (HRM, Battery level, Firmware version) - Get info from watch (HRM, Battery level, Firmware version, Motion)
- Set current time - Set current time
- Control socket - Control socket
- Firmware upgrades - Firmware upgrades
@ -29,7 +29,7 @@ This daemon creates a UNIX socket at `/tmp/itd/socket`. It allows you to directl
The socket accepts JSON requests. For example, sending a notification looks like this: The socket accepts JSON requests. For example, sending a notification looks like this:
```json ```json
{"type": "notify", "data": {"title": "title1", "body": "body1"}} {"type": 5, "data": {"title": "title1", "body": "body1"}}
``` ```
It will return a JSON response. A response can have 3 fields: `error`, `msg`, and `value`. Error is a boolean that signals whether an error was returned. If error is true, the msg field will contain the error. Value can contain any data and depends on what the request was. It will return a JSON response. A response can have 3 fields: `error`, `msg`, and `value`. Error is a boolean that signals whether an error was returned. If error is true, the msg field will contain the error. Value can contain any data and depends on what the request was.
@ -83,10 +83,10 @@ This is the `itctl` usage screen:
Control the itd daemon for InfiniTime smartwatches Control the itd daemon for InfiniTime smartwatches
Usage: Usage:
itctl [flags]
itctl [command] itctl [command]
Available Commands: Available Commands:
completion generate the autocompletion script for the specified shell
firmware Manage InfiniTime firmware firmware Manage InfiniTime firmware
get Get information from InfiniTime get Get information from InfiniTime
help Help about any command help Help about any command
@ -94,7 +94,8 @@ Available Commands:
set Set information on InfiniTime set Set information on InfiniTime
Flags: Flags:
-h, --help help for itctl -h, --help help for itctl
-s, --socket-path string Path to itd socket
Use "itctl [command] --help" for more information about a command. Use "itctl [command] --help" for more information about a command.
``` ```