You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: readme.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -145,7 +145,7 @@ The library consists of five classes with the following functions:
145
145
*`start_advertising()` (Starts Bluetooth advertisement)
146
146
*`stop_advertising()` (Stops Bluetooth advertisement)
147
147
*`is_running()` (Returns `True` if services are running, otherwise `False`)
148
-
*`is_connected()` (Returns `True` if a central is connected, otherwise `False`)
148
+
*`is_connected()` (Returns `True` if a client is connected, otherwise `False`)
149
149
*`is_advertising()` (Returns `True` if advertising, otherwise `False`)
150
150
*`set_state(state)` (Sets one of the `HumanInterfaceDevice` constants `DEVICE_STOPPED`, `DEVICE_IDLE`, `DEVICE_ADVERTISING`, or `DEVICE_CONNECTED`. Doesn't change the actual function. Used internally)
151
151
*`get_state()` (Returns one of the `HumanInterfaceDevice` constants `DEVICE_STOPPED`, `DEVICE_IDLE`, `DEVICE_ADVERTISING`, or `DEVICE_CONNECTED`)
@@ -164,22 +164,22 @@ The library consists of five classes with the following functions:
164
164
*`set_passkey(passkey)` (Set the passkey to use for pairing)
165
165
*`set_keystore(keystore)` (Sets the key store to use from `hid_keystores.py`. Default `JSONKeyStore`)
166
166
*`set_battery_level(level)` (Sets the battery level internally)
167
-
*`notify_battery_level()` (Notifies the central of the current battery level. Call after setting battery level)
167
+
*`notify_battery_level()` (Notifies the client of the current battery level. Call after setting battery level)
168
168
*`notify_hid_report()` (Function for subclasses to override)
169
169
170
170
*`Joystick` (subclass of `HumanInterfaceDevice`, implements joystick service)
171
171
*`__init__(name)` (Initialize the joystick)
172
172
*`start()` (Starts the HID service using joystick characteristics. Calls `HumanInterfaceDevice.start()`)
173
173
*`write_service_characteristics(handles)` (Writes the joystick HID service characteristics. Calls `HumanInterfaceDevice.write_service_characteristics(handles)`)
174
-
*`notify_hid_report()` (Notifies the central of the internal HID joystick status)
174
+
*`notify_hid_report()` (Notifies the client of the internal HID joystick status)
175
175
*`set_axes(x, y)` (Sets the joystick axes internally)
*`Mouse` (subclass of `HumanInterfaceDevice`, implements mouse service)
179
179
*`__init__(name)` (Initialize the mouse)
180
180
*`start()` (Starts the HID service using mouse characteristics. Calls `HumanInterfaceDevice.start()`)
181
181
*`write_service_characteristics(handles)` (Writes the mouse HID service characteristics. Calls `HumanInterfaceDevice.write_service_characteristics(handles)`)
182
-
*`notify_hid_report()` (Notifies the central of the internal HID mouse status)
182
+
*`notify_hid_report()` (Notifies the client of the internal HID mouse status)
183
183
*`set_axes(x, y)` (Sets the mouse axes movement internally)
184
184
*`set_wheel(w)` (Sets the mouse wheel movement internally)
185
185
*`set_buttons(b1, b2, b3)` (Sets the mouse buttons internally)
@@ -188,7 +188,7 @@ The library consists of five classes with the following functions:
188
188
*`__init__(name)` (Initialize the keyboard)
189
189
*`start()` (Starts the HID service using keyboard characteristics. Calls `HumanInterfaceDevice.start()`)
190
190
*`write_service_characteristics(handles)` (Writes the keyboard HID service characteristics. Calls `HumanInterfaceDevice.write_service_characteristics(handles)`)
191
-
*`notify_hid_report()` (Notifies the central of the internal HID keyboard status)
191
+
*`notify_hid_report()` (Notifies the client of the internal HID keyboard status)
0 commit comments