roo_transceivers
API Documentation for roo_transceivers
Loading...
Searching...
No Matches
roo_transceivers Namespace Reference

Namespaces

namespace  proto
 

Data Structures

class  ActuatorBinding
 
class  ActuatorLocator
 Identifies actuator within a transceiver device. More...
 
class  ArduinoPreferencesBindingStore
 
class  BindingStore
 
class  BoundActuator
 
class  BoundSensingActuator
 Adapter for actuators that can be read, using actuator id as sensor id. More...
 
class  BoundSensor
 
struct  DescriptorEntry
 
struct  DescriptorHashFn
 
class  DeviceLocator
 Identifies a transceiver device by schema and device id. More...
 
class  EventListener
 Listener for universe-level change notifications. More...
 
class  Executor
 
class  Measurement
 Measurement of a quantity at a specific time. More...
 
class  Multiverse
 Universe that combines multiple other universes into one. More...
 
class  OneWireUniverse
 Universe adapter exposing OneWire thermometers as transceivers. More...
 
class  SensorBinding
 Persistent binding of a sensor key to a locator. More...
 
class  SensorLocator
 Identifies sensor within a transceiver device. More...
 
class  SimpleSensor
 Transceiver exposing one statically defined sensor and no actuators. More...
 
class  SimpleSensorUniverse
 Convenience Universe for identical, basic sensor-only transceivers. More...
 
class  SimpleTransceiver
 Transceiver with statically defined descriptor. More...
 
class  Transceiver
 Abstract transceiver interface used by TransceiverCollection. More...
 
class  TransceiverCollection
 
class  TransceiverType
 
class  Universe
 An abstract collection of transceiver devices. More...
 
class  UniverseClient
 Universe that mirrors a remote universe via a bidirectional channel. More...
 
class  UniverseClientChannel
 Communication channel for UniverseClient. More...
 
class  UniverseServer
 The server keeps cached universe state and the most recent delta. More...
 
class  UniverseServerChannel
 

Typedefs

using Rep = char[64]
 
using DeviceSchema = roo_collections::SmallString< 16 >
 Device schema identifier (short string).
 
using DeviceId = roo_collections::SmallString< 24 >
 Device identifier (short string).
 
using SensorId = roo_collections::SmallString< 24 >
 Sensor identifier (short string).
 
using ActuatorId = roo_collections::SmallString< 24 >
 Actuator identifier (short string).
 
using DescriptorMap = roo_collections::FlatSmallHashMap< roo_transceivers_Descriptor, DescriptorEntry, DescriptorHashFn >
 

Functions

roo_logging::Stream & operator<< (roo_logging::Stream &os, const SensorBinding &binding)
 
roo_logging::Stream & operator<< (roo_logging::Stream &os, const BoundSensor &sensor)
 
roo_logging::Stream & operator<< (roo_logging::Stream &os, const ActuatorBinding &binding)
 
roo_logging::Stream & operator<< (roo_logging::Stream &os, const BoundActuator &actuator)
 
roo_logging::Stream & operator<< (roo_logging::Stream &os, const BoundSensingActuator &actuator)
 
BindingStoreDefaultBindingStore ()
 
bool operator== (const DeviceLocator &a, const DeviceLocator &b)
 
bool operator!= (const DeviceLocator &a, const DeviceLocator &b)
 
bool operator== (const SensorLocator &a, const SensorLocator &b)
 
bool operator!= (const SensorLocator &a, const SensorLocator &b)
 
bool operator== (const ActuatorLocator &a, const ActuatorLocator &b)
 
bool operator!= (const ActuatorLocator &a, const ActuatorLocator &b)
 

Typedef Documentation

◆ ActuatorId

using roo_transceivers::ActuatorId = typedef roo_collections::SmallString<24>

Actuator identifier (short string).

Definition at line 18 of file id.h.

◆ DescriptorMap

Definition at line 27 of file server.h.

◆ DeviceId

using roo_transceivers::DeviceId = typedef roo_collections::SmallString<24>

Device identifier (short string).

Definition at line 14 of file id.h.

◆ DeviceSchema

using roo_transceivers::DeviceSchema = typedef roo_collections::SmallString<16>

Device schema identifier (short string).

Definition at line 12 of file id.h.

◆ Rep

using roo_transceivers::Rep = typedef char[64]

Definition at line 16 of file arduino_prefs_store.cpp.

◆ SensorId

using roo_transceivers::SensorId = typedef roo_collections::SmallString<24>

Sensor identifier (short string).

Definition at line 16 of file id.h.

Function Documentation

◆ DefaultBindingStore()

BindingStore & roo_transceivers::DefaultBindingStore ( )

Definition at line 5 of file defaults.cpp.

◆ operator!=() [1/3]

bool roo_transceivers::operator!= ( const ActuatorLocator a,
const ActuatorLocator b 
)
inline

Definition at line 145 of file id.h.

◆ operator!=() [2/3]

bool roo_transceivers::operator!= ( const DeviceLocator a,
const DeviceLocator b 
)
inline

Definition at line 50 of file id.h.

◆ operator!=() [3/3]

bool roo_transceivers::operator!= ( const SensorLocator a,
const SensorLocator b 
)
inline

Definition at line 97 of file id.h.

◆ operator<<() [1/5]

roo_logging::Stream & roo_transceivers::operator<< ( roo_logging::Stream &  os,
const ActuatorBinding binding 
)

Definition at line 22 of file binding.cpp.

◆ operator<<() [2/5]

roo_logging::Stream & roo_transceivers::operator<< ( roo_logging::Stream &  os,
const BoundActuator actuator 
)

Definition at line 33 of file binding.cpp.

◆ operator<<() [3/5]

roo_logging::Stream & roo_transceivers::operator<< ( roo_logging::Stream &  os,
const BoundSensingActuator actuator 
)

Definition at line 39 of file binding.cpp.

◆ operator<<() [4/5]

roo_logging::Stream & roo_transceivers::operator<< ( roo_logging::Stream &  os,
const BoundSensor sensor 
)

Definition at line 16 of file binding.cpp.

◆ operator<<() [5/5]

roo_logging::Stream & roo_transceivers::operator<< ( roo_logging::Stream &  os,
const SensorBinding binding 
)

Definition at line 5 of file binding.cpp.

◆ operator==() [1/3]

bool roo_transceivers::operator== ( const ActuatorLocator a,
const ActuatorLocator b 
)
inline

◆ operator==() [2/3]

bool roo_transceivers::operator== ( const DeviceLocator a,
const DeviceLocator b 
)
inline

◆ operator==() [3/3]

bool roo_transceivers::operator== ( const SensorLocator a,
const SensorLocator b 
)
inline