IoT

namespace Devices

Overview

Classes: Acceleration, Accelerometer, AccelerometerEventDispatcher, AccelerometerRemoteObject, AccelerometerServerHelper, AccelerometerSkeleton, BarcodeReadEvent, BarcodeReader, BarcodeReaderEventDispatcher, BarcodeReaderRemoteObject, BarcodeReaderServerHelper, BarcodeReaderSkeleton, BooleanDatapoint, BooleanDatapointEventDispatcher, BooleanDatapointRemoteObject, BooleanDatapointServerHelper, BooleanDatapointSkeleton, BooleanSensor, BooleanSensorEventDispatcher, BooleanSensorRemoteObject, BooleanSensorServerHelper, BooleanSensorSkeleton, Camera, CameraEventDispatcher, CameraRemoteObject, CameraServerHelper, CameraSkeleton, Composite, CompositeEventDispatcher, CompositeImpl, CompositeRemoteObject, CompositeServerHelper, CompositeSkeleton, Counter, CounterDatapoint, CounterDatapointEventDispatcher, CounterDatapointRemoteObject, CounterDatapointServerHelper, CounterDatapointSkeleton, CounterEventDispatcher, CounterRemoteObject, CounterServerHelper, CounterSkeleton, Datapoint, DatapointEventDispatcher, DatapointRemoteObject, DatapointServerHelper, DatapointSkeleton, Device, DeviceEventDispatcher, DeviceException, DeviceImpl, DeviceNode, DeviceRemoteObject, DeviceServerHelper, DeviceSkeleton, DeviceStatusChange, DeviceTree, DeviceTreeImpl, DeviceTreeRemoteObject, DeviceTreeServerHelper, DeviceTreeSkeleton, EnumDatapoint, EnumDatapointEventDispatcher, EnumDatapointRemoteObject, EnumDatapointServerHelper, EnumDatapointSkeleton, EnumValue, EventModerationPolicy, FlagValue, FlagsDatapoint, FlagsDatapointEventDispatcher, FlagsDatapointRemoteObject, FlagsDatapointServerHelper, FlagsDatapointSkeleton, GNSSSensor, GNSSSensorEventDispatcher, GNSSSensorRemoteObject, GNSSSensorServerHelper, GNSSSensorSkeleton, Gyroscope, GyroscopeEventDispatcher, GyroscopeRemoteObject, GyroscopeServerHelper, GyroscopeSkeleton, IAccelerometer, IBarcodeReader, IBooleanDatapoint, IBooleanSensor, ICamera, IComposite, ICounter, ICounterDatapoint, IDatapoint, IDevice, IDeviceTree, IEnumDatapoint, IFlagsDatapoint, IGNSSSensor, IGyroscope, IIO, ILED, IMagnetometer, IO, IOEventDispatcher, IORemoteObject, IOServerHelper, IOSkeleton, IRotaryEncoder, IScalarDatapoint, ISensor, ISerialDevice, IStringDatapoint, ISwitch, ITrigger, IVectorDatapoint, Image, LED, LEDEventDispatcher, LEDRemoteObject, LEDServerHelper, LEDSkeleton, LatLon, MagneticFieldStrength, Magnetometer, MagnetometerEventDispatcher, MagnetometerRemoteObject, MagnetometerServerHelper, MagnetometerSkeleton, MaximumRateModerationPolicy, MinimumDeltaModerationPolicy, NoModerationPolicy, NotReadableException, NotSupportedException, NotWritableException, PositionUpdate, RotaryEncoder, RotaryEncoderEventDispatcher, RotaryEncoderRemoteObject, RotaryEncoderServerHelper, RotaryEncoderSkeleton, Rotation, ScalarDatapoint, ScalarDatapointEventDispatcher, ScalarDatapointRemoteObject, ScalarDatapointServerHelper, ScalarDatapointSkeleton, Sensor, SensorEventDispatcher, SensorRemoteObject, SensorServerHelper, SensorSkeleton, SerialDevice, SerialDeviceEventDispatcher, SerialDeviceRemoteObject, SerialDeviceServerHelper, SerialDeviceSkeleton, StringDatapoint, StringDatapointEventDispatcher, StringDatapointRemoteObject, StringDatapointServerHelper, StringDatapointSkeleton, Switch, SwitchEventDispatcher, SwitchRemoteObject, SwitchServerHelper, SwitchSkeleton, Trigger, TriggerEventDispatcher, TriggerRemoteObject, TriggerServerHelper, TriggerSkeleton, VectorDatapoint, VectorDatapointEventDispatcher, VectorDatapointRemoteObject, VectorDatapointServerHelper, VectorDatapointSkeleton

Types Aliases: ImageData

Classes

struct Acceleration

Acceleration values from a three-axis accelerometer. 

