made by pyLODE

RealEstateCore Actuation Module

Metadata

IRI
https://w3id.org/rec/actuation/
Publisher(s)
RealEstateCore Consortium
Creator(s)
Per Karlberg
Karl Hammar
Modified
2019-11-07
Version Information
3.1.1
Version IRI
https://w3id.org/rec/actuation/3.1.1/
Imports
https://w3id.org/rec/device/3.1.1/
Ontology Source
RDF (xml)

Description

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.

Table of Contents

  1. Classes
  2. Object Properties
  3. Functional Properties
  4. Datatype Properties
  5. Namespaces
  6. Legend

Overview

Figure 1: Ontology overview

Classes

Actuation commandc

IRI https://w3id.org/rec/actuation/ActuationCommand
Description Message from a REC platform to a specific actuator or system, requesting that an actuation be carried out.
Super-classes ActuationEventc
Restrictions hasCommandResponseop max 1
targetActuatorop only https://w3id.org/rec/device/Actuatorc
actuationPayloaddp only xsd:stringc
requestingAgentop exactly 1
requestingAgentop only https://w3id.org/rec/core/Agentc
wasGeneratedFromRequestop exactly 1
actuationPayloaddp exactly 1
In domain of wasGeneratedFromRequestop
hasCommandResponseop
In range of responseToCommandop
generatedCommandop

Actuation command responsec

IRI https://w3id.org/rec/actuation/ActuationCommandResponse
Description 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.
Super-classes ActuationEventc
Restrictions responseCodeop exactly 1
responseToCommandop exactly 1
In domain of responseCodeop
responseToCommandop
In range of hasCommandResponseop
generatedCommandResponseop

Actuation eventc

IRI https://w3id.org/rec/actuation/ActuationEvent
Description 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.
Super-classes https://w3id.org/rec/device/DeviceEventsc
Sub-classes ActuationRequestc
ActuationCommandResponsec
ActuationCommandc
ActuationRequestResponsec

Actuation interfacec

IRI https://w3id.org/rec/actuation/ActuationInterface
Description An interface describing the expected payload structure for one or more actuators.
Super-classes https://w3id.org/rec/core/Softwarec
Restrictions payloadKeyValueDefinitionop min 1
In domain of isActuationInterfaceOfop
isDefaultActuationInterfaceOfop
payloadKeyValueDefinitionop
In range of targetInterfaceop
hasDefaultActuationInterfaceop
hasActuationInterfaceop

Actuation requestc

IRI https://w3id.org/rec/actuation/ActuationRequest
Description An incoming request from a client or other component, for an actuation to be carried out on one or many actuators or systems.
Super-classes ActuationEventc
Restrictions hasRequestResponseop max 1
targetInterfaceop max 1
requestingAgentop only https://w3id.org/rec/core/Agentc
actuationPayloaddp exactly 1
requestingAgentop exactly 1
targetActuatorop only https://w3id.org/rec/device/Actuatorc
actuationPayloaddp only xsd:stringc
targetActuatorop min 1
In domain of targetInterfaceop
generatedCommandop
hasRequestResponseop
In range of wasGeneratedFromRequestop
responseToRequestop

Actuation request responsec

IRI https://w3id.org/rec/actuation/ActuationRequestResponse
Description 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.
Super-classes ActuationEventc
Restrictions requestAccepteddp exactly 1
generatedCommandResponseop min 1
responseToRequestop exactly 1
In domain of responseToRequestop
generatedCommandResponseop
actuationObservedByop
requestAccepteddp
In range of hasRequestResponseop

Key-Value definitionc

IRI https://w3id.org/rec/actuation/KeyValueDefinition
Description Defines allowable or required structures for key-value lists. Used in interface definitions.
Super-classes https://w3id.org/rec/core/Informationc
Restrictions valueDatatypefp exactly 1
keyStringfp exactly 1
keyMandatoryfp exactly 1
valueRestrictionop max 1
In domain of keyMandatoryfp
keyStringfp
valueRestrictionop
valueDatatypefp
In range of payloadKeyValueDefinitionop

Response codec

IRI https://w3id.org/rec/actuation/ResponseCode
Description The response code, as reported by an actuator or subsystem, to an actuation command. Typically packaged within an ActuationResponse message.
Super-classes https://w3id.org/rec/core/Informationc
In domain of responseCodeIntegerdp
responseCodeStringdp
In range of responseCodeop

Value restrictionc

IRI https://w3id.org/rec/actuation/ValueRestriction
Description Defines constraints on values in key-value lists, e.g., for defining interfaces.
Super-classes https://w3id.org/rec/core/Informationc
In domain of valueRestrictionValuesdp
valueRestrictionTypefp
valueRestrictionResolutionfp
In range of valueRestrictionop

Object Properties

actuation observed byop

IRI https://w3id.org/rec/actuation/actuationObservedBy
Description (Optional) reference to any sensors that are configured/designed to observe the actuators that were acted upon by the execution of the actuation request.
Domain(s) ActuationRequestResponsec
Range(s) https://w3id.org/rec/device/Sensorc

generated commandop

IRI https://w3id.org/rec/actuation/generatedCommand
Domain(s) ActuationRequestc
Range(s) ActuationCommandc

generated command responseop

IRI https://w3id.org/rec/actuation/generatedCommandResponse
Description Reference to the response(s) to the subsystem commands that were generated by the platform to execute this actuation.
Domain(s) ActuationRequestResponsec
Range(s) ActuationCommandResponsec

has actuation interfaceop

