made by pyLODE 2.12.0

RealEstateCore Actuation Module

Metadata

URI
https://w3id.org/rec/actuation/
Publisher(s)
RealEstateCore Consortium
Creator(s)
Karl Hammar
Per Karlberg
Modified
2020-06-23
Version Information
3.3
Version URI
actuation:
Imports
https://w3id.org/rec/device/3.3/
Ontology RDF
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 # Classes

URI 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 requestingAgentop exactly 1 https://w3id.org/rec/core/Agentc
actuationPayloaddp exactly 1
actuationPayloaddp only xsd:stringc
hasCommandResponseop max 1
targetActuatorop only https://w3id.org/rec/core/Actuatorc
wasGeneratedFromRequestop exactly 1
requestingAgentop only https://w3id.org/rec/core/Agentc
In domain of hasCommandResponseop
wasGeneratedFromRequestop
In range of responseToCommandop
generatedCommandop

Actuation command responsec # Classes

URI 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 responseToCommandop exactly 1
responseCodeop exactly 1
In domain of responseCodeop
responseToCommandop
In range of hasCommandResponseop
generatedCommandResponseop

Actuation eventc # Classes

URI 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
ActuationCommandc
ActuationCommandResponsec
ActuationRequestResponsec

Actuation interfacec # Classes

URI 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
https://w3id.org/rec/core/dataSchema exactly 1 https://w3id.org/rec/core/DataSchemac
In domain of isActuationInterfaceOfop
payloadKeyValueDefinitionop
isDefaultActuationInterfaceOfop
In range of targetInterfaceop
hasDefaultActuationInterfaceop
hasActuationInterfaceop

Actuation requestc # Classes

URI 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
targetActuatorop only https://w3id.org/rec/core/Actuatorc
targetActuatorop min 1 https://w3id.org/rec/core/Actuatorc
requestingAgentop only https://w3id.org/rec/core/Agentc
requestingAgentop exactly 1 https://w3id.org/rec/core/Agentc
actuationPayloaddp exactly 1
actuationPayloaddp only xsd:stringc
In domain of hasRequestResponseop
targetInterfaceop
generatedCommandop
In range of wasGeneratedFromRequestop
responseToRequestop

Actuation request responsec # Classes

URI 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 generatedCommandResponseop min 1
requestAccepteddp exactly 1
responseToRequestop exactly 1
In domain of actuationObservedByop
generatedCommandResponseop
requestAccepteddp
responseToRequestop
In range of hasRequestResponseop

Key-Value definitionc # Classes

URI https://w3id.org/rec/actuation/KeyValueDefinition
Description

Defines allowable or required structures for key-value lists. Used in interface definitions.

Deprecated in favour of core:ObjectSchema

Super-classes https://w3id.org/rec/core/DataSchemac
Restrictions valueRestrictionop max 1
valueDatatypefp exactly 1
keyMandatoryfp exactly 1
keyStringfp exactly 1
In domain of valueRestrictionop
valueDatatypefp
keyStringfp
keyMandatoryfp
In range of payloadKeyValueDefinitionop

Response codec # Classes

URI 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 # Classes

URI https://w3id.org/rec/actuation/ValueRestriction
Description

Defines constraints on values in key-value lists, e.g., for defining interfaces.

Deprecated in favour of the definitions provided in the new dataschemas module.

Super-classes https://w3id.org/rec/core/Informationc
In domain of valueRestrictionValuesdp
valueRestrictionTypefp
valueRestrictionResolutionfp
In range of valueRestrictionop

Object Properties

actuation observed byop # OPs

URI 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/core/Sensorc

generated commandop # OPs

URI https://w3id.org/rec/actuation/generatedCommand
Inverse properties wasGeneratedFromRequestop
Domain(s) ActuationRequestc
Range(s) ActuationCommandc

generated command responseop # OPs

URI 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 # OPs

