Schema Definition: com.lawo.emberplus.gpout (Version 1)

General

This schema is intended to provide a standard way for an Ember+ provider to publish data for general purpose outputs.

Changes

Version 1.0

Initial schema definition.

Identifier

The identifier of this schema is com.lawo.emberplus.gpout.v<VERSIONMAJOR>.<VERSIONMINOR>
The current major version is: 1
The current minor version is: 0

A consumer implementing this schema may expect that future versions of this schema are backwards compatible to the one it implements if the major version number is unchanged and the minor version number is greater than the one it implements. Changes to the major version number must be considered breaking changes.

Scope

This schema defines the layout of an Ember+ node, defining the parameters it must contain as direct children as well as parameters it may contain, if the underlying hardware supports them.

Rules

An Ember+ node that implements this schema MUST contain the following parameters:

1. Name: State
   Type: BOOLEAN
   Access: Read / Write
   This parameter determines the current state of the output:
   • false - Set the output to its non-signaled state.
   • true - Set the output to its signaled state.

An Ember+ node that implements this schema MAY contain a sub node named Config that MAY contain any of the following parameters:

1. Name: PulseTime
   Type: INTEGER
   Access: Read / Write
   This parameter may either be 0 indicate that current state of the output is held indefinitely until State is explicitly changed to a different value, or it may be a non-negative number that specifies the duration in milliseconds of the pulse triggered by changing State to 1. Once this duration has passed the State parameter is automatically changed back to 0 to correctly reflect the non-signaled state of the output.

2. Name: Invert
   Type: BOOLEAN
   Access: Read / Write
   A switch indicating whether or not the output signal should be inverted.

Notes

During normal operation the signaled state of the output is high, if the Invert parameter is present and set to true, the signaled state of the output is low.