Commit | Line | Data |
---|---|---|
a75e3a5a LOK |
1 | #pragma once |
2 | /* | |
3 | * This file is part of the libCEC(R) library. | |
4 | * | |
5 | * libCEC(R) is Copyright (C) 2011-2012 Pulse-Eight Limited. All rights reserved. | |
6 | * libCEC(R) is an original work, containing original code. | |
7 | * | |
8 | * libCEC(R) is a trademark of Pulse-Eight Limited. | |
9 | * | |
10 | * This program is dual-licensed; you can redistribute it and/or modify | |
11 | * it under the terms of the GNU General Public License as published by | |
12 | * the Free Software Foundation; either version 2 of the License, or | |
13 | * (at your option) any later version. | |
14 | * | |
15 | * This program is distributed in the hope that it will be useful, | |
16 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 | * GNU General Public License for more details. | |
19 | * | |
20 | * You should have received a copy of the GNU General Public License | |
21 | * along with this program; if not, write to the Free Software | |
22 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. | |
23 | * | |
24 | * | |
25 | * Alternatively, you can license this library under a commercial license, | |
26 | * please contact Pulse-Eight Licensing for more information. | |
27 | * | |
28 | * For more information contact: | |
29 | * Pulse-Eight Licensing <license@pulse-eight.com> | |
30 | * http://www.pulse-eight.com/ | |
31 | * http://www.pulse-eight.net/ | |
32 | */ | |
33 | ||
34 | #include "USBCECAdapterCommunication.h" | |
35 | ||
36 | namespace CEC | |
37 | { | |
38 | class CUSBCECAdapterCommands | |
39 | { | |
40 | public: | |
7c5c5bf4 | 41 | CUSBCECAdapterCommands(CUSBCECAdapterCommunication *comm); |
a75e3a5a LOK |
42 | |
43 | /*! | |
44 | * @brief Request the firmware version from the adapter. | |
45 | * @return The firmware version, or 1 (default) if it couldn't be retrieved. | |
46 | */ | |
47 | uint16_t RequestFirmwareVersion(void); | |
48 | ||
7c5c5bf4 LOK |
49 | /*! |
50 | * @return The firmware version of the adapter, retrieved when the connection is opened. | |
51 | */ | |
52 | uint16_t GetFirmwareVersion(void) const { return m_persistedConfiguration.iFirmwareVersion; }; | |
53 | ||
54 | /*! | |
55 | * @brief Persist the current configuration in the EEPROM. | |
56 | * @attention Not all settings are persisted at this time. | |
57 | * @param configuration The configuration to persist. | |
58 | * @return True when persisted, false otherwise. | |
59 | */ | |
60 | bool PersistConfiguration(libcec_configuration *configuration); | |
61 | ||
62 | /*! | |
63 | * @brief Get the persisted configuration from the EEPROM. | |
64 | * @param configuration The persisted configuration. | |
65 | * @return True when retrieved, false otherwise. | |
66 | */ | |
67 | bool GetConfiguration(libcec_configuration *configuration); | |
68 | ||
69 | /*! | |
70 | * @brief Send a ping command to the adapter. | |
71 | * @return True when acked by the adapter, false otherwise. | |
72 | */ | |
73 | bool PingAdapter(void); | |
74 | ||
75 | /*! | |
76 | * @brief Change the ackmask of the adapter. | |
77 | * @param iMask The new mask. | |
78 | * @return True when the change was acked by the adapter, false otherwise. | |
79 | */ | |
80 | bool SetAckMask(uint16_t iMask); | |
81 | ||
82 | /*! | |
83 | * @brief Put the adapter in bootloader mode. | |
84 | * @attention The connection needs to be closed after this call, since the adapter will no longer be available. | |
85 | * @return True when the command was sent, false otherwise. | |
86 | */ | |
87 | bool StartBootloader(void); | |
88 | ||
89 | /*! | |
90 | * @brief Change the current CEC line timeout. | |
91 | * @param iTimeout The new timeout. | |
92 | * @return True when the change was acked by the adapter, false otherwise. | |
93 | */ | |
94 | bool SetLineTimeout(uint8_t iTimeout); | |
95 | ||
96 | /*! | |
97 | * @brief Put the adapter in controlled or autonomous mode. | |
98 | * @param controlled True to switch to controlled mode, false to switch to auto mode. | |
99 | * @return True when acked by the controller, false otherwise. | |
100 | */ | |
101 | bool SetControlledMode(bool controlled); | |
102 | ||
103 | private: | |
104 | /*! | |
105 | * @brief Reads all settings from the eeprom. | |
106 | * @return True when read, false otherwise. | |
107 | */ | |
108 | bool RequestSettings(void); | |
109 | ||
a75e3a5a LOK |
110 | /*! |
111 | * @brief Request a setting value from the adapter. | |
112 | * @param msgCode The setting to retrieve. | |
113 | * @return The response from the adapter. | |
114 | */ | |
115 | cec_datapacket RequestSetting(cec_adapter_messagecode msgCode); | |
116 | ||
117 | /*! | |
118 | * @brief Change the value of the "auto enabled" setting. | |
119 | * @param enabled The new value. | |
120 | * @return True when set, false otherwise. | |
121 | */ | |
122 | bool SetSettingAutoEnabled(bool enabled); | |
123 | ||
124 | /*! | |
125 | * @brief Request the value of the "auto enabled" setting from the adapter. | |
a75e3a5a LOK |
126 | * @return True when retrieved, false otherwise. |
127 | */ | |
7c5c5bf4 | 128 | bool RequestSettingAutoEnabled(void); |
a75e3a5a LOK |
129 | |
130 | /*! | |
131 | * @brief Change the value of the "device type" setting, used when the device is in autonomous mode. | |
132 | * @param type The new value. | |
133 | * @return True when set, false otherwise. | |
134 | */ | |
135 | bool SetSettingDeviceType(cec_device_type type); | |
136 | ||
137 | /*! | |
138 | * @brief Request the value of the "device type" setting from the adapter. | |
a75e3a5a LOK |
139 | * @return True when retrieved, false otherwise. |
140 | */ | |
7c5c5bf4 | 141 | bool RequestSettingDeviceType(void); |
a75e3a5a LOK |
142 | |
143 | /*! | |
144 | * @brief Change the value of the "default logical address" setting, used when the device is in autonomous mode. | |
145 | * @param address The new value. | |
146 | * @return True when set, false otherwise. | |
147 | */ | |
148 | bool SetSettingDefaultLogicalAddress(cec_logical_address address); | |
149 | ||
150 | /*! | |
151 | * @brief Request the value of the "default logical address" setting from the adapter. | |
a75e3a5a LOK |
152 | * @return True when retrieved, false otherwise. |
153 | */ | |
7c5c5bf4 | 154 | bool RequestSettingDefaultLogicalAddress(void); |
a75e3a5a LOK |
155 | |
156 | /*! | |
157 | * @brief Change the value of the "logical address mask" setting, used when the device is in autonomous mode. | |
158 | * @param iMask The new value. | |
159 | * @return True when set, false otherwise. | |
160 | */ | |
161 | bool SetSettingLogicalAddressMask(uint16_t iMask); | |
162 | ||
163 | /*! | |
164 | * @brief Request the value of the "logical address mask" setting from the adapter. | |
a75e3a5a LOK |
165 | * @return True when retrieved, false otherwise. |
166 | */ | |
7c5c5bf4 | 167 | bool RequestSettingLogicalAddressMask(void); |
a75e3a5a LOK |
168 | |
169 | /*! | |
170 | * @brief Change the value of the "physical address" setting, used when the device is in autonomous mode. | |
171 | * @param iPhysicalAddress The new value. | |
172 | * @return True when set, false otherwise. | |
173 | */ | |
174 | bool SetSettingPhysicalAddress(uint16_t iPhysicalAddress); | |
175 | ||
176 | /*! | |
177 | * @brief Request the value of the "physical address" setting from the adapter. | |
a75e3a5a LOK |
178 | * @return True when retrieved, false otherwise. |
179 | */ | |
7c5c5bf4 | 180 | bool RequestSettingPhysicalAddress(void); |
a75e3a5a LOK |
181 | |
182 | /*! | |
183 | * @brief Change the value of the "CEC version" setting, used when the device is in autonomous mode. | |
184 | * @param version The new value. | |
185 | * @return True when set, false otherwise. | |
186 | */ | |
187 | bool SetSettingCECVersion(cec_version version); | |
188 | ||
189 | /*! | |
190 | * @brief Request the value of the "CEC version" setting from the adapter. | |
a75e3a5a LOK |
191 | * @return True when retrieved, false otherwise. |
192 | */ | |
7c5c5bf4 | 193 | bool RequestSettingCECVersion(void); |
a75e3a5a LOK |
194 | |
195 | /*! | |
196 | * @brief Change the value of the "OSD name" setting, used when the device is in autonomous mode. | |
197 | * @param strOSDName The new value. | |
198 | * @return True when set, false otherwise. | |
199 | */ | |
200 | bool SetSettingOSDName(const char *strOSDName); | |
201 | ||
202 | /*! | |
203 | * @brief Request the value of the "OSD name" setting from the adapter. | |
a75e3a5a LOK |
204 | * @return True when retrieved, false otherwise. |
205 | */ | |
7c5c5bf4 | 206 | bool RequestSettingOSDName(void); |
a75e3a5a LOK |
207 | |
208 | /*! | |
209 | * @brief Persist the current settings in the EEPROM | |
210 | * @return True when persisted, false otherwise. | |
211 | */ | |
212 | bool WriteEEPROM(void); | |
213 | ||
7c5c5bf4 LOK |
214 | CUSBCECAdapterCommunication *m_comm; /**< the communication handler */ |
215 | bool m_bSettingsRetrieved; /**< true when the settings were read from the eeprom, false otherwise */ | |
216 | bool m_bSettingAutoEnabled; /**< the value of the auto-enabled setting */ | |
217 | cec_version m_settingCecVersion; /**< the value of the cec version setting */ | |
218 | uint16_t m_iSettingLAMask; /**< the value of the LA mask setting */ | |
219 | bool m_bNeedsWrite; /**< true when we sent changed settings to the adapter that have not been persisted */ | |
220 | libcec_configuration m_persistedConfiguration; /**< the configuration that is persisted in the eeprom */ | |
a75e3a5a LOK |
221 | }; |
222 | } |