IRI https://w3id.org/rec/actuation/hasActuationInterface
Domain(s) https://w3id.org/rec/device/Actuatorc
Range(s) ActuationInterfacec

has command responseop

IRI https://w3id.org/rec/actuation/hasCommandResponse
Domain(s) ActuationCommandc
Range(s) ActuationCommandResponsec

has default actuation interfaceop

IRI https://w3id.org/rec/actuation/hasDefaultActuationInterface
Super-properties hasActuationInterfaceop
Domain(s) https://w3id.org/rec/device/Actuatorc
Range(s) ActuationInterfacec

has request responseop

IRI https://w3id.org/rec/actuation/hasRequestResponse
Domain(s) ActuationRequestc
Range(s) ActuationRequestResponsec

is actuation interface ofop

IRI https://w3id.org/rec/actuation/isActuationInterfaceOf
Domain(s) ActuationInterfacec
Range(s) https://w3id.org/rec/device/Actuatorc

is default actuation interface ofop

IRI https://w3id.org/rec/actuation/isDefaultActuationInterfaceOf
Super-properties isActuationInterfaceOfop
Domain(s) ActuationInterfacec
Range(s) https://w3id.org/rec/device/Actuatorc

payload Key-Value definitionop

IRI https://w3id.org/rec/actuation/payloadKeyValueDefinition
Domain(s) ActuationInterfacec
Range(s) KeyValueDefinitionc

requesting agentop

IRI https://w3id.org/rec/actuation/requestingAgent
Description The agent that initiated actuation, i.e., that created an actuation request (and consequently, was the original source also of subsequent generated actuation commands).
Domain(s) (ActuationCommandc or ActuationRequestc)
Range(s) https://w3id.org/rec/core/Agentc

response codeop

IRI https://w3id.org/rec/actuation/responseCode
Domain(s) ActuationCommandResponsec
Range(s) ResponseCodec

response to commandop

IRI https://w3id.org/rec/actuation/responseToCommand
Domain(s) ActuationCommandResponsec
Range(s) ActuationCommandc

response to requestop

IRI https://w3id.org/rec/actuation/responseToRequest
Domain(s) ActuationRequestResponsec
Range(s) ActuationRequestc

target actuatorop

IRI https://w3id.org/rec/actuation/targetActuator
Domain(s) (ActuationCommandc or ActuationRequestc)
Range(s) https://w3id.org/rec/device/Actuatorc

target interfaceop

IRI https://w3id.org/rec/actuation/targetInterface
Domain(s) ActuationRequestc
Range(s) ActuationInterfacec

value restrictionop

IRI https://w3id.org/rec/actuation/valueRestriction
Domain(s) KeyValueDefinitionc
Range(s) ValueRestrictionc

was generated from requestop

IRI https://w3id.org/rec/actuation/wasGeneratedFromRequest
Domain(s) ActuationCommandc
Range(s) ActuationRequestc

Functional Properties

keyMandatoryfp

IRI https://w3id.org/rec/actuation/keyMandatory
Domain(s) KeyValueDefinitionc
Range(s) xsd:booleanc

keyStringfp

IRI https://w3id.org/rec/actuation/keyString
Domain(s) KeyValueDefinitionc
Range(s) xsd:stringc

valueDatatypefp

IRI https://w3id.org/rec/actuation/valueDatatype
Domain(s) KeyValueDefinitionc

valueRestrictionResolutionfp

IRI https://w3id.org/rec/actuation/valueRestrictionResolution
Domain(s) ValueRestrictionc
Range(s) xsd:floatc

valueRestrictionTypefp

IRI https://w3id.org/rec/actuation/valueRestrictionType
Domain(s) ValueRestrictionc

Datatype Properties

actuation payloaddp

IRI https://w3id.org/rec/actuation/actuationPayload
Description The payload to be passed on to some actuation interface and finally actuator.
Domain(s) (ActuationCommandc or ActuationRequestc)
Range(s) xsd:stringc

requestAccepteddp

IRI https://w3id.org/rec/actuation/requestAccepted
Domain(s) ActuationRequestResponsec
Range(s) xsd:booleanc

response code as integerdp

IRI https://w3id.org/rec/actuation/responseCodeInteger
Domain(s) ResponseCodec
Range(s) xsd:intc

response code as stringdp

IRI https://w3id.org/rec/actuation/responseCodeString
Domain(s) ResponseCodec
Range(s) xsd:stringc

valueRestrictionValuesdp

IRI https://w3id.org/rec/actuation/valueRestrictionValues
Domain(s) ValueRestrictionc

Namespaces

default (:)
https://w3id.org/rec/actuation/3.1.1/
:
https://w3id.org/rec/actuation/
cc
http://creativecommons.org/ns#
cpannotationschema
http://www.ontologydesignpatterns.org/schemas/cpannotationschema.owl#
dc
http://purl.org/dc/elements/1.1/
o2o
https://karlhammar.com/owl2oas/o2o.owl#
owl
http://www.w3.org/2002/07/owl#
rdf
http://www.w3.org/1999/02/22-rdf-syntax-ns#
rdfs
http://www.w3.org/2000/01/rdf-schema#
skos
http://www.w3.org/2004/02/skos/core#
terms
http://purl.org/dc/terms/
vann
http://purl.org/vocab/vann/
xml
http://www.w3.org/XML/1998/namespace
xsd
http://www.w3.org/2001/XMLSchema#

Legend

cClasses
opObject Properties
fpFunctional Properties
dpData Properties
dpAnnotation Properties
pProperties
niNamed Individuals