Plugin Commands: Demand Response and Load Control Server

Macros

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DRLC_SERVER_PLUGIN_DRLC_SERVER_CSLCE
plugin drlc-server cslce [endpoint:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DRLC_SERVER_PLUGIN_DRLC_SERVER_LCE_SCHEDULE_MAND
plugin drlc-server lce-schedule-mand [endpoint:1] [index:1] [eventId:4] [deviceClass:2] [utilityEnrollmentGroup:1] [startTime:4] [duration:2] [criticalityLevel:1] [eventControl:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DRLC_SERVER_PLUGIN_DRLC_SERVER_PRINT
plugin drlc-server print [endpoint:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DRLC_SERVER_PLUGIN_DRLC_SERVER_SLCE
plugin drlc-server slce [endpoint:1] [index:1] [length:1] [event:-1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DRLC_SERVER_PLUGIN_DRLC_SERVER_SSLCE
plugin drlc-server sslce [nodeId:2] [srcEndpoint:1] [dstEndpoint:1] [index:1]

Detailed Description

The drlc-server plugin contributes CLI commands to the application framework to be used for constructing demand response load control commands on the server side.

Macro Definition Documentation

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DRLC_SERVER_PLUGIN_DRLC_SERVER_CSLCE

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DRLC_SERVER_PLUGIN_DRLC_SERVER_CSLCE

plugin drlc-server cslce [endpoint:1]

  • Clear the scheduled load control events table.
    • endpoint - INT8U - The relevant endpoint.

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DRLC_SERVER_PLUGIN_DRLC_SERVER_LCE_SCHEDULE_MAND

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DRLC_SERVER_PLUGIN_DRLC_SERVER_LCE_SCHEDULE_MAND

plugin drlc-server lce-schedule-mand [endpoint:1] [index:1] [eventId:4] [deviceClass:2] [utilityEnrollmentGroup:1] [startTime:4] [duration:2] [criticalityLevel:1] [eventControl:1]

  • Schedules a load control event on the server.
    • endpoint - INT8U - The relevant endpoint.
    • index - INT8U - Index of the load control event table that will be configured.
    • eventId - INT32U - The issuer event ID for this load control event.
    • deviceClass - INT16U - The device class bitfield this event applies to.
    • utilityEnrollmentGroup - INT8U - The UEG of the load control event.
    • startTime - INT32U - Time when the load control event should start.
    • duration - INT16U - Duration, in minutes, of the event.
    • criticalityLevel - INT8U - The level of criticality of the event. Higher values are more critical.
    • eventControl - INT8U - Bitmask that identifies other control options for the event.

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DRLC_SERVER_PLUGIN_DRLC_SERVER_PRINT

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DRLC_SERVER_PLUGIN_DRLC_SERVER_PRINT

plugin drlc-server print [endpoint:1]

  • Print the Demand Response Load Control Table.
    • endpoint - INT8U - The relevant endpoint.

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DRLC_SERVER_PLUGIN_DRLC_SERVER_SLCE

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DRLC_SERVER_PLUGIN_DRLC_SERVER_SLCE

plugin drlc-server slce [endpoint:1] [index:1] [length:1] [event:-1]

  • Schedule a load control event in the load control event table on a load control server. load control event bytes are expected as 23 raw bytes in the form {<eventId:4> <deviceClass:2> >ueg:1> >startTime:4> >duration:2> <criticalityLevel:1> >coolingTempOffset:1> >heatingTempOffset:1> >coolingTempSetPoint:2> >heatingTempSetPoint:2> >afgLoadPercentage:1> <dutyCycle:1> <eventControl:1> } all multibyte values should be little endian as though they were coming over the air. Example: plugin drlc-server slce 0 23 { ab 00 00 00 ff 0f 00 00 00 00 00 01 00 01 00 00 09 1a 09 1a 0a 00 }
    • endpoint - INT8U - The relevant endpoint.
    • index - INT8U - Location in the load control event table for the event to be scheduled
    • length - INT8U - The length in the number of bytes
    • event - OCTET_STRING - Byte array value for the load control event

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DRLC_SERVER_PLUGIN_DRLC_SERVER_SSLCE

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_DRLC_SERVER_PLUGIN_DRLC_SERVER_SSLCE

plugin drlc-server sslce [nodeId:2] [srcEndpoint:1] [dstEndpoint:1] [index:1]

  • Command used on a DRLC server to send a scheduled load control event out of the load control event table.
    • nodeId - INT16U - The destination node ide.
    • srcEndpoint - INT8U - The source endpoint.
    • dstEndpoint - INT8U - The destination endpoint.
    • index - INT8U - index of the load control event in the server's load control event table.