Created Reverse API (markdown)

Reverse-API.md

@@ -0,0 +1,19 @@
+# Introduction
+
+This feature has been added to be able to forward channel and device settings changes to an external application using the same REST API interface as the one used to communicate settings changes to SDRangel. These AP endpoints are used:
+* `/sdrangel/deviceset/{deviceSetIndex}/device/settings` with `PATCH` method to transmit device settings. The `deviceSetIndex` variable is the targeted device set index (unsigned integer)
+* `/sdrangel/deviceset/{deviceSetIndex}/channel/{channelIndex}/settings` with `PATCH` method to transmit channel settings. The `deviceSetIndex` variable is the targeted device set index (unsigned integer) and the `channelIndex` variable is the channel sequence number (unsigned integer).
+* `/sdrangel/deviceset/{deviceSetIndex}/device/run` with `POST` method to transmit start device action. The `deviceSetIndex` variable is the targeted device set index (unsigned integer)
+* `/sdrangel/deviceset/{deviceSetIndex}/device/run` with `DELETE` method to transmit stop device action. The `deviceSetIndex` variable is the targeted device set index (unsigned integer)
+
+# GUI features
+
+The forwarding of settings and/or start/stop action can be activated via GUI along with the connection parameters: address, port, device and if applicable channel indexes. 
+
+## From device GUI
+
+This is accessed by right clicking on the start/stop button as described here: https://github.com/f4exb/sdrangel/blob/master/sdrgui/readme.md#212-right-click
+
+## From channel GUI
+
+This is accessed by clicking on the top left grey square as described here: https://github.com/f4exb/sdrangel/blob/master/sdrgui/readme.md#6-channels