Common

This module contains the common classes for the Profiles API implementation. More...

Collaboration diagram for Common:

Data Structures
struct	HF::Profiles::IProfile
	Top level class representing a HAN-FUN profile. More...
struct	HF::Profiles::AbstractProfile< _uid >
	Class template for all profile implementations. More...
struct	HF::Profiles::Profile< _uid, Interface >
	Class template for profiles containing only one interface. More...
class	HF::Profiles::ProfileN< _uid, _Interfaces >
	Class template for profiles containing multiple interfaces. More...
struct	HF::Profiles::Profile2< _uid, Interface1, Interface2 >
	Class template for profiles containing two interfaces. More...
struct	HF::Profiles::Detector< _uid >
	Class template for Detector type profiles. More...

Enumerations
enum	HF::Profiles::UID {   HF::Profiles::SIMPLE_ONOFF_SWITCHABLE = 0x0100, HF::Profiles::SIMPLE_ONOFF_SWITCH = 0x0101, HF::Profiles::SIMPLE_LEVEL_CONTROLLABLE = 0x0102, HF::Profiles::SIMPLE_LEVEL_CONTROL = 0x0103,   HF::Profiles::SIMPLE_LEVEL_CONTROLLABLE_SWITCHABLE = 0x0104, HF::Profiles::SIMPLE_LEVEL_CONTROL_SWITCH = 0x0105, HF::Profiles::AC_OUTLET = 0x0106, HF::Profiles::AC_OUTLET_WITH_POWER_METERING = 0x0107,   HF::Profiles::SIMPLE_LIGHT = 0x0108, HF::Profiles::DIMMABLE_LIGHT = 0x0109, HF::Profiles::DIMMER_SWITCH = 0x010A, HF::Profiles::SIMPLE_DOOR_LOCK = 0x010B,   HF::Profiles::DOOR_BELL = 0x010C, HF::Profiles::SIMPLE_POWER_METER = 0x010D, HF::Profiles::SIMPLE_TEMPERATURE_SENSOR = 0x010E, HF::Profiles::SIMPLE_HUMIDITY_SENSOR = 0x010F,   HF::Profiles::SIMPLE_AIR_PRESSURE_SENSOR = 0x0110, HF::Profiles::SIMPLE_BUTTON = 0x0111, HF::Profiles::CONTROLABLE_THERMOSTAT = 0x0112, HF::Profiles::SIMPLE_LED = 0x0113,   HF::Profiles::ENVIRONMENT_MONITOR = 0x0114, HF::Profiles::COLOUR_BULB = 0x0115, HF::Profiles::DIMMABLE_COLOUR_BULB = 0x0116, HF::Profiles::TRACKER = 0x0117,   HF::Profiles::SIMPLE_KEYPAD = 0x0118, HF::Profiles::SIMPLE_DETECTOR = 0x0200, HF::Profiles::DOOR_OPEN_CLOSE_DETECTOR = 0x0201, HF::Profiles::WINDOW_OPEN_CLOSE_DETECTOR = 0x0202,   HF::Profiles::MOTION_DETECTOR = 0x0203, HF::Profiles::SMOKE_DETECTOR = 0x0204, HF::Profiles::GAS_DETECTOR = 0x0205, HF::Profiles::FLOOD_DETECTOR = 0x0206,   HF::Profiles::GLASS_BREAK_DETECTOR = 0x0207, HF::Profiles::VIBRATION_DETECTOR = 0x0208, HF::Profiles::SIMPLE_LIGHT_SENSOR = 0x0209, HF::Profiles::SIREN = 0x0280,   HF::Profiles::ALERTABLE = 0x0281, HF::Profiles::SIMPLE_PENDANT = 0x0300, HF::Profiles::USER_INTERFACE_LOCK = 0x0401, HF::Profiles::USER_INTERFACE = 0x0410,   HF::Profiles::GENERIC_APPLICATION = 0x0411, HF::Profiles::PROPRIETARY_START = 0xFF00, HF::Profiles::PROPRIETARY_END = 0xFFFF }
	Profiles UID's More...

