Commands

note

This resource allows user to request a special behaviour to SENSR. Detailed behaviour of each commands are described below.

POST

/[SENSR version]/commands/start

• Request to start or transition to a new mode.

• Parameters
  • mode : The new mode. This can be either calibration (project setup mode) or runtime.
• Return code
  • 200 OK
  • 400 BAD REQ

• Example

$ curl -X POST 'http://localhost:9080/[SENSR version]/commands/start?mode=calibration'
$ curl -X POST 'http://localhost:9080/[SENSR version]/commands/start?mode=runtime'

/[SENSR version]/commands/apply-change

• Save the project and apply all the configuration settings that have been changed (algo nodes, sensors, zones, algorithm parameters, etc).

• Parameters
  • N/A
• Return code
  • 200 OK

• Example

$ curl -X POST 'http://localhost:9080/[SENSR version]/commands/apply-change'

/[SENSR version]/commands/reload

• Reload the current project from saved configuration. This will revert any unsaved changes to the settings.

• Parameters
  • N/A
• Return code
  • 200 OK

• Example

$ curl -X POST 'http://localhost:9080/[SENSR version]/commands/reload'

/[SENSR version]/commands/cancel

• Request to cancel mode switching. This command is useful when SENSR does not respond because of wrong setup of algo node.

• Parameters
  • N/A
• Return code
  • 200 OK

• Example

$ curl -X POST 'http://localhost:9080/[SENSR version]/commands/cancel'