Skip to content

Commit c76689e

Browse files
committed
fix: adjust bullet points
1 parent 6f57461 commit c76689e

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

packages/documentation/docs/for-developers/device-integrations/shared-hardware-control.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,18 +50,18 @@ Common use cases include:
5050
A few things need to be added to an existing integration to enable the Shared Hardware Control mechanism:
5151

5252
1. Adjust the `convertTimelineStateToDeviceState` to output Address States
53-
   * Part of this step is to make a design choice in the granularity of your Address States
54-
   * The addresses you return for each Address State must be unique to that Address State and you must be able to connect them with updates you receive from the device
55-
   \* The Address State must include the values you want to use to establish when control should be reasserted
53+
   - Part of this step is to make a design choice in the granularity of your Address States
54+
   - The addresses you return for each Address State must be unique to that Address State and you must be able to connect them with updates you receive from the device
55+
   - The Address State must include the values you want to use to establish when control should be reasserted
5656
2. Process updates from the external device
57-
   * After receiving an update from a device it has to converted into Address States and Addresses
58-
   * Call `this.context.setAddressState` for each updated Address State
57+
   - After receiving an update from a device it has to converted into Address States and Addresses
58+
   - Call `this.context.setAddressState` for each updated Address State
5959
3. Implement `addressStateReassertsControl` method
60-
   \* Your implementation will be given an old address state and a new one, it is up to you to tell the TSR whether this change in address state implies that control should be reasserted.
60+
   - Your implementation will be given an old address state and a new one, it is up to you to tell the TSR whether this change in address state implies that control should be reasserted.
6161
4. Implement `diffAddressStates` method
62-
   \* Your implementaiton must be able to take in 2 Address States and return a boolean value `true` if the 2 Address States are different and `false` if they are equivalent.
62+
   - Your implementaiton must be able to take in 2 Address States and return a boolean value `true` if the 2 Address States are different and `false` if they are equivalent.
6363
5. Implement `applyAddressState` method
64-
   \* In this method you should copy the contents from an Address State onto the Device State output of your `convertTimelineStateToDeviceState` implementation
64+
   - In this method you should copy the contents from an Address State onto the Device State output of your `convertTimelineStateToDeviceState` implementation
6565

6666
## Notes
6767

0 commit comments

Comments
 (0)