The framework core type of the object, i.e. the name of the interface that defines the object's shape.
External ID associated with this object (optional)
A topic specification used for routing IO values from external sources to Coaty-defined IO actors or from Coaty-defined IO sources to external sinks (optional).
Only used for associating routes that are not created by an IO router, but defined by an external non-Coaty component.
Marks an object that is no longer in use. The concrete definition meaning of this property is defined by the application. The property value is optional and should default to false.
Unique ID of Location object that this object has been associated with (optional).
The name/description of the object
Unique ID of the object
The concrete type name of the object.
The name should be in a canonical form following the naming convention
for Java packages to avoid name collisions. All framework core types use
the form coaty.<InterfaceName>, e.g. coaty.CoatyObject (see constants
in CoreTypes class).
Unique ID of parent/superordinate object (optional)
The update rate (in milliseconds) for publishing IoValue events:
The IO router specifies the recommended update rate in Associate event data. If undefined, there is no limit on the rate of published events.
Determines whether IO values published by IO sources or received by IO actors should be treated as raw data that is not encoded/decoded as JSON objects.
In order to associate an IO source with an IO actor their values of this property must match, i.e. both properties must be either true or false to ensure that IO values transmitted between an IO source and and an IO actor can be properly encoded and decoded on each side.
Set this property to true to indicate that the IO source or IO actor
should handle IO values in raw data format, i.e as a byte array of type
Uint8Array (or Buffer in Node.js, a subclass thereof).
If set to false (default), the IO values sent by an IO source should be encodable as JSON and decodable as JSON by an associated IO actor.
The semantic, application-specific data type of values to be consumed by the IO actor, such as Temperature, Notification, Task, etc.
In order to be associated with an IO source their value types must match.
The property value must be a non-empty string. You should choose
canonical names for value types to avoid naming collisions. For example,
by following the naming convention for Java packages, such as
com.mydomain.myapp.Temperature.
Note that this value type is different from the underlying data format used by the IO source to publish IO data values. For example, an IO source for a temperature sensor could emit values as numbers or as a Value1D object with specific properties.
Generated using TypeDoc
Defines meta information of an IO actor.