LSS-2404
46 |
P a g e
E.
API Commands
HTTP RESTful APIs
APIs follow general rule of '=' indicates set and no '=' indicates get. The exception is when a get API requires a
value. Set APIs generally return xxx=PASS or xxx=FAIL. Get APIs return either a single value or a JSON object.
Note that frames referenced by sequences need to be loaded first. Similarly, sequences referenced by series
needed to loaded first.
Info
/info
Returns number of HTTP accesses since power up.
/version
Returns firmware name and version.
/PCB
Returns PCB info (id, rev, and mod) in 12 bit in hex format.
/id
Returns processor 96 bit unique factory programmed Device ID in hex format.
/temp
Returns floating point temperature inside processor in degrees C.
Recipe
/frame=
Sets a Frame in active Recipe (JSON format).
/frame
Returns space separated list of Frame names contained in active Recipe.
/sequence=
Sets a Sequence in active Recipe (JSON format).
/sequence
Returns space separated list of Sequence names contained in active Recipe.
/series=
Sets the Series in active Recipe (JSON format).
/series
Returns Series names contained in active Recipe.
/config=
Sets the Config in active Recipe (JSON format).
/config
Returns Series names contained in active Recipe.