Skip to content

Commit 4e048e8

Browse files
added some more docs
1 parent 5fdf559 commit 4e048e8

2 files changed

Lines changed: 21 additions & 4 deletions

File tree

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,21 @@ void loop()
137137
# BlueMicro_HID API
138138

139139
The following API is available if the BlueMicro_HID library in included in a sketch file.
140-
141-
## bluemicro_hid.(...)
142-
140+
## Optional Setting & Parameters to set before Begin
141+
### bluemicro_hid.setBLEManufacturer("BLE_Manufacturer");
142+
### bluemicro_hid.setBLEModel("BLE_Model");
143+
### bluemicro_hid.setBLETxPower(4);
144+
### bluemicro_hid.setHIDMessageDelay(10);
145+
### bluemicro_hid.setUSBPollInterval(2);
146+
### bluemicro_hid.setUSBStringDescriptor("USB_Descriptor");
147+
## bluemicro_hid.begin();
148+
149+
## Sending buffers
150+
### bluemicro_hid.processQueues(CONNECTION_MODE_AUTO);
151+
152+
Available connection Modes:
153+
``` c++
154+
CONNECTION_MODE_AUTO
155+
CONNECTION_MODE_USB_ONLY
156+
CONNECTION_MODE_BLE_ONLY
157+
```

examples/API/USB_Settings/USB_Settings.ino

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,9 @@
5050
// the setup function runs once when you press reset or power the board
5151
void setup()
5252
{
53-
53+
bluemicro_hid.setHIDMessageDelay(10);
54+
bluemicro_hid.setUSBPollInterval(2);
55+
bluemicro_hid.setUSBStringDescriptor("USB_Descriptor");
5456
bluemicro_hid.begin();
5557

5658
// Set up button, pullup opposite to active state

0 commit comments

Comments
 (0)