class Accelerometer

The interface for three-axis Accelerometers. 

class AccelerometerEventDispatcher

The interface for three-axis Accelerometers. 

class AccelerometerRemoteObject

The interface for three-axis Accelerometers. 

class AccelerometerServerHelper

The interface for three-axis Accelerometers. 

class AccelerometerSkeleton

The interface for three-axis Accelerometers. 

struct BarcodeReadEvent

 

class BarcodeReader

The base class for barcode reader devices. 

class BarcodeReaderEventDispatcher

The base class for barcode reader devices. 

class BarcodeReaderRemoteObject

The base class for barcode reader devices. 

class BarcodeReaderServerHelper

The base class for barcode reader devices. 

class BarcodeReaderSkeleton

The base class for barcode reader devices. 

class BooleanDatapoint

The base class for datapoints holding a boolean value. 

class BooleanDatapointEventDispatcher

The base class for datapoints holding a boolean value. 

class BooleanDatapointRemoteObject

The base class for datapoints holding a boolean value. 

class BooleanDatapointServerHelper

The base class for datapoints holding a boolean value. 

class BooleanDatapointSkeleton

The base class for datapoints holding a boolean value. 

class BooleanSensor

The base class for two-state sensors measuring on/off or open/closed state. 

class BooleanSensorEventDispatcher

The base class for two-state sensors measuring on/off or open/closed state. 

class BooleanSensorRemoteObject

The base class for two-state sensors measuring on/off or open/closed state. 

class BooleanSensorServerHelper

The base class for two-state sensors measuring on/off or open/closed state. 

class BooleanSensorSkeleton

The base class for two-state sensors measuring on/off or open/closed state. 

class Camera

The base class for image sensors, also known as cameras. 

class CameraEventDispatcher

The base class for image sensors, also known as cameras. 

class CameraRemoteObject

The base class for image sensors, also known as cameras. 

class CameraServerHelper

The base class for image sensors, also known as cameras. 

class CameraSkeleton

The base class for image sensors, also known as cameras. 

class Composite

A composite device consists of one or more sub devices or device fragments. 

class CompositeEventDispatcher

A composite device consists of one or more sub devices or device fragments. 

class CompositeImpl

Default implementation of a Composite device. 

class CompositeRemoteObject

A composite device consists of one or more sub devices or device fragments. 

class CompositeServerHelper

A composite device consists of one or more sub devices or device fragments. 

class CompositeSkeleton

A composite device consists of one or more sub devices or device fragments. 

class Counter

A counter counts events. 

class CounterDatapoint

The base class for datapoints holding a counter (a 64-bit unsigned integer). 

class CounterDatapointEventDispatcher

The base class for datapoints holding a counter (a 64-bit unsigned integer). 

class CounterDatapointRemoteObject

The base class for datapoints holding a counter (a 64-bit unsigned integer). 

class CounterDatapointServerHelper

The base class for datapoints holding a counter (a 64-bit unsigned integer). 

class CounterDatapointSkeleton

The base class for datapoints holding a counter (a 64-bit unsigned integer). 

class CounterEventDispatcher

A counter counts events. 

class CounterRemoteObject

A counter counts events. 

class CounterServerHelper

A counter counts events. 

class CounterSkeleton

A counter counts events. 

class Datapoint

The base class for datapoints. 

class DatapointEventDispatcher

The base class for datapoints. 

class DatapointRemoteObject

The base class for datapoints. 

class DatapointServerHelper

The base class for datapoints. 

class DatapointSkeleton

The base class for datapoints. 

class Device

The base class for all devices and sensors. 

class DeviceEventDispatcher

The base class for all devices and sensors. 

class DeviceException

 

class DeviceImpl

A helper class for implementing device features and properties. 

struct DeviceNode

 

class DeviceRemoteObject

The base class for all devices and sensors. 

class DeviceServerHelper

The base class for all devices and sensors. 

class DeviceSkeleton

The base class for all devices and sensors. 

struct DeviceStatusChange

Event argument for statusChanged event. 

class DeviceTree

This class manages a hierarchical structure of devices, consisting of Composite and leaf Device objects. 

class DeviceTreeImpl

Default implementation of the DeviceTree service. 

class DeviceTreeRemoteObject

This class manages a hierarchical structure of devices, consisting of Composite and leaf Device objects. 

class DeviceTreeServerHelper

This class manages a hierarchical structure of devices, consisting of Composite and leaf Device objects. 

class DeviceTreeSkeleton

This class manages a hierarchical structure of devices, consisting of Composite and leaf Device objects. 

class EnumDatapoint

The base class for datapoints holding an enumeration value (based on an int). 

class EnumDatapointEventDispatcher

The base class for datapoints holding an enumeration value (based on an int). 

class EnumDatapointRemoteObject

