Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.
Export as PDF

USB Settings (USB Only) - Property Subgroup 1.2.2.2.nn

Reduce Power During USB Suspend - Property 1.2.2.2.1.1

Property Description

Property OID

1.2.2.2.1.1 / 0x010202020101

Name

Reduce Power During USB Suspend

Description

The device uses this property to determine whether it should reduce its power consumption when a USB host directs it to suspend. If this property is set to Disabled, the device will not have a USB compliant current draw when suspended, which, for example, allows it to continue to turn on LEDs and the display if present.

To activate changes made to this property, the device must be reset or power cycled.

Securing Key

None

Min. Len (b)

1

Max. Len (b)

1

Data Type

Binary

Valid Values

0x00 = Disabled 0x01 = Enabled

Default

0x01

Reduce Power During USB Suspend - Get Request Example

Example (Hex)

AA00 8104 0155D101 840F D101 8501 01 8704 02020201 8902 C100

Reduce Power During USB Suspend - Get Response Example

Example (Hex)

AA0081048255D10182040000000084820010D1018501018704020202018903C10101

Reduce Power During USB Suspend - Set Request Example

Example (Hex)

AA00 81040155D111 8410 D111 850101 8704 02020201 8903 C10101

Reduce Power During USB Suspend - Set Response Example

Example (Hex)

AA0081048255D11182040000000084820010D1118501018704020202018903C10101

USB Configuration Type - Property 1.2.2.2.1.2

Property Description

Property OID

1.2.2.2.1.2 / 0x010202020102

Name

USB Configuration Type

Description

The device uses this property to determine if it should behave as a USB HID device or an USB iAP2 device. USB HID devices can communicate with most hosts except for Apple hosts. USB iAP2 devices can communicate to Apple hosts like iPads and iPhones. The behavior affects USB enumeration and communications.

To activate changes made to this property, the device must be reset or power cycled.

Securing Key

None

Min. Len (b)

1

Max. Len (b)

1

Data Type

Binary

Valid Values

0x00 = HID only 0x01 = iAP2 only

0x02 = autodetect (iAP2 with HID fallback)

The autodetect option can allow a device to work with iAP2 hosts and HID hosts. With this option, every time the device is attached to a USB host it will first enumerate as an iAP2 device, if the device does not receive an iAP2 initialization sequence response from the host within 2 seconds the device will perform a soft USB detach from the host and then a soft USB attach and next enumerate as a USB HID device.

Default

0x02

USB Configuration Type - Get Request Example

Example (Hex)

AA00 8104 0155D101 840F D101 8501 01 8704 02020201 8902 C200

USB Configuration Type - Get Response Example (HID only)

Example (Hex)

AA0081048255D10182040000000084820010D1018501018704020202018903C20100

USB Configuration Type - Set Request Example (HID only)

Example (Hex)

AA00 81040155D111 8410 D111 850101 8704 02020201 8903 C20100

USB Configuration Type - Set Response Example (HID only)

Example (Hex)

AA0081048255D11182040000000084820010D1118501018704020202018903C20100

USB Configuration Type - Set Request Example (iAP2 only)

Example (Hex)

AA00 81040155D111 8410 D111 850101 8704 02020201 8903 C20101

USB Configuration Type - Set Response Example (iAP2 only)

Example (Hex)

AA0081048255D11182040000000084820010D1118501018704020202018903C20101

USB Configuration Type - Set Request Example (autodetect (iAP2 with HID fallback))

Example (Hex)

AA00 81040155D111 8410 D111 850101 8704 02020201 8903 C20102

USB Configuration Type - Set Response Example (autodetect (iAP2 with HID fallback))

Example (Hex)

AA0081048255D11182040000000084820010D1118501018704020202018903C20102

Battery Charging Mode - Property 1.2.2.2.1.3

Property Description

Property OID

1.2.2.2.1.3 / 0x010202020103

Name

Battery Charging Mode

Description

The device uses this property to determine if it should charge continuously, or run off the battery only [even if it is plugged into a USB power source], or if it should dynamically run off the battery until it reaches a configurable low level before charging to a configurable high level, then run off the battery again (repeating this cycled indefinitely).

Securing Key

None

Min. Len (b)

1

Max. Len (b)

1

Data Type

Binary

Valid Values

0x00 = NORMAL_BATTERY_CHARGING

0x01 = DYNAMIC_BATTERY_CHARGING

When the device is in NORMAL_BATTERY_CHARGING mode it charges continuously until full, if it is connected to a dedicated charger or a USB host device like a tablet.

When the device is VBUS_BATTERY_DYNAMIC_CHARGING mode the device will run off the battery only until it reaches the battery charge percentage defined in Property 1.2.2.2.1.4 Battery Charging Start Level, then it will charge until it reaches the battery charge percentage defined in Property 1.2.2.2.1.5 Battery Charging Stop Level. In this mode it will repeat this cycle repeatedly. However, if the device is connected to dedicated charger, it will charge until full and not run off the battery unless the charger is disconnected.

The Property 1.2.2.2.1.6 Battery Charging Schedule feature can optionally be enabled while in DYNAMIC_BATTERY_CHARGING mode. When ON-DUTY the charging behavior is as described above When OFF-DUTY it will charge until full and not run off the battery until ON-DUTY.

Default

0x00 NORMAL_BATTERY_CHARGING

Battery Charging Mode - Get Request Example

Example (Hex)

AA00 8104 0155D101 840F D101 8501 01 8704 02020201 8902 C300

Battery Charging Mode - Get Response Example

Example (Hex)

AA0081048255D10182040000000084820010D1018501018704020202018903C30101

Battery Charging Mode - Set Request Example

Example (Hex)

AA0081040155D1118410D111 8501 01 8704 02020201 8903 C301 01

