Karl Hammar
Per Karlberg
This REC module covers the actuation model, i.e., south- and northbound message syntaxes for requesting and enacting actuation on building systems of various types, and the interfaces/payload schemas associated with such systems.
RealEstateCore Consortium
RealEstateCore Actuation Module
2020-05-15
actuation
https://w3id.org/rec/actuation/3.1.3/
3.1.3
(Optional) reference to any sensors that are configured/designed to observe the actuators that were acted upon by the execution of the actuation request.
actuation observed by
generated command
Reference to the response(s) to the subsystem commands that were generated by the platform to execute this actuation.
generated command response
has actuation interface
has command response
has default actuation interface
has request response
is actuation interface of
is default actuation interface of
payload Key-Value definition
The agent that initiated actuation, i.e., that created an actuation request (and consequently, was the original source also of subsequent generated actuation commands).
requesting agent
response code
response to command
response to request
target actuator
target interface
value restriction
was generated from request
The payload to be passed on to some actuation interface and finally actuator.
actuation payload
response code as integer
response code as string
Boolean
Float
Integer
String
Enumeration
None
Range
1
1
1
1
Message from a REC platform to a specific actuator or system, requesting that an actuation be carried out.
Actuation command
1
1
Return message from a specific actuator or system to a a REC platform, indicating whether an actuation has been accepted by that actuator/system. Note that a positive response does not imply that the real-world actuation has been fully carried out -- certain devices have a very long response time, dependent on physical processes, bus saturations, etc. To record the real-world state of such devices, use a sensor device instead.
Actuation command response
This class is a simple cognitive clustering of various types of events/messages that make up the REC actuation model, to group them in ontology editing tools and visualizations. The class should in most cases not be used as typing for any individuals.
Actuation event
actuationinterface
true
1
An interface describing the expected payload structure for one or more actuators.
Actuation interface
1
1
1
1
1
An incoming request from a client or other component, for an actuation to be carried out on one or many actuators or systems.
Actuation request
1
1
1
Message returned to a client or component, reporting that actuation commands have been passed to one or more actuators or systems, and reporting the response status of those actuators or systems.
Note that positive responses from actuators/systems do not imply that the real-world actuations have been fully carried out -- certain devices have a very long response time, dependent on physical processes, bus saturations, etc. To record the real-world state of such devices, use a sensor device instead.
Actuation request response
1
1
1
1
Defines allowable or required structures for key-value lists. Used in interface definitions.
Key-Value definition
The response code, as reported by an actuator or subsystem, to an actuation command. Typically packaged within an ActuationResponse message.
Response code
Defines constraints on values in key-value lists, e.g., for defining interfaces.
Value restriction