This API can't be easier, it has only two actions:
- WriteValue: Feed your Signal
- ReadValue: Read a Signal value (yours, shared with you or public)
Below you can check them manually. Fill the parameters needed, press "Try" button and get server response.
Notice that this changes will actually take effect! This is not a simulation.
Refresh the instant value for the signal.
The public key that identifies the signal to feed
The actual value written
Value of the latitude.
Value of the longitude.
Value of the altitude.
Request parameters must be JSON encoded in the body of the message.
If lat, lon or alt are not sent, position will be ignored.
If value is not sent it will be ignored.
Either value or position must be defined, otherwise an error "400" will be returned.
If position is not defined the signal will be considered "motionless".
If position is defined once, position will be stored, but still will be considered "motionless".
If position is changed for the second time, signal is considered as "mobile"
key[String]: The key of the signal written
Message[String]: Circus Server specific status message
Response status codes / messages
Get the actual value for the signal.
The public key that identifies the signal to be read
key[String]: The key of the signal read
Value[Double]: Value read from signal
Lat[Double]: Latitude coordinate of the signal's location
Lon[Double]: Longitude coordinate of the signal's location
Alt[Double]: Altitude coordinate of the signal's location
IsMobile[Boolean]: True if signal is mobile, false if it's static
Message[String]: The server message about the query