package
0.0.0-20200930173842-476b4f672e85
Repository: https://github.com/iotdomain/iotdomain-go.git
Documentation: pkg.go.dev
# Constants
DataTypeBool value is true/false, 1/0, on/off.
DataTypeBytes value is encoded byte array.
DataTypeDate ISO8601 date YYYY-MM-DDTHH:MM:SS.mmmZ.
DataTypeEnum value is one of a predefined set of string values, published in the 'enum info field'.
DataTypeInt value is an integer number.
value is a json object.
value is a float number.
a secret string that is not published.
Available data types.
3D vector (x, y, z) or (lat, lon, 0).
DefaultInputInstance is the input instance identifier when only a single instance exists.
DefaultOutputInstance is the output instance identifier when only a single instance exists.
DSSPublisherID defines the publisherID of a domain's security service the DSS is responsible for renewal of keys in a secured domain.
Basic Auth login for rest endpoints, use secret=true.
Basic Auth login for rest endpoints, use secret=true.
input (poll) interval for REST endpoint.
when enabled, the input can be set with a $set command, boolean.
source address to read input from.
select audio video input channel.
set light color in hex: #RRGGBB.
set light color temperature in kelvin.
issue input command.
control light dimmer 0-100%.
humidity setting control 0-100%.
image input.
multilevel input control.
lock "open" or "closed".
audi/video mute: "on" "off".
audio/video play pushbutton.
push button with nr of pushes.
control rotations per minute.
control speed.
set on/off switch: "on" "off".
set thermostat temperature.
Not a known property type.
generic input value if not a level.
set input control for voltage.
set input control for water level.
local area domain.
node configuration, payload is NodeConfigureMessage.
create node command.
delete node command.
node outputs event, payload is EventMessage.
output forecast, payload is HistoryMessage.
output history, payload is HistoryMessage.
publisher identity.
input discovery, payload is InOutput object.
latest output, payload is latest message.
node discovery, payload is Node object.
output discovery, payload output definition.
raw output value.
renew publisher identity keys.
command to set input value, payload is input value.
set node ID, payload is SetNodeIDMessage.
publisher runtime status, connected, disconnected, lost.
perform firmware upgrade, payload is UpgradeMessage.
device domain or ip address.
Batch publishing size.
Color in hex notation.
Device description.
device or sensor is disabled.
Enable/disable event publishing.
filename to write images or other values to.
the node gateway address.
network device hostname.
IoTDomain version.
latitude, longitude of the device for display on a map r/w.
for IP nodes.
name of a location.
login name to connect to the device.
MAC address for IP nodes.
device manufacturer.
maximum value of sensor or config.
minimum value of sensor or config.
device model.
Name of device or service.
IP network mask.
password to connect.
polling interval in seconds.
battery, usb, mains.
device product or model name.
public key for encrypting sensitive configuration settings.
int with nr of events per batch, 0 to disable.
enable publishing as event.
bool, publish output with $forecast message.
bool, publish output with $history message.
bool, publish output with $latest message.
bool, publish output with $raw message.
version of the software running the node.
IP subnets configuration.
Node type.
node URL.
NodeIDGateway is the standard nodeOD of a gateway device.
Node reports an error.
Node is is no longer reachable.
Node is ready for use.
Node has gone into sleep mode, often a battery powered devie.
nr of errors reported on this device.
health status of the device 0-100%.
most recent error message, or "" if no error.
ISO time the device was last seen.
duration connect to sensor in milliseconds.
mesh network nr of neighbors.
mesh network device neighbors ID list [id,id,...].
Node run-state as per below.
Nr of messages received from device.
Nr of messages send to device.
software adapter or service, eg virtual device.
an alarm emitter.
Audio/Video controller.
Node is a (not so) smart radio/receiver/amp (eg, denon).
device is a location beacon.
device is a physical button device with one or more buttons.
Node with camera.
General purpose computer.
light dimmer.
Node is a gateway for other nodes (onewire, zwave, etc).
Entry key pad.
Electronic door lock.
Node with multiple sensors.
Node is a zwave or other network repeater.
Node is a network router.
Node is a network switch.
Node is a wifi access point.
Node is a physical on/off switch.
device is a phone.
Node is a power meter.
Node is a single sensor (volt,...).
Node is a smart light, eg philips hue.
Node is a temperature meter.
Node is a thermostat control unit.
Node is a (not so) smart TV.
type not identified.
Node is a wallpaper montage of multiple images.
Water valve control unit.
Node is a service providing current and forecasted weather.
Node is a weatherstation device.
Node is an electronic weight scale.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
multilevel sensor.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
with nr of pushes.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
on/off switch: "on" "off".
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
Not a known property type.
generic value.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
description of weather, eg sunny.
NodeOutput and actuator types These determine the available units and the datatype.
NodeOutput and actuator types These determine the available units and the datatype.
Publisher is connected and working.
Publisher has cleanly disconnected.
Publisher failed to start.
Publisher is initializing.
Publisher unexpectedly disconnected.
Domain to use in testing.
TimeFormat for publishing messages.
Defined unit types.
Defined unit types.
Defined unit types.
Defined unit types.
Defined unit types.
Defined unit types.
Defined unit types.
Defined unit types.
Defined unit types.
Defined unit types.
Defined unit types.
Defined unit types.
Defined unit types.
Defined unit types.
Defined unit types.
Defined unit types.
Defined unit types.
Defined unit types.
Defined unit types.
Defined unit types.
Defined unit types.
Defined unit types.
Defined unit types.
Defined unit types.
Defined unit types.
Defined unit types.
Defined unit types.
Defined unit types.
Defined unit types.
Defined unit types.
Defined unit types.
Defined unit types.
# Structs
ConfigAttr describes the attributes that are configurable.
InputDiscoveryMessage with node input description.
NodeConfigureMessage with values to update a node configuration.
NodeDiscoveryMessage definition published in node discovery.
OutputBatchMessage message with multiple output events.
OutputDiscoveryMessage with node output description.
OutputEventMessage message with multiple output values.
OutputForecastMessage with prediction output values.
OutputHistoryMessage with historical output value.
OutputLatestMessage struct to send/receive the '$latest' command.
OutputValue struct for history and forecast.
PublisherFullIdentity containing the public identity, DSS signature and private key Also used by the DSS to renew a publisher's identity.
PublisherIdentityMessage contains the public identity of a publisher.
PublisherStatusMessage containing 'alive' status, used in LWT.
SetInputMessage to control an input.
SetNodeIDMessage to change a node's ID.
UpgradeFirmwareMessage with node firmware.
# Type aliases
ConfigAttrMap for storing node configuration.
DataType of configuration, input and ouput values.
InputAttr input configuration attributes.
InputType defines the convention names for output types.
MessageType used in message addressing.
NodeAttr with predefined names of node attributes and configuration.
NodeAttrMap for storing node attributes.
NodeStatus various node status attributes.
NodeStatusMap for storing status attributes.
NodeType identifying the purpose of the node Based on the primary role of the device.
OutputType defines the convention names for output types.
PublisherRunState indicates the operating status of the publisher.
Unit defines constants with input and output unit names.