Predefined commands (station and application layers)

Some commands are already implemented as a part of standard nCloudDriver functionality and can be invoked without additional coding. These commands are developed by the Tridium development team and have passed the required security tests.

For Sentience 1.0 these are system commands, each with a particular ID.

Command Id Command description Command parameters Command Response
Replicas of Sentience 1.0 "native" commands to be used with "secured execution"

AlarmAckCommand

Acknowledge the Alarm

COMMAND_PAYLOAD.ALARMID CommandPayload.AlarmId

Returns Status and Message for the Alarm Ack

CloudPointReadCommand

Read value of one point

COMMAND_PAYLOAD.POINTID CommandPayload.PointId

Returns value, quality and timestamp for one point

CloudPointReadInputsCommand

Reads the active inputs to a cloud proxy point.

CommandPayload.PointId

Returns Source, Priority, Value, and Expiration for each active cloud write to the point.

CloudMultiPointReadInputsCommand

Read active writes to a group of points

CommandPayload.PointIds

Returns Source, Priority, Value, and Expiration for each active cloud write to each point.

CloudMultiPointReadCommand

Read values of multiple points

COMMAND_PAYLOAD.POINTIDS CommandPayload.PointIds

Returns values, quality and timestamp for multiple points

CloudPointWriteCommand

Write value of one point

COMMAND_PAYLOAD.POINTID, COMMAND_PAYLOAD.VALUE CommandPayload.PointId CommandPayload.Value CommandPayload.Priority

CommandPayload.Duration

CommandPayload.Source

Returns result of the Write operation (Success/Fail) for one point

CloudMultiPointWriteCommand

Write values of multiple points

COMMAND_PAYLOAD.POINTWRITES{POINTID, Value} CommandPayload.PointWrites{PointId, Value, Priority, Duration, Source}

Returns results of the Write operation (Success/accessNotAllowed) for multiple points

Additional predefined commands

BatchAlarmAckCommand

Acknowledge multiple Alarms  (identified by Alarm Ids)

COMMAND_PAYLOAD.ALARMS CommandPayload.Alarms

Returns Status and Message for multiple Alarm Acks

CloudMultiPointClearCommand

Clear points value to null

COMMAND_PAYLOAD.POINTIDS CommandPayload.PointIds

Returns results of the Clear operation (Success/accessNotAllowed) for multiple points

CovActiveCommand

Change Point to COV mode

COMMAND_PAYLOAD.POINTIDS CommandPayload.PointIds

Returns the result of changing point mode operation for each point

CovInactiveCommand

Change Point back from COV  to snapshot mode

COMMAND_PAYLOAD.POINTIDS CommandPayload.PointIds

Returns the result of changing point mode operation for each point

InvokeCommand

Execute Action on Component

TO BE UPDATED LATER

TO BE UPDATED LATER

RetrieveCloudPointsCommand

Retrieve the list of all cloud exposed points

-

Returns list of Ids for all cloud exposed points

SubscribePointsCommand

Place one or more cloud points' associated station points into subscription

CommandPayload.PointIds

Returns list of successes and failures for the point subscribes.

UnsubscribePointsCommand

Place one or more cloud points' associated station points out of subscription

CommandPayload.PointIds

Returns list of successes and failures for the point unsubscribes.

ACTION: Use predefined command ids and parameters

Issue commands with predefined IDs and correct parameters using the standard cloud platform APIs (System Command API for Sentience 1.0).

Listen for command response events (Annotation Stream for Sentience 1.0)