VE7UWU
/
sdrangel
mirror of https://github.com/f4exb/sdrangel.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

REST API examples: added randomize_colors.py in the readme

This commit is contained in:
f4exb 2019-01-18 01:15:12 +01:00
parent 918e42e8c5
commit 989dbc28b6
1 changed files with 36 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
swagger/sdrangel/examples/Readme.md
View File

@ -102,6 +102,25 @@ It uses the following APIs:
- URI: `/sdrangel/deviceset/{deviceSetIndex}/device/run`
- HTTP method: `DELETE`
<h2>randomize_colors.py</h2>
Randomize channel colors for a specified device set
It uses the following APIs:
- Get information on a device set
- Operation ID: `devicesetGet`
- URI: `/sdrangel/deviceset/{deviceSetIndex}`
- HTTP method: `GET`
- To get the settings of a channel:
- OperationID: `devicesetChannelSettingsGet`
- URI: `/sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings`
- HTTP method: `GET`
- To change the settings of a channel:
- OperationID: `devicesetChannelSettingsPatch`
- URI: `/sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings`
- HTTP method: `PATCH`
<h2>reverseapi.py</h2>
This script runs continuously to act as the server side of SDRangel reverse API feature. It will respond with a copy of the settings when forwarding channel or device settings which is a valid reply and will also send back a valid reply when forwarding the device start/stop actions. The reverse API feature was implemented in version 4.3.2 and you can learn more about it in the Wiki.