URI https://w3id.org/rec/actuation/hasActuationInterface
Inverse properties isActuationInterfaceOfop
Domain(s) https://w3id.org/rec/core/Actuatorc
Range(s) ActuationInterfacec

has command responseop # OPs

URI https://w3id.org/rec/actuation/hasCommandResponse
Inverse properties responseToCommandop
Domain(s) ActuationCommandc
Range(s) ActuationCommandResponsec

has default actuation interfaceop # OPs

URI https://w3id.org/rec/actuation/hasDefaultActuationInterface
Super-properties hasActuationInterfaceop
Inverse properties isDefaultActuationInterfaceOfop
Domain(s) https://w3id.org/rec/core/Actuatorc
Range(s) ActuationInterfacec

has request responseop # OPs

URI https://w3id.org/rec/actuation/hasRequestResponse
Inverse properties responseToRequestop
Domain(s) ActuationRequestc
Range(s) ActuationRequestResponsec

is actuation interface ofop # OPs

URI https://w3id.org/rec/actuation/isActuationInterfaceOf
Domain(s) ActuationInterfacec

is default actuation interface ofop # OPs

URI https://w3id.org/rec/actuation/isDefaultActuationInterfaceOf
Super-properties isActuationInterfaceOfop
Domain(s) ActuationInterfacec

payload Key-Value definitionop # OPs

URI https://w3id.org/rec/actuation/payloadKeyValueDefinition
Description

Deprecated in favour of core:dataSchema.

Domain(s) ActuationInterfacec
Range(s) KeyValueDefinitionc

requesting agentop # OPs

URI 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).

Range(s) https://w3id.org/rec/core/Agentc

response codeop # OPs

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

response to commandop # OPs

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

response to requestop # OPs

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

target actuatorop # OPs

URI https://w3id.org/rec/actuation/targetActuator
Range(s) https://w3id.org/rec/core/Actuatorc

target interfaceop # OPs

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

value restrictionop # OPs

URI https://w3id.org/rec/actuation/valueRestriction
Description

Deprecated in favour of the definitions provided in the new dataschemas module.

Domain(s) KeyValueDefinitionc
Range(s) ValueRestrictionc

was generated from requestop # OPs

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

Functional Properties

keyMandatoryfp # FPs

URI https://w3id.org/rec/actuation/keyMandatory
Description

Deprecated in favour of the definitions provided in the new dataschemas module.

Domain(s) KeyValueDefinitionc
Range(s) xsd:booleanc

keyStringfp # FPs

URI https://w3id.org/rec/actuation/keyString
Description

Deprecated in favour of the definitions provided in the new dataschemas module.

Domain(s) KeyValueDefinitionc
Range(s) xsd:stringc

valueDatatypefp # FPs

URI https://w3id.org/rec/actuation/valueDatatype
Description

Deprecated in favour of the definitions provided in the new dataschemas module.

Domain(s) KeyValueDefinitionc

valueRestrictionResolutionfp # FPs

URI https://w3id.org/rec/actuation/valueRestrictionResolution
Description

Deprecated in favour of the definitions provided in the new dataschemas module.

Domain(s) ValueRestrictionc
Range(s) xsd:floatc

valueRestrictionTypefp # FPs

URI https://w3id.org/rec/actuation/valueRestrictionType
Description

Deprecated in favour of the definitions provided in the new dataschemas module.

Domain(s) ValueRestrictionc

Datatype Properties

actuation payloaddp # DPs

URI https://w3id.org/rec/actuation/actuationPayload
Description

The payload to be passed on to some actuation interface and finally actuator.

Range(s) xsd:stringc

requestAccepteddp # DPs

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

response code as integerdp # DPs

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

response code as stringdp # DPs

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

valueRestrictionValuesdp # DPs

URI https://w3id.org/rec/actuation/valueRestrictionValues
Description

Deprecated in favour of the definitions provided in the new dataschemas module.

Domain(s) ValueRestrictionc

Namespaces

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

Legend

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