diff --git a/APIs/README.md b/APIs/README.md index 35b06a2..a7f139d 100644 --- a/APIs/README.md +++ b/APIs/README.md @@ -1,7 +1,15 @@ +## Description + Currently, the API supports the following commands: - **DeviceList:** For seeing list of devices - **ChannelOccupancy:** For percentage of datarate in each channel - **RSSI:** For distribution of RSSI in percentage - **SNR:** For distribution of SNR in percentage - **NetworkList:** For list of networks and their unique number of devices connected -- **SpectrumPolicing:** For list of devices transmission intervals and a boolean on whether they are breaching the spectrum policy +- **SpectrumPolicing:** Plot of observed device-wise transmission intervals against spectrum policy + +## Instructions + +* Download the `.py` script to the directory whether LoRadar data are stored. + +* Run the script and follow the instructions shown in the terminal.