esp-nimble-cpp / NimBLE-Arduino  1.3.1
NimBLEHIDDevice.h
1 /*
2  * NimBLEHIDDevice.h
3  *
4  * Created: on Oct 06 2020
5  * Author wakwak-koba
6  *
7  * Originally:
8  *
9  * BLEHIDDevice.h
10  *
11  * Created on: Jan 03, 2018
12  * Author: chegewara
13  */
14 
15 #ifndef _BLEHIDDEVICE_H_
16 #define _BLEHIDDEVICE_H_
17 
18 #include "sdkconfig.h"
19 #if defined(CONFIG_BT_ENABLED)
20 
21 #include "nimconfig.h"
22 #if defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER)
23 
24 #include "NimBLECharacteristic.h"
25 #include "NimBLEService.h"
26 #include "NimBLEDescriptor.h"
27 #include "HIDTypes.h"
28 
29 #define GENERIC_HID 0x03C0
30 #define HID_KEYBOARD 0x03C1
31 #define HID_MOUSE 0x03C2
32 #define HID_JOYSTICK 0x03C3
33 #define HID_GAMEPAD 0x03C4
34 #define HID_TABLET 0x03C5
35 #define HID_CARD_READER 0x03C6
36 #define HID_DIGITAL_PEN 0x03C7
37 #define HID_BARCODE 0x03C8
38 
39 
44 public:
46  virtual ~NimBLEHIDDevice();
47 
48  void reportMap(uint8_t* map, uint16_t);
49  void startServices();
50 
54 
56  void manufacturer(std::string name);
57  //NimBLECharacteristic* pnp();
58  void pnp(uint8_t sig, uint16_t vid, uint16_t pid, uint16_t version);
59  //NimBLECharacteristic* hidInfo();
60  void hidInfo(uint8_t country, uint8_t flags);
61  //NimBLECharacteristic* batteryLevel();
62  void setBatteryLevel(uint8_t level);
63 
64 
65  //NimBLECharacteristic* reportMap();
67  NimBLECharacteristic* inputReport(uint8_t reportID);
68  NimBLECharacteristic* outputReport(uint8_t reportID);
69  NimBLECharacteristic* featureReport(uint8_t reportID);
73 
74 private:
75  NimBLEService* m_deviceInfoService; //0x180a
76  NimBLEService* m_hidService; //0x1812
77  NimBLEService* m_batteryService = 0; //0x180f
78 
79  NimBLECharacteristic* m_manufacturerCharacteristic; //0x2a29
80  NimBLECharacteristic* m_pnpCharacteristic; //0x2a50
81  NimBLECharacteristic* m_hidInfoCharacteristic; //0x2a4a
82  NimBLECharacteristic* m_reportMapCharacteristic; //0x2a4b
83  NimBLECharacteristic* m_hidControlCharacteristic; //0x2a4c
84  NimBLECharacteristic* m_protocolModeCharacteristic; //0x2a4e
85  NimBLECharacteristic* m_batteryLevelCharacteristic; //0x2a19
86 };
87 #endif // CONFIG_BT_NIMBLE_ROLE_BROADCASTER
88 #endif // CONFIG_BT_ENABLED
89 #endif /* _BLEHIDDEVICE_H_ */
The model of a BLE Characteristic.
Definition: NimBLECharacteristic.h:60
A model of a BLE Human Interface Device.
Definition: NimBLEHIDDevice.h:43
NimBLEService * deviceInfo()
Returns a pointer to the device information service.
Definition: NimBLEHIDDevice.cpp:232
NimBLECharacteristic * protocolMode()
Returns a pointer to the protocol mode characteristic.
Definition: NimBLEHIDDevice.cpp:194
NimBLEService * batteryService()
Returns a pointer to the battery service.
Definition: NimBLEHIDDevice.cpp:246
void hidInfo(uint8_t country, uint8_t flags)
Sets the HID Information characteristic value.
Definition: NimBLEHIDDevice.cpp:120
NimBLECharacteristic * manufacturer()
Create a manufacturer characteristic (this characteristic is optional).
Definition: NimBLEHIDDevice.cpp:90
NimBLECharacteristic * bootInput()
Creates a keyboard boot input report characteristic.
Definition: NimBLEHIDDevice.cpp:173
NimBLECharacteristic * featureReport(uint8_t reportID)
Create feature report characteristic.
Definition: NimBLEHIDDevice.cpp:160
void pnp(uint8_t sig, uint16_t vid, uint16_t pid, uint16_t version)
Sets the Plug n Play characterisc value.
Definition: NimBLEHIDDevice.cpp:110
void startServices()
Start the HID device services. This function called when all the services have been created.
Definition: NimBLEHIDDevice.cpp:81
NimBLECharacteristic * hidControl()
Returns a pointer to the HID control point characteristic.
Definition: NimBLEHIDDevice.cpp:187
void reportMap(uint8_t *map, uint16_t)
Set the report map data formatting information.
Definition: NimBLEHIDDevice.cpp:73
void setBatteryLevel(uint8_t level)
Set the battery level characteristic value.
Definition: NimBLEHIDDevice.cpp:202
NimBLECharacteristic * inputReport(uint8_t reportID)
Create input report characteristic.
Definition: NimBLEHIDDevice.cpp:130
NimBLEHIDDevice(NimBLEServer *)
Construct a default NimBLEHIDDevice object.
Definition: NimBLEHIDDevice.cpp:27
NimBLECharacteristic * outputReport(uint8_t reportID)
Create output report characteristic.
Definition: NimBLEHIDDevice.cpp:145
NimBLECharacteristic * bootOutput()
Create a keyboard boot output report characteristic.
Definition: NimBLEHIDDevice.cpp:180
NimBLEService * hidService()
Returns a pointer to the HID service.
Definition: NimBLEHIDDevice.cpp:239
The model of a BLE server.
Definition: NimBLEServer.h:42
The model of a BLE service.
Definition: NimBLEService.h:36