- Generated by
1.8.13
|
Lightweight USB stack
1.0
|
Macros | |
| #define | HID_POWER_PAGE 0x84 |
Power Device Structure | |
| #define | HID_POWER_INAME 0x01 |
| #define | HID_POWER_PRESENT_STATUS 0x02 |
| #define | HID_POWER_CHANGED_STATUS 0x03 |
| #define | HID_POWER_UPS 0x04 |
| #define | HID_POWER_POWER_SUPPLY 0x05 |
| #define | HID_POWER_BATTERY_SYSTEM 0x10 |
| #define | HID_POWER_BATTERY_SYSTEM_ID 0x11 |
| #define | HID_POWER_BATTERY 0x12 |
| #define | HID_POWER_BATTERY_ID 0x13 |
| #define | HID_POWER_CHARGER 0x14 |
| #define | HID_POWER_CHARGER_ID 0x15 |
| #define | HID_POWER_POWER_CONVERTER 0x16 |
| #define | HID_POWER_POWER_CONVERTER_ID 0x17 |
| #define | HID_POWER_OUTLET_SYSTEM 0x18 |
| #define | HID_POWER_OUTLET_SYSTEM_ID 0x19 |
| #define | HID_POWER_INPUT 0x1A |
| #define | HID_POWER_INPUT_ID 0x1B |
| #define | HID_POWER_OUTPUT 0x1C |
| #define | HID_POWER_OUTPUT_ID 0x1D |
| #define | HID_POWER_FLOW 0x1E |
| #define | HID_POWER_FLOW_ID 0x1F |
| #define | HID_POWER_OUTLET 0x20 |
| #define | HID_POWER_OUTLET_ID 0x21 |
| #define | HID_POWER_GANG 0x22 |
| #define | HID_POWER_GANG_ID 0x23 |
| #define | HID_POWER_POWER_SUMMARY 0x24 |
| #define | HID_POWER_POWER_SUMMARY_ID 0x25 |
Power Measures | |
| #define | HID_POWER_VOLTAGE 0x30 |
| #define | HID_POWER_CURRENT 0x31 |
| #define | HID_POWER_FREQUENCY 0x32 |
| #define | HID_POWER_APPARENT_POWER 0x33 |
| #define | HID_POWER_ACTIVE_POWER 0x34 |
| #define | HID_POWER_PERCENT_LOAD 0x35 |
| #define | HID_POWER_TEMPERATURE 0x36 |
| #define | HID_POWER_HUMIDITY 0x37 |
| #define | HID_POWER_BAD_COUNT 0x38 |
Power configuration controls | |
| #define | HID_POWER_CONFIG_VOLTAGE 0x40 |
| #define | HID_POWER_CONFIG_CURRENT 0x41 |
| #define | HID_POWER_CONFIG_FREQUENCY 0x42 |
| #define | HID_POWER_CONFIG_APPARENT_POWER 0x43 |
| #define | HID_POWER_CONFIG_ACTIVE_POWER 0x44 |
| #define | HID_POWER_CONFIG_PERCENT_LOAD 0x45 |
| #define | HID_POWER_CONFIG_TEMPERATURE 0x46 |
| #define | HID_POWER_CONFIG_HUMIDITY 0x47 |
Power controls | |
| #define | HID_POWER_SWITCH_ON_CONTROL 0x50 |
| #define | HID_POWER_SWITCH_OFF_CONTROL 0x51 |
| #define | HID_POWER_TOGGLE_CONTROL 0x52 |
| #define | HID_POWER_LOW_VOLTAGE_TRANSFER 0x53 |
| #define | HID_POWER_HIGH_VOLTAGE_TRANSFER 0x54 |
| #define | HID_POWER_DELAY_BEFORE_REBOOT 0x55 |
| #define | HID_POWER_DELAY_BEFORE_STARTUP 0x56 |
| #define | HID_POWER_DELAY_BEFORE_SHUTDOWN 0x57 |
| #define | HID_POWER_TEST 0x58 |
| #define | HID_POWER_MODULE_RESET 0x59 |
| #define | HID_POWER_AUDIBLE_ALARM_CONTROL 0x5A |
Power generic status | |
| #define | HID_POWER_PRESENT 0x60 |
| #define | HID_POWER_GOOD 0x61 |
| #define | HID_POWER_INTERNAL_FAILURE 0x62 |
| #define | HID_POWER_VOLTAGE_OUT_OF_RANGE 0x63 |
| #define | HID_POWER_FREQUENCY_OUT_OF_RANGE 0x64 |
| #define | HID_POWER_OVERLOAD 0x65 |
| #define | HID_POWER_OVERCHARGED 0x66 |
| #define | HID_POWER_OVERTEMPERATURE 0x67 |
| #define | HID_POWER_SUTDOWN_REQUESTED 0x68 |
| #define | HID_POWER_SHUTDOWN_IMMINENT 0x69 |
| #define | HID_POWER_SWITCH_ON_OFF 0x6B |
| #define | HID_POWER_SWITHABLE 0x6C |
| #define | HID_POWER_USED 0x6D |
| #define | HID_POWER_BOOST 0x6E |
| #define | HID_POWER_BUCK 0x6F |
| #define | HID_POWER_INITIALIZED 0x70 |
| #define | HID_POWER_TESTED 0x71 |
| #define | HID_POWER_AWAITING_POWER 0x72 |
| #define | HID_POWER_COMMUNICATION_LOST 0x73 |
Power device identification | |
| #define | HID_POWER_IMANUFACTURER 0xFD |
| #define | HID_POWER_IPRODUCT 0xFE |
| #define | HID_POWER_ISERIALNUMBER 0xFF |
Switch ON/OFF/TOGGLE sequence values | |
| #define | HID_POWER_STOP_SEQUENCE 0x00 |
| #define | HID_POWER_START_SEQUENCE 0x01 |
| #define | HID_POWER_SEQUENCE_NONE 0x00 |
| #define | HID_POWER_SEQUENCE_STARTED 0x01 |
| #define | HID_POWER_SEQUENCE_INPROGRESS 0x02 |
| #define | HID_POWER_SEQUENCE_STOPPED 0x03 |
Test request/result values | |
| #define | HID_POWER_TEST_NO 0x00 |
| #define | HID_POWER_TEST_QUICK 0x01 |
| #define | HID_POWER_TEST_DEEP 0x02 |
| #define | HID_POWER_TEST_ABORT 0x03 |
| #define | HID_POWER_TEST_PASSED 0x01 |
| #define | HID_POWER_TEST_WARNED 0x02 |
| #define | HID_POWER_TEST_ERROR 0x03 |
| #define | HID_POWER_TEST_ABORTED 0x04 |
| #define | HID_POWER_TEST_INPROGRESS 0x05 |
| #define | HID_POWER_TEST_NOT_INITIATED 0x06 |
Module reset values | |
| #define | HID_POWER_RESET_NO 0x00 |
| #define | HID_POWER_RESET_MODULE 0x01 |
| #define | HID_POWER_RESET_ALARMS 0x02 |
| #define | HID_POWER_RESET_COUNTERS 0x03 |
Audible alarm values | |
| #define | HID_POWER_ALARM_DISABLED 0x00 |
| #define | HID_POWER_ALARM_ENABLED 0x01 |
| #define | HID_POWER_ALARM_MUTED 0x02 |
| #define HID_POWER_PAGE 0x84 |
Power device page
Definition at line 71 of file hid_usage_power.h.
| #define HID_POWER_INAME 0x01 |
[SV] Index of the name string descriptor.
Definition at line 74 of file hid_usage_power.h.
| #define HID_POWER_PRESENT_STATUS 0x02 |
[CL] Collection of Present status information related to an object.
Definition at line 75 of file hid_usage_power.h.
| #define HID_POWER_CHANGED_STATUS 0x03 |
[CL] Collection of Changed status information related to an object.
Definition at line 76 of file hid_usage_power.h.
| #define HID_POWER_UPS 0x04 |
[CA] Collection that defines an Uninterruptible Power Supply.
Definition at line 77 of file hid_usage_power.h.
| #define HID_POWER_POWER_SUPPLY 0x05 |
[CA] Collection that defines a Power Supply.
Definition at line 78 of file hid_usage_power.h.
| #define HID_POWER_BATTERY_SYSTEM 0x10 |
[CP] Collection that defines a Battery System power module.
Definition at line 79 of file hid_usage_power.h.
| #define HID_POWER_BATTERY_SYSTEM_ID 0x11 |
[SV] Number that points to a particular Battery System.
Definition at line 80 of file hid_usage_power.h.
| #define HID_POWER_BATTERY 0x12 |
[CP] Collection that defines a Battery.
Definition at line 81 of file hid_usage_power.h.
| #define HID_POWER_BATTERY_ID 0x13 |
[SV] Number that points to a particular Battery.
Definition at line 82 of file hid_usage_power.h.
| #define HID_POWER_CHARGER 0x14 |
[CP] Collection that defines a Charger.
Definition at line 83 of file hid_usage_power.h.
| #define HID_POWER_CHARGER_ID 0x15 |
[SV] Number that points to a particular Charger.
Definition at line 84 of file hid_usage_power.h.
| #define HID_POWER_POWER_CONVERTER 0x16 |
[CP] Collection that defines a Power Converter power module.
Definition at line 85 of file hid_usage_power.h.
| #define HID_POWER_POWER_CONVERTER_ID 0x17 |
[SV] Number that points to a particular Power Converter.
Definition at line 86 of file hid_usage_power.h.
| #define HID_POWER_OUTLET_SYSTEM 0x18 |
[CP] Collection that defines a Outlet System power module.
Definition at line 87 of file hid_usage_power.h.
| #define HID_POWER_OUTLET_SYSTEM_ID 0x19 |
[SV] Number that points to a particular Outlet System.
Definition at line 88 of file hid_usage_power.h.
| #define HID_POWER_INPUT 0x1A |
[CP] Collection that defines an Input.
Definition at line 89 of file hid_usage_power.h.
| #define HID_POWER_INPUT_ID 0x1B |
[SV] Number that points to a particular Input.
Definition at line 90 of file hid_usage_power.h.
| #define HID_POWER_OUTPUT 0x1C |
[CP] Collection that defines an Output.
Definition at line 91 of file hid_usage_power.h.
| #define HID_POWER_OUTPUT_ID 0x1D |
[SV] Number that points to a particular Output.
Definition at line 92 of file hid_usage_power.h.
| #define HID_POWER_FLOW 0x1E |
[CP] Collection that defines a Flow.
Definition at line 93 of file hid_usage_power.h.
| #define HID_POWER_FLOW_ID 0x1F |
[SV] Number that points to a particular Flow.
Definition at line 94 of file hid_usage_power.h.
| #define HID_POWER_OUTLET 0x20 |
[CP] Collection that defines an Outlet.
Definition at line 95 of file hid_usage_power.h.
| #define HID_POWER_OUTLET_ID 0x21 |
[SV] Number that points to a particular Outlet
Definition at line 96 of file hid_usage_power.h.
| #define HID_POWER_GANG 0x22 |
[CL/CP] Collection that defines ganged objects.
Definition at line 97 of file hid_usage_power.h.
| #define HID_POWER_GANG_ID 0x23 |
[SV] Number that points to a particular Gang.
Definition at line 98 of file hid_usage_power.h.
| #define HID_POWER_POWER_SUMMARY 0x24 |
[CL/CP] Collection that defines a Power Summary.
Definition at line 99 of file hid_usage_power.h.
| #define HID_POWER_POWER_SUMMARY_ID 0x25 |
[SV] Number that points to a particular Power Summary.
Definition at line 100 of file hid_usage_power.h.
| #define HID_POWER_VOLTAGE 0x30 |
[DV] Actual value of the voltage.
Definition at line 104 of file hid_usage_power.h.
| #define HID_POWER_CURRENT 0x31 |
[DV] Actual value of the current.
Definition at line 105 of file hid_usage_power.h.
| #define HID_POWER_FREQUENCY 0x32 |
[DV] Actual value of the frequency.
Definition at line 106 of file hid_usage_power.h.
| #define HID_POWER_APPARENT_POWER 0x33 |
[DV] Actual value of the apparent power.
Definition at line 107 of file hid_usage_power.h.
| #define HID_POWER_ACTIVE_POWER 0x34 |
[DV] Actual value of the active (RMS) power.
Definition at line 108 of file hid_usage_power.h.
| #define HID_POWER_PERCENT_LOAD 0x35 |
[DV] Actual value of the percentage of the power capacity presently being used on this input or output line.
Definition at line 109 of file hid_usage_power.h.
| #define HID_POWER_TEMPERATURE 0x36 |
[DV] Actual value of the temperature.
Definition at line 110 of file hid_usage_power.h.
| #define HID_POWER_HUMIDITY 0x37 |
[DV] Actual value of the humidity.
Definition at line 111 of file hid_usage_power.h.
| #define HID_POWER_BAD_COUNT 0x38 |
[DV] Number of times the device, module, or sub-module entered a bad condition.
Definition at line 112 of file hid_usage_power.h.
| #define HID_POWER_CONFIG_VOLTAGE 0x40 |
[SV/DV] Nominal value of the voltage.
Definition at line 116 of file hid_usage_power.h.
| #define HID_POWER_CONFIG_CURRENT 0x41 |
[SV/DV] Nominal value of the current.
Definition at line 117 of file hid_usage_power.h.
| #define HID_POWER_CONFIG_FREQUENCY 0x42 |
[SV/DV] Nominal value of the frequency.
Definition at line 118 of file hid_usage_power.h.
| #define HID_POWER_CONFIG_APPARENT_POWER 0x43 |
[SV/DV] Nominal value of the apparent power.
Definition at line 119 of file hid_usage_power.h.
| #define HID_POWER_CONFIG_ACTIVE_POWER 0x44 |
[SV/DV] Nominal value of the active (RMS) power.
Definition at line 120 of file hid_usage_power.h.
| #define HID_POWER_CONFIG_PERCENT_LOAD 0x45 |
[SV/DV] Nominal value of the percentage load that could be used without critical overload.
Definition at line 121 of file hid_usage_power.h.
| #define HID_POWER_CONFIG_TEMPERATURE 0x46 |
[SV/DV] Nominal value of the temperature.
Definition at line 122 of file hid_usage_power.h.
| #define HID_POWER_CONFIG_HUMIDITY 0x47 |
[SV/DV] Nominal value of the humidity.
Definition at line 123 of file hid_usage_power.h.
| #define HID_POWER_SWITCH_ON_CONTROL 0x50 |
[DV] Controls the Switch ON sequence.
Definition at line 127 of file hid_usage_power.h.
| #define HID_POWER_SWITCH_OFF_CONTROL 0x51 |
[DV] Controls the Switch OFF sequence.
Definition at line 128 of file hid_usage_power.h.
| #define HID_POWER_TOGGLE_CONTROL 0x52 |
[DV] Controls the Toggle sequence.
Definition at line 129 of file hid_usage_power.h.
| #define HID_POWER_LOW_VOLTAGE_TRANSFER 0x53 |
[DV] Minimum line voltage allowed before the PS system transfers to battery backup.
Definition at line 130 of file hid_usage_power.h.
| #define HID_POWER_HIGH_VOLTAGE_TRANSFER 0x54 |
[DV] Maximum line voltage allowed before the PS system transfers to battery backup.
Definition at line 131 of file hid_usage_power.h.
| #define HID_POWER_DELAY_BEFORE_REBOOT 0x55 |
[DV] Writing this value immediately shuts down (i.e., turns off) the output for a period equal to the indicated number of seconds, after which time the output is started. If the number of seconds required to perform the request is greater than the requested duration, then the requested shutdown and startup cycle shall be performed in the minimum time possible, but in no case shall this require more than the requested duration plus 60 seconds. If the startup should occur during a utility failure, the startup shall not occur until the utility power is restored.
When read, returns the number of seconds remaining in the countdown, or –1 if no countdown is in progress.
Definition at line 132 of file hid_usage_power.h.
| #define HID_POWER_DELAY_BEFORE_STARTUP 0x56 |
[DV] Writing this value starts the output after the indicated number of seconds. Sending this command with 0 causes the startup to occur immediately. Sending this command with –1 aborts the countdown. If the output is already on at the time the countdown reaches 0, nothing happens. On some systems, if the USB driver on the device side is restarted while a startup countdown is in effect, the countdown is aborted. If the countdown expires during a utility failure, the startup shall not occur until the utility power is restored. Writing this value overrides the effect of any countdown in progress.
When read, returns the number of seconds remaining in the countdown, or –1 if no countdown is in progress.
Definition at line 149 of file hid_usage_power.h.
| #define HID_POWER_DELAY_BEFORE_SHUTDOWN 0x57 |
[DV] Writing this value shuts down either the output after the indicated number of seconds, or sooner if the batteries become depleted. Sending this command with 0 causes the shutdown to occur immediately. Sending this command with –1 aborts the countdown. If the system is already in the desired state at the time the countdown reaches 0, there is no additional action. On some systems, if the USB driver on the device side is restarted while a shutdown countdown is in effect, the countdown may be aborted. Writing this value overrides any DelayBeforeShutdown countdown already in effect.
When read, will return the number of seconds remaining until shutdown, or –1 if no shutdown countdown is in effect.
Definition at line 166 of file hid_usage_power.h.
| #define HID_POWER_TEST 0x58 |
[DV] Test request or result value.
Definition at line 183 of file hid_usage_power.h.
| #define HID_POWER_MODULE_RESET 0x59 |
[DV] Module Reset request value.
Definition at line 184 of file hid_usage_power.h.
| #define HID_POWER_AUDIBLE_ALARM_CONTROL 0x5A |
[DV] Audible alarm value.
Definition at line 185 of file hid_usage_power.h.
| #define HID_POWER_PRESENT 0x60 |
[DF] Power present flag.
Definition at line 189 of file hid_usage_power.h.
| #define HID_POWER_GOOD 0x61 |
[DF] Power good flag.
Definition at line 190 of file hid_usage_power.h.
| #define HID_POWER_INTERNAL_FAILURE 0x62 |
[DF] Inetrnal failure flag.
Definition at line 191 of file hid_usage_power.h.
| #define HID_POWER_VOLTAGE_OUT_OF_RANGE 0x63 |
[DF] Voltage out of range flag.
Definition at line 192 of file hid_usage_power.h.
| #define HID_POWER_FREQUENCY_OUT_OF_RANGE 0x64 |
[DF] Frequency out of range flag.
Definition at line 193 of file hid_usage_power.h.
| #define HID_POWER_OVERLOAD 0x65 |
[DF] Overload flag.
Definition at line 194 of file hid_usage_power.h.
| #define HID_POWER_OVERCHARGED 0x66 |
[DF] Overcharged flag.
Definition at line 195 of file hid_usage_power.h.
| #define HID_POWER_OVERTEMPERATURE 0x67 |
[DF] Overtemperature flag.
Definition at line 196 of file hid_usage_power.h.
| #define HID_POWER_SUTDOWN_REQUESTED 0x68 |
[DF] Shutdown requested flag.
Definition at line 197 of file hid_usage_power.h.
| #define HID_POWER_SHUTDOWN_IMMINENT 0x69 |
[DF] Shutdown imminent flag.
Definition at line 198 of file hid_usage_power.h.
| #define HID_POWER_SWITCH_ON_OFF 0x6B |
[DF] Switch ON flag.
Definition at line 199 of file hid_usage_power.h.
| #define HID_POWER_SWITHABLE 0x6C |
[DF] Swithable flag.
Definition at line 200 of file hid_usage_power.h.
| #define HID_POWER_USED 0x6D |
[DF] Used flag.
Definition at line 201 of file hid_usage_power.h.
| #define HID_POWER_BOOST 0x6E |
[DF] Voltage boosted flag.
Definition at line 202 of file hid_usage_power.h.
| #define HID_POWER_BUCK 0x6F |
[DF] Voltage bucked flag.
Definition at line 203 of file hid_usage_power.h.
| #define HID_POWER_INITIALIZED 0x70 |
[DF] Initialized flag.
Definition at line 204 of file hid_usage_power.h.
| #define HID_POWER_TESTED 0x71 |
[DF] Tested flag.
Definition at line 205 of file hid_usage_power.h.
| #define HID_POWER_AWAITING_POWER 0x72 |
[DF] Awaiting power flag.
Definition at line 206 of file hid_usage_power.h.
| #define HID_POWER_COMMUNICATION_LOST 0x73 |
[DF] Communication lost flag.
Definition at line 207 of file hid_usage_power.h.
| #define HID_POWER_IMANUFACTURER 0xFD |
[SV] Index of the manufacturer string descriptor.
Definition at line 210 of file hid_usage_power.h.
| #define HID_POWER_IPRODUCT 0xFE |
[SV] Index of the prodict string descriptor.
Definition at line 211 of file hid_usage_power.h.
| #define HID_POWER_ISERIALNUMBER 0xFF |
[SV] Index of the serial number string descriptor.
Definition at line 212 of file hid_usage_power.h.
| #define HID_POWER_STOP_SEQUENCE 0x00 |
Write value. Stop sequence.
Definition at line 215 of file hid_usage_power.h.
| #define HID_POWER_START_SEQUENCE 0x01 |
Write value. Start sequence.
Definition at line 216 of file hid_usage_power.h.
| #define HID_POWER_SEQUENCE_NONE 0x00 |
Read value. No sequence.
Definition at line 217 of file hid_usage_power.h.
| #define HID_POWER_SEQUENCE_STARTED 0x01 |
Read value. Sequence started.
Definition at line 218 of file hid_usage_power.h.
| #define HID_POWER_SEQUENCE_INPROGRESS 0x02 |
Read value. Sequence in progress.
Definition at line 219 of file hid_usage_power.h.
| #define HID_POWER_SEQUENCE_STOPPED 0x03 |
Read value. Sequence completed.
Definition at line 220 of file hid_usage_power.h.
| #define HID_POWER_TEST_NO 0x00 |
Write value. No test.
Definition at line 223 of file hid_usage_power.h.
| #define HID_POWER_TEST_QUICK 0x01 |
Write value. Quck test.
Definition at line 224 of file hid_usage_power.h.
| #define HID_POWER_TEST_DEEP 0x02 |
Write value. Deep test.
Definition at line 225 of file hid_usage_power.h.
| #define HID_POWER_TEST_ABORT 0x03 |
Write valie. Abort test.
Definition at line 226 of file hid_usage_power.h.
| #define HID_POWER_TEST_PASSED 0x01 |
Read value. Test done and passed.
Definition at line 227 of file hid_usage_power.h.
| #define HID_POWER_TEST_WARNED 0x02 |
Read value. Test done with warnings.
Definition at line 228 of file hid_usage_power.h.
| #define HID_POWER_TEST_ERROR 0x03 |
Read value. Test done with errors.
Definition at line 229 of file hid_usage_power.h.
| #define HID_POWER_TEST_ABORTED 0x04 |
Read value. Test aborted.
Definition at line 230 of file hid_usage_power.h.
| #define HID_POWER_TEST_INPROGRESS 0x05 |
Read value. Test in progress.
Definition at line 231 of file hid_usage_power.h.
| #define HID_POWER_TEST_NOT_INITIATED 0x06 |
Read value. No test inititted.
Definition at line 232 of file hid_usage_power.h.
| #define HID_POWER_RESET_NO 0x00 |
Read/Write value. No reset.
Definition at line 236 of file hid_usage_power.h.
| #define HID_POWER_RESET_MODULE 0x01 |
Read/Write value. Reset module.
Definition at line 237 of file hid_usage_power.h.
| #define HID_POWER_RESET_ALARMS 0x02 |
Read/Write value. Reset module's alarms.
Definition at line 238 of file hid_usage_power.h.
| #define HID_POWER_RESET_COUNTERS 0x03 |
Read/Write value. Reset module's counters.
Definition at line 239 of file hid_usage_power.h.
| #define HID_POWER_ALARM_DISABLED 0x00 |
Read/Write value. Audible alarm disabled.
Definition at line 244 of file hid_usage_power.h.
| #define HID_POWER_ALARM_ENABLED 0x01 |
Read/Write value. Audible alarm enabled.
Definition at line 245 of file hid_usage_power.h.
| #define HID_POWER_ALARM_MUTED 0x02 |
Read/Write value. Audible alarm muted.
Definition at line 246 of file hid_usage_power.h.
1.8.13