wiki:Internal/AntennaController

Antenna Controller

REST API

All valid calls will reply with formatted XML. The first line will be <response status="OK"> for commands that execute correctly, or <response status="ERROR"> if either the parameters passed are invalid of the call failed for some other reason (check /var/log/syslog on the relevant Pi for more information).

REST API Call Description
/Antenna/enable Powers up the antenna and enables further communication. Takes 3-4 seconds for antenna to "boot up".
/Antenna/disable Powers down the antenna.
/Antenna/select?pattern=<int> Selects the requested antenna pattern (valid numbers: 0 to 49)
/Antenna/status Returns status information: last known configured pattern and whether the antenna is enabled.
/Antenna/default Restores antenna configuration to defaults: auto TX/RX on omni and directional ports, 115200bpbs on RS485, selects pattern 49 (all array elements off).
/Antenna/factory_restore Restores antenna pattern states to factory configuration. THIS TAKES 11 MINUTES TO COMPLETE. DO NOT USE UNLESS NECESSARY.

Example XML responses:

Response to: …/Antenna/enable

<?xml version="1.0" encoding="UTF-8"?>
<response status="OK">
  <action service="antenna" name="status">
    <nodes>
      <node ip="10.3.0.28" pattern="49" enabled="false"/>
    </nodes>
  </action>
</response>

Response to: …/Antenna/status

<?xml version="1.0" encoding="UTF-8"?>
<response status="OK">
  <action service="antenna" name="enable">
    <nodes>
      <node ip="10.3.0.28" return="true"/>
    </nodes>
  </action>
</response>
Last modified 4 years ago Last modified on Oct 14, 2016, 9:30:16 PM
Note: See TracWiki for help on using the wiki.