Enum Reference

API Reference

This is a list of all enums used by the LaRoomy Api.

TransmissionSubType

  		
enum TransmissionSubType {
    TST_NONE,
    REQUEST,
    RESPONSE,
    COMMAND,
    UPDATE,
    INSERT,
    REMOVE,
    ENABLE,
    DISABLE
};

Description:

The TransmissionSubType enum is for internal use. It determines the type character of an assembled transmission string.

PropertyType

  		
enum PropertyType {
    PTYPE_INVALID,
    BUTTON,
    SWITCH,
    LEVEL_SELECTOR,
    LEVEL_INDICATOR,
    TEXT_DISPLAY,
    OPTION_SELECTOR,
    RGB_SELECTOR,
    EX_LEVEL_SELECTOR,
    TIME_SELECTOR,
    TIME_FRAME_SELECTOR,
    DATE_SELECTOR,
    UNLOCK_CONTROL,
    NAVIGATOR,
    BAR_GRAPH,
    LINE_GRAPH,
    STRING_INTERROGATOR,
    TEXT_LIST_PRESENTER
};

Description:

The PropertyType enum is used to set up the property type of a DeviceProperty object. 

  		
    DeviceProperty deviceProperty;
    deviceProperty.propertyType = PropertyType::LEVEL_SELECTOR;

UserMessageHoldingPeriod

  		
enum UserMessageHoldingPeriod {
    FIVE_SECONDS = 0,
    SEVENpFIVE_SECONDS,
    TEN_SECONDS,
    TWELVEpFIVE_SECONDS,
    FIFTEEN_SECONDS,
    SEVENTEENpFIVE_SECONDS,
    TWENTY_SECONDS,
    INFINITE = 9 
};

Description:

The UserMessageHoldingPeriod enum is used to define the display time for a message presented to the user. It is used in the sendUserMessage method of the LaRoomy Api.

UserMessageType

  		
enum UserMessageType {
    Info,
    Warning,
    Error
};

Description:

The UserMessageType enum is used to define the type of a message displayed to the user. It is used in the sendUserMessage method of the LaRoomy Api.

RGBSelectorFlags

  		
enum RGBSelectorFlags {
    RSF_HIDE_ON_OFF_BUTTON = 0x01,
    RSF_HIDE_SINGLECOLOR_OR_TRANSITION_BUTTON = 0x02,
    RSF_HIDE_INTENSITY_SLIDER = 0x04,
    RSF_HIDE_SOFT_HARD_TRANSITION_SWITCH = 0x08
};

Description:

The RGBSelectorFlags enum could be used to set one or more flags of the RGBSelectorState class in order to hide some unused UI elements. 

  		
RGBSelectorState rgbSelectorState;

// hide the slider and the transition type switch
rgbSelectorState.flags =
    RGBSelectorFlags::RSF_HIDE_INTENSITY_SLIDER | RGBSelectorFlags::RSF_HIDE_SOFT_HARD_TRANSITION_SWITCH;

RGBColorTransitionProgram

  		
enum RGBColorTransitionProgram {
    RCTP_NO_TRANSITION,
    RCTP_SLOW_TRANSITION,
    RCTP_SEMISLOW_TRANSITION,
    RCTP_MEDIUM_TRANSITION,
    RCTP_SEMIFAST_TRANSITION,
    RCTP_FAST_TRANSITION
};

Description:

The RGBColorTransitionProgram enum is used to set the color program of a RGBSelectorState class.

RGBTransitionType

  		
enum RGBTransitionType {
    SOFT_TRANSITION,
    HARD_TRANSITION
};

Description:

The RGBTransitionType enum is used to set the type of transition of a RGBSelectorState class. Hard transition means the color will change immediately, soft transition will fade from one color to another.

ExLevelSelectorFlags

  		
enum ExLevelSelectorFlags {
    HIDE_ON_OFF_SWITCH = 0x01,
    TRANSMIT_ONLY_START_END_TRACKING = 0x02
};

Description:

The ExLevelSelectorFlags enum is used to adapt the behaviour and the visual state of an ExtendedLevelSelector property. It is intended for internal usage, the ExtendedLevelSelectorState has boolean representations of these flags.

ExLevelTrackingType

  		
enum ExLevelTrackingType {
    ELTT_UNUSED,
    INTERTRACK,
    START,
    END
};

Description:

The ExLevelTrackingType enum is used to determine the type of the state-change of a ExtendedLevelSelector property. It is set in the 'trackingType' member of a ExtendedLevelSelectorState class when the state change is reported through the onExtendedLevelSelectorStateChanged method of the callback.

UnlockControlModes

  		
enum UnlockControlModes {
    UNLOCK_MODE,
    PIN_CHANGE_MODE
};

Description:

The UnlockControlModes enum is used to determine the purpose of a state change transmission of the UnlockControl property. In a onUnlockControlStateChanged method of the callback, the 'mode' member of the UnlockControlState parameter is set to a value of this enum. 

  		
// define the callback for the remote app-user events
class RemoteEvents : public ILaroomyAppCallback
{
public:
    // catch the state change of the unlock control property
    void onUnlockControlStateChanged(cID unlockControlID, const UnlockControlState &state) override
    {
        if (state.mode == UnlockControlModes::UNLOCK_MODE)
        {
			// this is unlock mode, lock or unlock whatever is to be unlocked
        }
        else if (state.mode == UnlockControlModes::PIN_CHANGE_MODE)
        {
			// this is pin-change mode, save the pin
        }
    }
};

