Update REST-API.md

This commit is contained in:
Slider0007
2023-01-19 22:18:13 +01:00
committed by GitHub
parent 2a1b86dc4e
commit 5e77786895

View File

@@ -1,10 +1,10 @@
# REST API # REST API
Various information is directly accessible over specific REST calls. Various information is directly accessible over specific REST calls.
For an up-to-date list search the Github repository for [registered handlers](https://github.com/jomjol/AI-on-the-edge-device/search?q=camuri.uri)
To use it, just append them to the IP, separated with a `/`, eg. `http://192.168.1.1/json` To use it, just append them to the IP, separated with a `/`, eg. `http://192.168.1.1/json`
Note: For more detailed information to the REST handler, have a look to the code in the repository: [registered handlers](https://github.com/jomjol/AI-on-the-edge-device/search?q=camuri.uri)
## Control ## Control
* ### flow_start * ### flow_start
Trigger a flow start (if not running) Trigger a flow start (if not running)
@@ -14,15 +14,15 @@ To use it, just append them to the IP, separated with a `/`, eg. `http://192.168
`/setPreValue?value=1234&numbers=main` where `1234` is the new value and `main` the name of the number to be adjusted. `/setPreValue?value=1234&numbers=main` where `1234` is the new value and `main` the name of the number to be adjusted.
* ### 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`