Functions
Common::Interface const *	HF::Profiles::interfaces (uint16_t profile, uint16_t &count)
	This function returns a pointer to a entry on a static const array, containing the interfaces the profile with the profile UID. More...

Detailed Description

This module contains the common classes for the Profiles API implementation.

Enumeration Type Documentation

UID

enum HF::Profiles::UID

Profiles UID's

Enumerator
SIMPLE_ONOFF_SWITCHABLE	Allows a unit to receive and interpret on/off requests.
SIMPLE_ONOFF_SWITCH	Allows a unit to send on/off requests.
SIMPLE_LEVEL_CONTROLLABLE	Allows a unit to receive and interpret requests for adjustment of some quantity.
SIMPLE_LEVEL_CONTROL	Allows a unit to send level adjustment requests.
SIMPLE_LEVEL_CONTROLLABLE_SWITCHABLE	Allows a unit to receive and interpret both on/off and level control requests.
SIMPLE_LEVEL_CONTROL_SWITCH	Allows a unit to send both on/off and level control requests.
AC_OUTLET	This unit will be acting upon some physical AC switch.
AC_OUTLET_WITH_POWER_METERING	This unit will be acting upon some physical AC switch and provides measurements over electric quantities.
SIMPLE_LIGHT	This unit will be acting upon some physical Light switch.
DIMMABLE_LIGHT	This unit will be acting upon some dimmable light.
DIMMER_SWITCH	This unit will be acting upon some dimmable light switch.
SIMPLE_DOOR_LOCK	This unit will be acting upon some physical door lock switch.
DOOR_BELL	This unit will be acting upon some physical door bell.
SIMPLE_POWER_METER	Allows a unit to do and provide measurements over electric quantities.
SIMPLE_TEMPERATURE_SENSOR	Simple sensor to measure the temperature.
SIMPLE_HUMIDITY_SENSOR	Simple sensor to measure the relative humidity.
SIMPLE_AIR_PRESSURE_SENSOR	Simple Air Pressure Sensor.
SIMPLE_BUTTON	Simple button.
CONTROLABLE_THERMOSTAT	Controllable thermostat.
SIMPLE_LED	Simple LED profile.
ENVIRONMENT_MONITOR	Environment Monitoring.
COLOUR_BULB	Colour Bulb.
DIMMABLE_COLOUR_BULB	Dimmable Colour Bulb.
TRACKER	Tracker.
SIMPLE_KEYPAD	Simple Keypad.
SIMPLE_DETECTOR	Use for a generic detector that senses and sends an alert.
DOOR_OPEN_CLOSE_DETECTOR	Use for an open/close door detector that senses and sends an alert.
WINDOW_OPEN_CLOSE_DETECTOR	Use for an open/close window detector that senses and sends an alert.
MOTION_DETECTOR	Use for a motion detector that senses and sends an alert.
SMOKE_DETECTOR	Use for a smoke detector that senses and sends an alert.
GAS_DETECTOR	Use for a carbon monoxide detector that senses and sends an alert.
FLOOD_DETECTOR	Use for a flood detector that senses and sends an alert.
GLASS_BREAK_DETECTOR	Use for a glass break detector that senses and sends an alert.
VIBRATION_DETECTOR	Use for a vibration detector that senses and sends an alert.
SIMPLE_LIGHT_SENSOR	Allows a unit to provide light readings.
SIREN	This unit will be acting upon some physical siren that will sound an alert.
ALERTABLE	This profile can be used to receive alerts.
SIMPLE_PENDANT	This unit will trigger an alert, much like a panic button.
USER_INTERFACE_LOCK	User Interface Lock.
USER_INTERFACE	User Interface unit (e.g. keypad, remote control)
GENERIC_APPLICATION	Logic Application logic unit, (e.g. can be at the concentrator, Portal, user controller)
PROPRIETARY_START	Proprietary profiles UID start value.
PROPRIETARY_END	Proprietary profiles UID end value.