The base class for datapoints holding an enumeration value (based on an int). 

class EnumDatapointServerHelper

The base class for datapoints holding an enumeration value (based on an int). 

class EnumDatapointSkeleton

The base class for datapoints holding an enumeration value (based on an int). 

struct EnumValue

 

class EventModerationPolicy

An EventModerationPolicy controls the frequency of events sent when an evented sensor or state variable changes. 

struct FlagValue

 

class FlagsDatapoint

The base class for datapoints holding a variable number of flag bits, internally stored as a std::vector<bool>. 

class FlagsDatapointEventDispatcher

The base class for datapoints holding a variable number of flag bits, internally stored as a std::vector<bool>. 

class FlagsDatapointRemoteObject

The base class for datapoints holding a variable number of flag bits, internally stored as a std::vector<bool>. 

class FlagsDatapointServerHelper

The base class for datapoints holding a variable number of flag bits, internally stored as a std::vector<bool>. 

class FlagsDatapointSkeleton

The base class for datapoints holding a variable number of flag bits, internally stored as a std::vector<bool>. 

class GNSSSensor

The interface for GNSS/GPS receivers. 

class GNSSSensorEventDispatcher

The interface for GNSS/GPS receivers. 

class GNSSSensorRemoteObject

The interface for GNSS/GPS receivers. 

class GNSSSensorServerHelper

The interface for GNSS/GPS receivers. 

class GNSSSensorSkeleton

The interface for GNSS/GPS receivers. 

class Gyroscope

The interface for three-axis Gyroscopes. 

class GyroscopeEventDispatcher

The interface for three-axis Gyroscopes. 

class GyroscopeRemoteObject

The interface for three-axis Gyroscopes. 

class GyroscopeServerHelper

The interface for three-axis Gyroscopes. 

class GyroscopeSkeleton

The interface for three-axis Gyroscopes. 

class IAccelerometer

The interface for three-axis Accelerometers. 

class IBarcodeReader

The base class for barcode reader devices. 

class IBooleanDatapoint

The base class for datapoints holding a boolean value. 

class IBooleanSensor

The base class for two-state sensors measuring on/off or open/closed state. 

class ICamera

The base class for image sensors, also known as cameras. 

class IComposite

A composite device consists of one or more sub devices or device fragments. 

class ICounter

A counter counts events. 

class ICounterDatapoint

The base class for datapoints holding a counter (a 64-bit unsigned integer). 

class IDatapoint

The base class for datapoints. 

class IDevice

The base class for all devices and sensors. 

class IDeviceTree

This class manages a hierarchical structure of devices, consisting of Composite and leaf Device objects. 

class IEnumDatapoint

The base class for datapoints holding an enumeration value (based on an int). 

class IFlagsDatapoint

The base class for datapoints holding a variable number of flag bits, internally stored as a std::vector<bool>. 

class IGNSSSensor

The interface for GNSS/GPS receivers. 

class IGyroscope

The interface for three-axis Gyroscopes. 

class IIO

The interface for general purpose input/output (GPIO) ports. 

class ILED

The base class for LEDs. 

class IMagnetometer

The interface for three-axis Magnetometers. 

class IO

The interface for general purpose input/output (GPIO) ports. 

class IOEventDispatcher

The interface for general purpose input/output (GPIO) ports. 

class IORemoteObject

The interface for general purpose input/output (GPIO) ports. 

class IOServerHelper

The interface for general purpose input/output (GPIO) ports. 

class IOSkeleton

The interface for general purpose input/output (GPIO) ports. 

class IRotaryEncoder

A rotary encoder with an optional push button, based on the Counter interface. 

class IScalarDatapoint

A scalar datapoint holding a single numeric (double) value. 

class ISensor

The base class for analog sensors, such as temperature or ambient light sensors. 

class ISerialDevice

This class provides a simple interface for accessing a serial port. 

class IStringDatapoint

The base class for datapoints holding a string value. 

class ISwitch

The base class for switchable things (that can be turned on and off). 

class ITrigger

The base class for triggers, such as push buttons or motion detectors. 

class IVectorDatapoint

The base class for datapoints holding a vector value. 

struct Image

 

class LED

The base class for LEDs. 

class LEDEventDispatcher

The base class for LEDs. 

class LEDRemoteObject

The base class for LEDs. 

class LEDServerHelper

The base class for LEDs. 

class LEDSkeleton

The base class for LEDs. 

struct LatLon

LatLon represents a point on the two-dimensional surface of a globe. 

struct MagneticFieldStrength

Magnetic field strength values from a three-axis Magnetometer

class Magnetometer

The interface for three-axis Magnetometers. 

class MagnetometerEventDispatcher

The interface for three-axis Magnetometers. 

class MagnetometerRemoteObject

