SAREF4ENER: an extension of SAREF for the energy domain created in collaboration with Energy@Home and EEBus associations
SAREF4ENER is an extension of SAREF for the Energy domain that was created in collaboration with Energy@Home (http://www.energy-home.it) and EEBus (http://www.eebus.org/en), the major Italy- and Germany-based industry associations, to enable the interconnection of their (different) data models. SAREF4ENER focuses on demand response scenarios, in which customers can offer flexibility to the Smart Grid to manage their smart home devices by means of a Customer Energy Manager (CEM). The CEM is a logical function for optimizing energy consumption and/or production that can reside either in the home gateway or in the cloud. SAREF4ENER is published as an ETSI tecnical specificatoion (ETSI TS 103 410-1).
Time period duration description
The duration description for the time period duration temporal entities
Anticipation duration description
The duration description for the anticipation duration temporal entities
Power expected
A possible type of power in a slot that represents the expected power consumption and its value
Energy max
A possible type of energy in a slot that represents the maximum energy consumption and its value
Activation delay duration description
The duration description for the activation delay duration temporal entity
Actuator level
Independent from the ActuatorSwitch class, the ActuatorLevel class enables a user or application to model LEVEL commands (start, up, percentageAbsolute, relative, etc.). This can be used to dim a light, set the speed of an electric motor, etc.
State
An entity that represents the possible states in SAREF4EE
Remaining pause time
The duration that the current slot (s4ee:activeSlotNumber) permits being paused. This element SHALL ONLY be present if the power sequence is interruptible. Otherwise, it SHALL be omitted. In case the power sequence is interruptible the following rules apply: If the element is absent this means there is no explicit pause duration restriction for the current slot; a value of 0s denoted the slot does not permit being paused.
Active duration max
The active maximum duration a power sequence can run without interruption.
Duration uncertainty
The uncertainty of the duration
Energy Standard Deviation
A possible type of energy in a slot that represents the energy standard deviation and its value
Resume cost estimated
In a power sequence the additional costs for the resumption of a device to its normal operation (after a pause).
Actuator switch
Basic on/off operations on a simple actuator can be modelled with the ActuatorSwitch class. Whether the function turns a device itself ON or OFF, or whether it switches a specific feature, depends on the implementation. For example, one could model the super freeze program of a freezer using ActuatorSwitch class. An ON command would then activate the super freeze program and an OFF command would deactivate it. This example shall just give an idea how ActuatorSwitch can be used for more purposes than only turning devices on and off.
Load control event state
In the load control, it expresses the possible states of an event used to send overload warning severity level and related load control commands to a device (e.g. a household appliance or a smart meter).
Max activation delay
Maximum delay time between the end of the previous slot and the beginning of the current slot.
Pause time
The pause time of a power sequence or a slot
Energy
Energy type and value in a slot (i.e., Energy, EnergyMin, EnergyMax, EnergyExpected, EnergyStandardDeviation, EnergySkewness); or the ResumeEnergyEstimated in a power sequence, i.e., the additional energy the device will consume before resuming its normal operation (after a pause)
Power
Power type and value in a slot (i.e. power, powerMin, powerMax, powerExpectedValue, powerStandardDeviation, powerSkewness)
Max anticipation
This field allows the anticipation of the phase if (and only if) the previous phase has the energy set to 0 Wh, each unit is a minute.
Pause duration description
The duration description for the pause duration (max and min) temporal entities
Energy expected
A possible type of energy in a slot that represents the expected energy consumption and its value
Alternatives group
A collection of power sequences for a certain profile
Active duration sum min
The active minimum duration a power sequence must run in total (summation of all active times).
Slot
The single steps of a power sequence are represented by slots. A slot is associated with a slot number (while a power sequence is associated with a power sequence identifier). The slot numbers of two power sequences should be considered independent from each other, i.e., slot number 7 of sequence 1 describes a different slot than slot number 7 of sequence 2. Therefore a slot is only uniquely identified in combination with a sequence ID.
Event accepted
Load control state with value 'event accepted'
Event started
Load control state with value 'event started'
Event stopped
Load control state with value 'event stopped'
Event rejected
Load control state with value 'event rejected'
Event cancelled
Load control state with value 'event cancelled'
Event error
Load control state with value 'event error'
Event state produce
In the load control, it expresses a produce state of an event an event used to send overload warning severity level and related load control commands to a device (e.g. a household appliance or a smart meter).
End time duration Description
The duration description for the end time duration temporal entities
Power profile
A way to model curves of power and energy over time, which also provides definitions for the modelling of power scheduling including alternative plans. With a PowerProfile, a device (or power sequences server) exposes the power sequences that are potentially relevant for the CEM (or power sequences client).
Latest end time
The latest possible end time for a power sequence or a slot. Only 'xs:duration' value types SHALL be used to denote a relative time which relates to 'now' as time 0. Note: This element applies to the first repetition of the slot number only.
Pause duration max
The maximum duration a power sequence can pause after the end of an activity.
Default duration
The duration of a slot (SHALL be present in case of 'determined slot'). If a slot has a configurable lenght, this element SHALL reflect the currently configured lenght
Remaining slot time
If state is set to 'running' or 'paused' AND the slot is determined, this element SHALL contain the time the slot still needs to be in 'running' state (this also means the value remains constant during a 'paused' state). Otherwise it SHALL be omitted.
Start time duration description
The duration description for the start time duration temporal entities
Start time
The startTime of a power sequence or slot. SHALL be present
Min duration
If a slot has a configurable duration, it SHALL be present and denote the minimum supported configuration. Note: This element applies to the first repetition of the slot number only.
Power skewness
A possible type of power in a slot that represents the power skewness and its value
Pause
Load control event action with value 'pause'
Resume
Load control event action with value 'resume'
Reduce
Load control event action with value 'reduce'
Increase
Load control event action with value 'increase'
Emergency
Load control event action with value 'emergency'
Normal
The value NORMAL used to instantiate the Load Control Event Action class and MeasurandState class
An action type used to express a produce action to be performed as a consequence of an event used to send overload warning severity level and related load control commands to a device (e.g. a household appliance or a smart meter).
Event action produce
Activation delay
The scheduled activation delay for a slot.
Device
A specialization of a saref:Device that exposes a power profile with power sequences to the CEM (note that a s4ee:Device can also be called 'power sequence server'). Most of the existing devices can expose at most 1 power profile, but there are special cases in which more than one power profiles can be exposed by the same device. For example, consider the case of a combined fridge-freezer in which there are 2 logical devices (fridge and freezer) combined in 1 physical device. This combined device can expose 2 power profiles, one for the fridge and one for the freezer. A s4ee:Device (e.g. a household appliance or a smart meter) can also receive events about overload warning severity level and related load control commands (LoadControlEventData)
End time
The endTime of a power sequence. If the value is available, it SHALL be denoted here. Otherwise the element SHALL be omitted. The end time of a slot MAY be stated in this element. The following equation SHALL apply: endTime - startTime = defaultDuration.
Power standard deviation
A possible type of power in a slot that represents the power standard deviation and its value
Active duration description
The duration description for the active duration (min and max, sum max and sum min) temporal entities
Active duration sum max
The active maximum duration a power sequence can run in total (summation of all active times).
Earliest start time
The earliest possible start time for a power sequence or a slot. Only 'xs:duration' value types SHALL be used to denote a relative time which relates to 'now' as time 0. Note: This element applies to the first repetition of the slot number only.
Pause duration min
The minimum duration a power sequence can pause after the end of an activity.
Running
Power sequence state with value 'running'
Paused
Power sequence state or sensor state with value 'paused'
Scheduled
Power sequence state with value 'scheduled'
Scheduled paused
Power sequence state with value 'scheduled paused'
Pending
Power sequence state with value 'pending'
Inactive
Power sequence state with value 'inactive'
Completed
Power sequence state with value 'completed'
Invalid
Power sequence state with value 'invalid'
Power sequence state
The current state of the power sequence. It can assume one of the values 'running', 'paused', 'scheduled', 'scheduled paused', 'pending', 'inactive', 'completed', or 'invalid'.
Power sequence
The specification of a task, such as wash or tumble dry, according to user preferences and/or manufacturer's settings for a certain device. It is the most 'coarse' view, a power sequence can represent all single steps of a whole task,where the single steps are represented by slots. If the power sequence is pausable by the bound power sequences client, the property 'saref:isInterruptionPossible' SHALL be present and set to true. Otherwise it SHALL be omitted. If the power sequence is stoppable by the bound power sequences client, the property 'saref:isFlexible' SHALL be present and set to true. Otherwise it SHALL be omitted.
Power min
A possible type of power in a slot that represents the minimum power consumption and its value
An event used to send overload warning severity level and related load control commands to a device (e.g. a household appliance or a smart meter).
Load control event data
Max duration
If a slot has a configurable duration, it SHALL be present and denote the maximum supported configuration. Note: This element applies to the first repetition of the slot number only
Elapsed slot time
If state is set to 'running' or 'paused' AND the slot is determined, this element CAN contain the time the slot has already been in 'running' state (this also means the value remains constant during a 'paused' state). Otherwise it SHALL be omitted.
Active duration min
The active mininum duration a power sequence can run without interruption.
Time period
The time period associated with load control event data
Load control state data
The representation of the state of an event used to send overload warning severity level and related load control commands to a device (e.g. a household appliance or a smart meter).
An action type used to express a consume action to be performed as a consequence of an event used to send overload warning severity level and related load control commands to a device (e.g. a household appliance or a smart meter).
Event action consume
Resume energy estimated
In a power sequence, the additional energy the device will consume before resuming its normal operation (after a pause). This is only an estimated value which will not be added to the value stated in any slot value information.
Energy skewness
A possible type of energy in a slot that represents the energy skewness and its value
Energy min
A possible type of energy in a slot that represents the minimum energy consumption and its value
Default duration description
The duration description for the default duration temporal entity
Event state consume
In the load control, it expresses a consume state of an event used to send overload warning severity level and related load control commands to a device (e.g. a household appliance or a smart meter).
Power max
A possible type of power in a slot that represents the maximum power consumption and its value
Duration uncertainty description
The duration description for the duration uncertainty temporal entity
Slot time duration description
The duration description for the slot time duration temporal entities
Load Control event action
An action type used to express the action to be performed as a consequence of an event used to send overload warning severity level and related load control commands to a device (e.g. a household appliance or a smart meter).
has connection
In the Remote Network Management (RemoteNWM) use case, a relationship between a node in a network (i.e., a s4ee:Device) and its connections (i.e., a s4ee:DeviceConnections). The same s4ee:Device (or node) can have multiple device connections as it can be connected to several networks at the same time.
has energy
A relationship between a power sequence and its energy (in terms of value and unit of measure)
belongs to
A relationship identifying the ownership of an entity. In particular, a slot belongs to a power sequence, a power sequence belongs to an alternative, an alternative belongs to a power profile, a power profile belongs to a device.
has applied event action produce
A relationship between the state of a load control event produce and the action to be performed as a consequence of this event.
has function
A relationship identifying the functions performed by an actuator level and an actuator switch
has energy value type
A relationship representing an energy value type
triggers event action consume
A relationship between a load control event and the consume action triggered by this event
triggers event action produce
A relationship between a load control event and the produce action triggered by this event
receives
A relationship between a device (e.g., an appliance or a smart meter) and a load control event
has device
A relationship between a load control event (used to send overload warning severity level and related load control commands) and the device interested by this event.
has power value type
A relationship representing a power value type
has applied event action consume
A relationship between the state of a load control event consume and the action to be performed as a consequence of this event.
has value type
A relation representing the value type of an entity
has event state produce
A relationship between the specification of the state of a load control event produce and the value that this state can assume.
exposes
A relationship between a device and its power profile
has expression
A relationship between an appliance parameter compatibility action and the associated expressions
has event state consume
A relationship between the specification of the state of a load control event consume and the value that this state can assume.
alternatives group ID
The endpoint-wide unique identifier for the alternatives group instances provided by a power profile
max cycles per day
States the maximum amount of starts a power sequence (of a device) allows per day.
task identifier
Represents the task identifier of the power sequence.
total sequences count max
Represents the total number of power sequences supported by the power profile of a device
sequence ID
Provides a unique power sequence identifier for a certain device
manufacturer node identification
Indicates a node identification for the device as defined by the manufacturer. This could be used for the identification of a device, even if it was removed from the network and rejoined later with changed node address.
serial number
Indicates the serial number of a device as defined by the manufacturer. Usually the same as printed on the case.
duration in xsd
This property is added to the time:DurationDescription class to allow to express time duration also as xsd:duration. This is necessary because in the EEBus/E@h model time is always expressed as xsd:duration. We use this property to express the following time information in the EEBus/E@h model: - the startTime of the power sequence (in the PowerSequence class). SHALL be present - the endTime of the power sequence (in the PowerSequence class). If the value is available, it SHALL be denoted here. Otherwise the element SHALL be omitted. - the startTime of measurement as absolute or relative value (in the Measurement class). - the endTime of measurement as absolute or relative value (in the Measurement class). The duration is expected to be described as in xsd:duration
value source
Indicates the source (origin/foundation) of the measurement forecasted values for a power sequence. If absent, the source is undefined. Remark: This element shall express the reliability of the forecast.
value tendency
Indicates whether the tendency of a measurement is rising, stable or falling.
measurement id
Enables the identification of different sensors on one EEBus address.
is pausable
Specifies if the power sequence is pausable.
slot number
Provides a unique slot identifier for a certain power sequence
active slot number
Indicates the currently active slot number, if the power sequence state is set to 'running' or 'paused'. Otherwise it SHALL be omitted.
activate slot
Indicates whether a slot is used (activateSlot = true) or not (activateSlot = false). SHALL be present if a slot is optional (i.e., the property s4ee:optionalSlot is TRUE), otherwise SHALL be absent (i.e. in case the slot is mandatory).
brand name
Provides the name of the brand of a device. Useful where the name of the brand and the vendor differs.
supports single slot scheduling only
If set toTRUE, the power profile of a device does NOT permit the modification of more than one slot per configuration command.
active repetition number
Indicates the current repetition of the sequence of slots. SHALL be present if a power sequence can repeat its sequence of slots (i.e., if s4ee:repetitionTotal is present and has a value > 1). Otherwise, it SHALL be absent.
alternatives count
Indicates the number of alternatives groups provided by a power profile
optional slot
Indicates whether a slot is optional (if set to TRUE). Otherwise, if a slot is mandatory, SHALL be omitted or set to FALSE. Note: This element applies to every repetition of the slot number.
power source
Indicates the power source of a device. Possible values are e.g. mainsSinglePhase or battery
slot activated
If a slot is optional, represents the current status of the slot (true = the slot will be executed, false = the slot will not be executed). If the slot is not optional, this element SHALL be absent.
event ID
Used in the Demand Response use case to identify an event
device code
Provides a device code for the device as defined by the manufacturer.
repetition total
Contains the total number of repetitions, if a power sequence repeats its sequence of slots. Absence of the element is equal to a presence with a value of 0 (zero). SHALL be absent if the value is 1.
supports reselection
If set toTRUE, the power profile of a device does not restrict the number of power sequence re-selections by the CEM, i.e. within a given alternative the CEM may first choose one power sequence, alter the selection by configuring another sequence later on, then alter the selection again, etc. (provided the process rules and data still permit configuration). If supportsReselection is set to FALSE, the device permits the CEM to select a power sequence of an alternative only once.
manufacturer description
A description for the device as defined by the manufacturer.
software revision
Indicates the software revision of a device as defined by the manufacturer.
vendor code
Provides a code for the vendor of the device as defined by the manufacturer.
manufacturer label
A short label of the device as defined by the manufacturer.
is stoppable
Specifies if the power sequence is stoppable.
messaging type
Indicates the type of the message. Possible values are: - logging (used for messages, that shall be stored in a log file) - information (messages, that shall be presented to the customer on a display; lower priority) - warning (messages, that shall be presented to the customer on a display; medium priority) - alarm (messages, that shall be presented to the customer on a display; high priority; if there is an alarm device in the household, it shall generate an alarm) - emergency (messages, that shall be presented to the customer on a display; very high priority; if there is an alarm device in the household, it shall generate an alarm; additionally, if possible and configured, an emergency call shall be done) - obsolete (previously sent messages, that shall be marked as obsolete)
hardware revision
Indicates the hardware revision of the device as defined by the manufacturer.
node remote controllable
Indicates whether the power profile of a device is configured for remote control (e.g., by an energy management system).This refers to the selection chosen by the user on the remote control feature of the device. If nodeRemoteControllable is equal to FALSE, all the supported power sequences shall set the sequenceRemoteControllable property to FALSE. If nodeRemoteControllable is equal to TRUE, at least one power sequence shall be remotely controllable by setting the sequenceRemoteControllable property to TRUE.
device name
Provides the name of the device as defined by the manufacturer.
vendor name
Provides the name of the vendor of the device as defined by the manufacturer.
cheapest
Indicates whether a power sequence applies a configuration that minimises the user’s energy bill (if set to TRUE). MAY be present. Absence of this element is equal to the presence with value FALSE.
greenest
Indicates whether a power sequence optimises the configuration towards the maximum availability of renewable energy (if set to TRUE). MAY be present. Absence of this element is equal to the presence with value FALSE.
messaging number
An identifier for one specific message. If a message is marked as obsolete, this number can be used to identify the original message.
sequence remote controllable
Denotes whether a power sequence is modifiable (if value is TRUE) or not (if value is FALSE). Modifiability is required to configure power sequences and slots. It is also required to change a power sequence state.