Battery Charging Mode - Set Response Example

Example (Hex)

AA0081048255D11182040000000084820010D1118501018704020202018903C30101

Battery Charging Start Level - Property 1.2.2.2.1.4

Property Description

Property OID

1.2.2.2.1.4 / 0x010202020104

Name

Battery Charging Start Level

Description

The device uses this property to determine the lowest charge percentage level the battery must reach, before the device starts charging the battery. This forces the device to run off the battery as much as possible, only charging when necessary.

To activate this property, NORMAL_BATTERY_CHARGING described in Property 1.2.2.2.1.3 Battery Charging Mode must be enabled first.

Securing Key

None

Min. Len (b)

1

Max. Len (b)

1

Data Type

Binary

Valid Values

Range 0x0A – 0x63

0x0A = Minimum value (10%) 0x63 = Maximum value (99%)*

*The maximum value must be less than the value set in Property 1.2.2.2.1.5 Battery Charging Stop Level

Default

0x19 (25%)

Battery Charging Start Level - Get Request Example

Example (Hex)

AA00 8104 0155D101 840F D101 8501 01 8704 02020201 8902 C400

Battery Charging Start Level - Get Response Example

Example (Hex)

AA0081048255D10182040000000084820010D1018501018704020202018903C4015A

Battery Charging Start Level - Set Request Example

Example (Hex)

AA0081040155D1118410D111 8501 01 8704 02020201 8903 C401 1E

Battery Charging Start Level - Set Response Example

Example (Hex)

AA0081048255D11182040000000084820010D1118501018704020202018903C4011E

Battery Charging Stop Level - Property 1.2.2.2.1.5

Property Description

Property OID

1.2.2.2.1.5 / 0x010202020105

Name

Battery Charging Stop Level

Description

The device uses this property to determine the highest charge percentage level the battery must reach, before the device stops charging the battery. This forces the device to run off the battery as much as possible and only charge when necessary.

To activate this property, NORMAL_BATTERY_CHARGING described in Property 1.2.2.2.1.3 Battery Charging Mode must be enabled first.

Securing Key

None

Min. Len (b)

1

Max. Len (b)

1

Data Type

Binary

Valid Values

Range 0x0B – 0x64

0x0B = Minimum value (11%) 0x64 = Maximum value (100%)*

*The minimum value must be greater than the value set in Property 1.2.2.2.1.4 Battery Charging Start Level

Default

0x64 (100%)

Battery Charging Stop Level - Get Request Example

Example (Hex)

AA00 8104 0155D101 840F D101 8501 01 8704 02020201 8902 C500

Battery Charging Stop Level - Get Response Example

Example (Hex)

AA0081048255D10182040000000084820010D1018501018704020202018903C5015F

Battery Charging Stop Level - Set Request Example

Example (Hex)

AA0081040155D1118410D111 8501 01 8704 02020201 8903 C501 5A

Battery Charging Stop Level - Set Response Example

Example (Hex)

AA0081048255D11182040000000084820010D1118501018704020202018903C5015A

Battery Charging Schedule - Property 1.2.2.2.1.6

Property Description

Property OID

1.2.2.2.1.6 / 0x010202020106

Name

Battery Charging Schedule

Description

The device uses this property to define on-duty hours. It consists of an on-duty starting time and on-duty duration. When on-duty the battery charging behavior matches the DYNAMIC_BATTERY_CHARGING described in Property 1.2.2.2.1.3 Battery Charging Mode. While off-duty the battery charging behavior is the same except it will charge to 100%, instead of the stop level set in Property 1.2.2.2.1.5 Battery Charging Stop Level. NOTE: The battery charging schedule is an optional feature of DYNAMIC_BATTERY_CHARGING.

The battery charging schedule is disabled by default. After enabling it, the charging mode must also be set to DYNAMIC_BATTERY_CHARGING described in Property 1.2.2.2.1.3 Battery Charging Mode. When disabled, the dynamic battery charging behavior does not take into account of on-duty or off-duty times, instead it charges according to the charging start and stop level properties only.

Securing Key

None

Min. Len (b)

5

Max. Len (b)

5

Data Type

Binary

Valid Values

Example Setting: 00 08 00 0C 00

0x00 = Charge Schedule Enable (0x00 disable, 0x01 enable) 0x08 = Start Hour 00 – 23 (value range 0x00 – 0x17)

0x00 = Start Minute 00 – 59 (value range 0x00 – 0x3B) 0x0C = Duration Hour 00 – 23 (value range 0x00 – 0x17) 0x00 = Duration Minute 00 – 59 (value range 0x00 – 0x3B)

The Battery Charging Schedule determines when the goes ON-DUTY and OFF_DUTY. The start hour and minute are used to determine the start of ON-DUTY. The device will remain On-DUTY until the duration hour and minute expires. Then it will go OFF- DUTY.

Default

00 08 00 0C 00

0x00 = Charge Schedule disabled 0x08 = Start Hour 08:00

0x00 = Start Minute 00 0x0C = Duration Hour 12 0x00 = Duration Minute 0

ON-DUTY starts at 08:00 and lasts for 12 hours 0 minutes

Battery Charging Schedule - Get Request Example

Example (Hex)

AA00 8104 0155D101 840F D101 8501 01 8704 02020201 8902 C600

Battery Charging Schedule - Get Response Example

Example (Hex)

AA0081048255D10182040000000084820014D1018501018704020202018907C6050106090406

Battery Charging Schedule - Set Request Example

Example (Hex)

AA0081040155D111 8414 D111 8501 01 8704 02020201 8907 C605 01 08 1E 0C 00

Battery Charging Schedule - Set Response Example

Example (Hex)

AA0081048255D11182040000000084820014D1118501018704020202018907C60501081E0C00

Last updated