The interface for three-axis Magnetometers. 

class MagnetometerServerHelper

The interface for three-axis Magnetometers. 

class MagnetometerSkeleton

The interface for three-axis Magnetometers. 

class MaximumRateModerationPolicy

This event moderation policy will fire an event at most every n milliseconds. 

class MinimumDeltaModerationPolicy

This event moderation policy will fire an event whenever the value of an event variable changes more than the given minimum delta since the last time an event was sent. 

class NoModerationPolicy

This event moderation policy does no moderation and fires an event whenever the event variable's value changes (the valueChanged() member function is called). 

class NotReadableException

 

class NotSupportedException

 

class NotWritableException

 

struct PositionUpdate

The information contained in a NMEA 0183 RMC message. 

class RotaryEncoder

A rotary encoder with an optional push button, based on the Counter interface. 

class RotaryEncoderEventDispatcher

A rotary encoder with an optional push button, based on the Counter interface. 

class RotaryEncoderRemoteObject

A rotary encoder with an optional push button, based on the Counter interface. 

class RotaryEncoderServerHelper

A rotary encoder with an optional push button, based on the Counter interface. 

class RotaryEncoderSkeleton

A rotary encoder with an optional push button, based on the Counter interface. 

struct Rotation

Rotation values from a three-axis Gyroscope

class ScalarDatapoint

A scalar datapoint holding a single numeric (double) value. 

class ScalarDatapointEventDispatcher

A scalar datapoint holding a single numeric (double) value. 

class ScalarDatapointRemoteObject

A scalar datapoint holding a single numeric (double) value. 

class ScalarDatapointServerHelper

A scalar datapoint holding a single numeric (double) value. 

class ScalarDatapointSkeleton

A scalar datapoint holding a single numeric (double) value. 

class Sensor

The base class for analog sensors, such as temperature or ambient light sensors. 

class SensorEventDispatcher

The base class for analog sensors, such as temperature or ambient light sensors. 

class SensorRemoteObject

The base class for analog sensors, such as temperature or ambient light sensors. 

class SensorServerHelper

The base class for analog sensors, such as temperature or ambient light sensors. 

class SensorSkeleton

The base class for analog sensors, such as temperature or ambient light sensors. 

class SerialDevice

This class provides a simple interface for accessing a serial port. 

class SerialDeviceEventDispatcher

This class provides a simple interface for accessing a serial port. 

class SerialDeviceRemoteObject

This class provides a simple interface for accessing a serial port. 

class SerialDeviceServerHelper

This class provides a simple interface for accessing a serial port. 

class SerialDeviceSkeleton

This class provides a simple interface for accessing a serial port. 

class StringDatapoint

The base class for datapoints holding a string value. 

class StringDatapointEventDispatcher

The base class for datapoints holding a string value. 

class StringDatapointRemoteObject

The base class for datapoints holding a string value. 

class StringDatapointServerHelper

The base class for datapoints holding a string value. 

class StringDatapointSkeleton

The base class for datapoints holding a string value. 

class Switch

The base class for switchable things (that can be turned on and off). 

class SwitchEventDispatcher

The base class for switchable things (that can be turned on and off). 

class SwitchRemoteObject

The base class for switchable things (that can be turned on and off). 

class SwitchServerHelper

The base class for switchable things (that can be turned on and off). 

class SwitchSkeleton

The base class for switchable things (that can be turned on and off). 

class Trigger

The base class for triggers, such as push buttons or motion detectors. 

class TriggerEventDispatcher

The base class for triggers, such as push buttons or motion detectors. 

class TriggerRemoteObject

The base class for triggers, such as push buttons or motion detectors. 

class TriggerServerHelper

The base class for triggers, such as push buttons or motion detectors. 

class TriggerSkeleton

The base class for triggers, such as push buttons or motion detectors. 

class VectorDatapoint

The base class for datapoints holding a vector value. 

class VectorDatapointEventDispatcher

The base class for datapoints holding a vector value. 

class VectorDatapointRemoteObject

The base class for datapoints holding a vector value. 

class VectorDatapointServerHelper

The base class for datapoints holding a vector value. 

class VectorDatapointSkeleton

The base class for datapoints holding a vector value. 

Types Aliases

ImageData

using ImageData = std::vector < char >;

Enumerations

DeviceStatus

Current operating status of a device or sensor.

DEVICE_STATUS_UNKNOWN = 0

The status is unknown.

DEVICE_STATUS_DISABLED = 1

The device has been disabled.

DEVICE_STATUS_ENABLED = 2

The device has been enabled, but is not ready yet.

DEVICE_STATUS_READY = 3

The device is functioning properly and providing data.

DEVICE_STATUS_ERROR = 4

The device is not functioning properly.

Securely control IoT edge devices from anywhere   Connect a Device