Definition at line 60 of file profiles.h.

      {
         // =============================================================================
         // Home Control Unit Types
         // =============================================================================

         SIMPLE_ONOFF_SWITCHABLE = 0x0100,

         SIMPLE_ONOFF_SWITCH = 0x0101,

         SIMPLE_LEVEL_CONTROLLABLE = 0x0102,

         SIMPLE_LEVEL_CONTROL = 0x0103,

         SIMPLE_LEVEL_CONTROLLABLE_SWITCHABLE = 0x0104,

         SIMPLE_LEVEL_CONTROL_SWITCH = 0x0105,

         AC_OUTLET = 0x0106,

         AC_OUTLET_WITH_POWER_METERING = 0x0107,

         SIMPLE_LIGHT = 0x0108,

         DIMMABLE_LIGHT = 0x0109,

         DIMMER_SWITCH = 0x010A,

         SIMPLE_DOOR_LOCK = 0x010B,

         DOOR_BELL = 0x010C,

         SIMPLE_POWER_METER = 0x010D,

         SIMPLE_TEMPERATURE_SENSOR = 0x010E,

         SIMPLE_HUMIDITY_SENSOR = 0x010F,

         SIMPLE_AIR_PRESSURE_SENSOR = 0x0110,

         SIMPLE_BUTTON = 0x0111,

         CONTROLABLE_THERMOSTAT = 0x0112,

         SIMPLE_LED = 0x0113,

         ENVIRONMENT_MONITOR = 0x0114,

         COLOUR_BULB = 0x0115,

         DIMMABLE_COLOUR_BULB = 0x0116,

         TRACKER = 0x0117,

         SIMPLE_KEYPAD = 0x0118,

         // =============================================================================
         // Security Unit Types
         // =============================================================================

         SIMPLE_DETECTOR = 0x0200,

         DOOR_OPEN_CLOSE_DETECTOR = 0x0201,

         WINDOW_OPEN_CLOSE_DETECTOR = 0x0202,

         MOTION_DETECTOR = 0x0203,

         SMOKE_DETECTOR = 0x0204,

         GAS_DETECTOR = 0x0205,

         FLOOD_DETECTOR = 0x0206,

         GLASS_BREAK_DETECTOR = 0x0207,

         VIBRATION_DETECTOR = 0x0208,

         SIMPLE_LIGHT_SENSOR = 0x0209,

         SIREN = 0x0280,

         ALERTABLE = 0x0281,

         // =============================================================================
         // Home care Unit Types
         // =============================================================================

         SIMPLE_PENDANT = 0x0300,

         // =============================================================================
         // Application Unit Types
         // =============================================================================

         USER_INTERFACE_LOCK = 0x0401,

         USER_INTERFACE = 0x0410,

         GENERIC_APPLICATION = 0x0411,

         // =============================================================================
         // Proprietary Unit Types
         // =============================================================================

         // Use an ID from within the specified range to identify a proprietary unit type.

         PROPRIETARY_START = 0xFF00,

         PROPRIETARY_END = 0xFFFF,
      };

Function Documentation

interfaces()

Common::Interface const* HF::Profiles::interfaces	(	uint16_t	profile,
		uint16_t &	count
	)

This function returns a pointer to a entry on a static const array, containing the interfaces the profile with the profile UID.

The number of interfaces is given by count. You can get the addicional interfaces by incrementing the returned pointer.

Warning

The returned pointer MUST NOT be used with free/delete.

Parameters

[in]	profile	the profile UID to retrieve the interfaces for.
[out]	count	the number of interfaces this profile has.

Returns

a pointer to structure containing the interface information for the profile or nullptr if the profile is not known or does not use any of the official interfaces.