Open Lighting Architecture: include/ola/rdm/RDMHelper.h Source File

| Open Lighting Architecture 0.10.9

Loading...
Searching...
No Matches
RDMHelper.h
Go to the documentation of this file.
1/*
2 * This library is free software; you can redistribute it and/or
3 * modify it under the terms of the GNU Lesser General Public
4 * License as published by the Free Software Foundation; either
5 * version 2.1 of the License, or (at your option) any later version.
6 *
7 * This library is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
10 * Lesser General Public License for more details.
11 *
12 * You should have received a copy of the GNU Lesser General Public
13 * License along with this library; if not, write to the Free Software
14 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15 *
16 * RDMHelper.h
17 * Various misc RDM functions.
18 * Copyright (C) 2005 Simon Newton
19 */
20
28
29#ifndef INCLUDE_OLA_RDM_RDMHELPER_H_
30#define INCLUDE_OLA_RDM_RDMHELPER_H_
31
32#include <stdint.h>
33#include <ola/rdm/RDMEnums.h>
34#include <ola/rdm/RDMResponseCodes.h>
35#include <string>
36
37namespace ola {
38namespace rdm {
39
40std::string StatusCodeToString(RDMStatusCode status);
41
45 inline std::string ResponseCodeToString(RDMStatusCode status) {
46 return StatusCodeToString(status);
47}
48
49std::string DataTypeToString(uint8_t type);
50std::string LampModeToString(uint8_t lamp_mode);
51std::string LampStateToString(uint8_t lamp_state);
52std::string NackReasonToString(uint16_t reason);
53std::string PowerStateToString(uint8_t power_state);
54bool UIntToPowerState(uint8_t state, rdm_power_state *power_state);
55std::string PrefixToString(uint8_t prefix);
56std::string ProductCategoryToString(uint16_t category);
57std::string ProductDetailToString(uint16_t detail);
58std::string ResetDeviceToString(uint8_t reset_device);
59bool UIntToResetDevice(uint8_t state, rdm_reset_device_mode *reset_device);
60std::string SensorTypeToString(uint8_t type);
61std::string SensorSupportsRecordingToString(uint8_t supports_recording);
62std::string SlotInfoToString(uint8_t slot_type, uint16_t slot_label);
63std::string StatusMessageIdToString(uint16_t message_id,
64 int16_t data1,
65 int16_t data2);
66std::string StatusTypeToString(uint8_t status_type);
67std::string UnitToString(uint8_t unit);
68} // namespace rdm
69} // namespace ola
70#endif // INCLUDE_OLA_RDM_RDMHELPER_H_
RDMEnums.h
Various constants used in RDM.
RDMResponseCodes.h
Enums representing the states of a response. This is generated from the proto file.
ola::rdm
PLASA E1.20 Remote Device Management.
Definition AckTimerResponder.cpp:38
ola::rdm::LampStateToString
string LampStateToString(uint8_t lamp_state)
Definition RDMHelper.cpp:146
ola::rdm::StatusCodeToString
string StatusCodeToString(RDMStatusCode status)
Definition RDMHelper.cpp:40
ola::rdm::UnitToString
string UnitToString(uint8_t unit)
Definition RDMHelper.cpp:1083
ola::rdm::ResetDeviceToString
string ResetDeviceToString(uint8_t reset_device)
Definition RDMHelper.cpp:638
ola::rdm::LampModeToString
string LampModeToString(uint8_t lamp_mode)
Definition RDMHelper.cpp:124
ola::rdm::StatusMessageIdToString
string StatusMessageIdToString(uint16_t message_id, int16_t data1, int16_t data2)
Definition RDMHelper.cpp:910
ola::rdm::StatusTypeToString
string StatusTypeToString(uint8_t status_type)
Definition RDMHelper.cpp:1052
ola::rdm::ProductDetailToString
string ProductDetailToString(uint16_t detail)
Definition RDMHelper.cpp:464
ola::rdm::SensorSupportsRecordingToString
string SensorSupportsRecordingToString(uint8_t supports_recording)
Definition RDMHelper.cpp:756
ola::rdm::ResponseCodeToString
std::string ResponseCodeToString(RDMStatusCode status)
Definition RDMHelper.h:45
ola::rdm::PowerStateToString
string PowerStateToString(uint8_t power_state)
Definition RDMHelper.cpp:226
ola::rdm::RDMStatusCode
RDMStatusCode
RDM Status Codes.
Definition RDMResponseCodes.h:45
ola::rdm::ProductCategoryToString
string ProductCategoryToString(uint16_t category)
Definition RDMHelper.cpp:328
ola::rdm::DataTypeToString
string DataTypeToString(uint8_t type)
Definition RDMHelper.cpp:92
ola::rdm::UIntToResetDevice
bool UIntToResetDevice(uint8_t state, rdm_reset_device_mode *reset_device)
Definition RDMHelper.cpp:655
ola::rdm::SensorTypeToString
string SensorTypeToString(uint8_t type)
Definition RDMHelper.cpp:673
ola::rdm::SlotInfoToString
string SlotInfoToString(uint8_t slot_type, uint16_t slot_label)
Definition RDMHelper.cpp:773
ola::rdm::UIntToPowerState
bool UIntToPowerState(uint8_t state, rdm_power_state *power_state)
Definition RDMHelper.cpp:247
ola::rdm::PrefixToString
string PrefixToString(uint8_t prefix)
Definition RDMHelper.cpp:271
ola::rdm::NackReasonToString
string NackReasonToString(uint16_t reason)
Definition RDMHelper.cpp:172
ola
The namespace containing all OLA symbols.
Definition Credentials.cpp:44