UnlockControlInvalidOperation

  		
enum UnlockControlInvalidOperation {
    UNLOCK_FAILED_WRONG_PIN,
    PIN_CHANGE_REJECTED_WRONG_PIN
};

Description:

This enum is used to indicate the type of illegal operation a user has performed while interacting with the UnlockControl property. It is reported through the onUnlockControlInvalidOperation method of the callback.

NavigatorButtonTypes

  		
enum NavigatorButtonTypes {
    UP_BUTTON = 0x01,
    RIGHT_BUTTON = 0x02,
    DOWN_BUTTON = 0x04,
    LEFT_BUTTON = 0x08,
    MID_BUTTON = 0x10,
    NO_BUTTON = 0x20
};

Description:

This enum is used to determine the TYPE of button of a NavigatorControl property an action is executed on (touch/release) through a state change. In the onNavigatorStateChanged method of the callback a NavigatorState object is provided as parameter. The 'buttonType' member of the class is set to a value of this enum to indicate the button an action is executed on.

NavigatorActionTypes

  		
enum NavigatorActionTypes {
    NAT_UNUSED,
    BTOUCHED_DOWN,
    BRELEASED
};

Description:

This enum is used to determine the ACTION that is executed on a button of a NavigatorControl property through a state change. In the onNavigatorStateChanged method of the callback a NavigatorState object is provided as parameter. The 'actionType' member of the class is set to a value of this enum to indicate the status of the button.

BarGraphFlags

  		
enum BarGraphFlags {
    USE_VALUE_AS_BARDESCRIPTOR = 0x01,
    USE_FIXED_MAXIMUM_VALUE = 0x02
};

Description:

This enum provides some flags for the customization of a BarGraph property. It is intended for internal usage. The BarGraphState class which is part of a BarGraph has boolean representations of these flags.

LineGraphFlags

  		
enum LineGraphFlags {
    DRAW_GRID_LINES = 0x01,
    DRAW_AXIS_VALUES = 0x02
};

Description:

This enum provides some flags for the customization of a LineGraph property. It is intended for internal usage. The LineGraphState class which is part of a LineGraph has boolean representations of these flags.

LineGraphTransmissionTypes

  		
enum LineGraphTransmissionTypes {
    OVERRIDE_EXISTING_STATE,
    UPDATE_EXISTING_STATE
};

Description:

This enum provides some values for the update transmission of a LineGraphState. It is intended for internal usage.

BindingTransmissionTypes

  		
enum BindingTransmissionTypes {
    B_RELEASE,
    B_ENABLE,
    B_AUTH_REQUEST
};

Description:

The BindingTransmissionTypes enum is used to determine the type of a binding transmission. It is used in the onBindingTransmissionReceived method of the callback.

BindingResponseType

  		
typedef enum {
    BINDING_ENABLE_SUCCESS,
    BINDING_ENABLE_FAIL_NOT_SUPPORTED,
    BINDING_ENABLE_FAIL_NO_KEY,
    BINDING_RELEASE_SUCCESS,
    BINDING_RELEASE_FAIL,
    BINDING_AUTHENTICATION_SUCCESS,
    BINDING_AUTHENTICATION_FAIL_WRONG_KEY,
    BINDING_FAIL_NOT_IMPLEMENTED,
    BINDING_ERROR_UNKNOWN_REQUEST,
    BINDING_ERROR_UNKNOWN
}BindingResponseType;

Description:

This enum is used as a return value to the onBindingTransmissionReceived method of the callback. When the callback method is processed, the appropriate value of this enum, in relation to the result of the processing, must be returned.

PropertyLoadingType

  		
enum PropertyLoadingType {
    LOADED_FROM_CACHE,
    LOADED_FROM_DEVICE
};

Description:

The PropertyLoadingType enum is used in the onPropertyLoadingComplete method of the callback and determines how the property loading process was done.

StringInterrogatorFieldInputType

  		
enum StringInterrogatorFieldInputType {
    SI_INPUT_TEXT,
    SI_INPUT_TEXT_PASSWORD,
    SI_INPUT_NUMBER,
    SI_INPUT_NUMBER_PASSWORD
};

Description:

The StringInterrogatorFieldInputType enum is used to set the input type of a input field in the StringInterrogator property. The StringInterrogatorState class which is part of the StringInterrogator object has members for both fields that can take a value from this enum.

TextListPresenterAction

  		
enum TextListPresenterAction {
    TLPA_NONE,
    TLPA_ADD_TO_LIST,
    TLPA_CLEAR_ALL
};

Description:

This enum is used internally and will be removed in later versions of the Api.

TextListPresenterElementType

  		
enum TextListPresenterElementType {
    DEFAULT_MESSAGE,
    INFO_MESSAGE,
    WARNING_MESSAGE,
    ERROR_MESSAGE
};

Description:

This enum is used to define the type of element to set in a TextListPresenter property. The addTextListPresenterElement method of the LaRoomy Api or of the TextListPresenter object itself takes it as an argument.

LineGraphGridShiftDirection

  		
enum LineGraphGridShiftDirection {
    LGS_SHIFT_X_AXIS_PLUS,
    LGS_SHIFT_X_AXIS_MINUS,
    LGS_SHIFT_Y_AXIS_PLUS,
    LGS_SHIFT_Y_AXIS_MINUS
};

Description:

The LineGraphGridShiftDirection enum is used to define the direction in which to shift the grid of a LineGraph property in a fast data setter transmission. Read more here.