Mirror/AI-on-the-edge-device-docs
1
0
Fork 0
mirror of https://github.com/jomjol/AI-on-the-edge-device-docs.git synced 2025-12-10 13:36:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Format

Browse Source
This commit is contained in:
Slider0007
2023-03-31 10:30:45 +02:00
committed by GitHub
parent 15b5f6e514
commit 060a183013
1 changed files with 18 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
docs/REST-API.md
View File

@@ -8,37 +8,33 @@ Note: For more detailed information to the REST handler, have a look to the code
## Control ## Control
* ### flow_start * ### flow_start
Trigger a flow start (if not running) Trigger a flow start (if not running)
+ Payload:
- No payload needed
* ### setPreValue * ### setPreValue
Set the last valid value (previous value) to given value or the actual RAW value. Set the last valid value (previous value) to given value or the actual RAW value.
+ Payload:
Payload: - Set to given value (value >= 0), e.g. `/setPreValue?numbers=main&value=1234.5678`
* `numbers=` Provide name of number sequence, e.g. main
1. Set to given value (value >= 0), e.g. `/setPreValue?numbers=main&value=1234.5678` * `value=` provide the value to be set
-> `numbers=` Provide name of number sequence, e.g. main - Set to actual RAW value (value < 0, a valid RAW value is mandatory), e.g. `/setPreValue?numbers=main&value=-1`
* `numbers=` Provide name of number sequence, e.g. main
-> `value=` provide the value to be set * `value=` provide yna negative number
2. Set to actual RAW value (value < 0, a valid RAW value is mandatory), e.g. `/setPreValue?numbers=main&value=-1`
-> `numbers=` Provide name of number sequence, e.g. main
-> `value=` provide yna negative number
* ### GPIO * ### GPIO
- Control a GPIO output - Control a GPIO output
- The `GPIO` entrypoint also support parameters: - The `GPIO` entrypoint also support parameters:
- `/GPIO?GPIO={PinNumber}&Status=high` - `/GPIO?GPIO={PinNumber}&Status=high`
- `/GPIO?GPIO={PinNumber}&Status=low` - `/GPIO?GPIO={PinNumber}&Status=low`
- Example: `/GPIO?GPIO=12&Status=high` - Example: `/GPIO?GPIO=12&Status=high`
- Read a GPIO input - Read a GPIO input
- The `GPIO` entrypoint also support parameters: - The `GPIO` entrypoint also support parameters:
- `/GPIO?GPIO={PinNumber}` - `/GPIO?GPIO={PinNumber}`
- Example: `/GPIO?GPIO=12` - Example: `/GPIO?GPIO=12`
* ### ota * ### ota