1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
// originally: https://github.com/T-vK/ESP32-BLE-Keyboard
#![allow(dead_code)]
use esp32_nimble::{
BLEAdvertisementData, BLECharacteristic, BLEDevice, BLEHIDDevice, BLEServer, enums::*, hid::*,
utilities::mutex::Mutex,
};
use std::sync::Arc;
use zerocopy::IntoBytes;
use zerocopy_derive::{Immutable, IntoBytes};
const KEYBOARD_ID: u8 = 0x01;
const MEDIA_KEYS_ID: u8 = 0x02;
const HID_REPORT_DISCRIPTOR: &[u8] = hid!(
(USAGE_PAGE, 0x01), // USAGE_PAGE (Generic Desktop Ctrls)
(USAGE, 0x06), // USAGE (Keyboard)
(COLLECTION, 0x01), // COLLECTION (Application)
// ------------------------------------------------- Keyboard
(REPORT_ID, KEYBOARD_ID), // REPORT_ID (1)
(USAGE_PAGE, 0x07), // USAGE_PAGE (Kbrd/Keypad)
(USAGE_MINIMUM, 0xE0), // USAGE_MINIMUM (0xE0)
(USAGE_MAXIMUM, 0xE7), // USAGE_MAXIMUM (0xE7)
(LOGICAL_MINIMUM, 0x00), // LOGICAL_MINIMUM (0)
(LOGICAL_MAXIMUM, 0x01), // Logical Maximum (1)
(REPORT_SIZE, 0x01), // REPORT_SIZE (1)
(REPORT_COUNT, 0x08), // REPORT_COUNT (8)
(HIDINPUT, 0x02), // INPUT (Data,Var,Abs,No Wrap,Linear,Preferred State,No Null Position)
(REPORT_COUNT, 0x01), // REPORT_COUNT (1) ; 1 byte (Reserved)
(REPORT_SIZE, 0x08), // REPORT_SIZE (8)
(HIDINPUT, 0x01), // INPUT (Const,Array,Abs,No Wrap,Linear,Preferred State,No Null Position)
(REPORT_COUNT, 0x05), // REPORT_COUNT (5) ; 5 bits (Num lock, Caps lock, Scroll lock, Compose, Kana)
(REPORT_SIZE, 0x01), // REPORT_SIZE (1)
(USAGE_PAGE, 0x08), // USAGE_PAGE (LEDs)
(USAGE_MINIMUM, 0x01), // USAGE_MINIMUM (0x01) ; Num Lock
(USAGE_MAXIMUM, 0x05), // USAGE_MAXIMUM (0x05) ; Kana
(HIDOUTPUT, 0x02), // OUTPUT (Data,Var,Abs,No Wrap,Linear,Preferred State,No Null Position,Non-volatile)
(REPORT_COUNT, 0x01), // REPORT_COUNT (1) ; 3 bits (Padding)
(REPORT_SIZE, 0x03), // REPORT_SIZE (3)
(HIDOUTPUT, 0x01), // OUTPUT (Const,Array,Abs,No Wrap,Linear,Preferred State,No Null Position,Non-volatile)
(REPORT_COUNT, 0x06), // REPORT_COUNT (6) ; 6 bytes (Keys)
(REPORT_SIZE, 0x08), // REPORT_SIZE(8)
(LOGICAL_MINIMUM, 0x00), // LOGICAL_MINIMUM(0)
(LOGICAL_MAXIMUM, 0x65), // LOGICAL_MAXIMUM(0x65) ; 101 keys
(USAGE_PAGE, 0x07), // USAGE_PAGE (Kbrd/Keypad)
(USAGE_MINIMUM, 0x00), // USAGE_MINIMUM (0)
(USAGE_MAXIMUM, 0x65), // USAGE_MAXIMUM (0x65)
(HIDINPUT, 0x00), // INPUT (Data,Array,Abs,No Wrap,Linear,Preferred State,No Null Position)
(END_COLLECTION), // END_COLLECTION
// ------------------------------------------------- Media Keys
(USAGE_PAGE, 0x0C), // USAGE_PAGE (Consumer)
(USAGE, 0x01), // USAGE (Consumer Control)
(COLLECTION, 0x01), // COLLECTION (Application)
(REPORT_ID, MEDIA_KEYS_ID), // REPORT_ID (3)
(USAGE_PAGE, 0x0C), // USAGE_PAGE (Consumer)
(LOGICAL_MINIMUM, 0x00), // LOGICAL_MINIMUM (0)
(LOGICAL_MAXIMUM, 0x01), // LOGICAL_MAXIMUM (1)
(REPORT_SIZE, 0x01), // REPORT_SIZE (1)
(REPORT_COUNT, 0x10), // REPORT_COUNT (16)
(USAGE, 0xB5), // USAGE (Scan Next Track) ; bit 0: 1
(USAGE, 0xB6), // USAGE (Scan Previous Track) ; bit 1: 2
(USAGE, 0xB7), // USAGE (Stop) ; bit 2: 4
(USAGE, 0xCD), // USAGE (Play/Pause) ; bit 3: 8
(USAGE, 0xE2), // USAGE (Mute) ; bit 4: 16
(USAGE, 0xE9), // USAGE (Volume Increment) ; bit 5: 32
(USAGE, 0xEA), // USAGE (Volume Decrement) ; bit 6: 64
(USAGE, 0x23, 0x02), // Usage (WWW Home) ; bit 7: 128
(USAGE, 0x94, 0x01), // Usage (My Computer) ; bit 0: 1
(USAGE, 0x92, 0x01), // Usage (Calculator) ; bit 1: 2
(USAGE, 0x2A, 0x02), // Usage (WWW fav) ; bit 2: 4
(USAGE, 0x21, 0x02), // Usage (WWW search) ; bit 3: 8
(USAGE, 0x26, 0x02), // Usage (WWW stop) ; bit 4: 16
(USAGE, 0x24, 0x02), // Usage (WWW back) ; bit 5: 32
(USAGE, 0x83, 0x01), // Usage (Media sel) ; bit 6: 64
(USAGE, 0x8A, 0x01), // Usage (Mail) ; bit 7: 128
(HIDINPUT, 0x02), // INPUT (Data,Var,Abs,No Wrap,Linear,Preferred State,No Null Position)
(END_COLLECTION), // END_COLLECTION
);
const SHIFT: u8 = 0x80;
const ASCII_MAP: &[u8] = &[
0x00, // NUL
0x00, // SOH
0x00, // STX
0x00, // ETX
0x00, // EOT
0x00, // ENQ
0x00, // ACK
0x00, // BEL
0x2a, // BS Backspace
0x2b, // TAB Tab
0x28, // LF Enter
0x00, // VT
0x00, // FF
0x00, // CR
0x00, // SO
0x00, // SI
0x00, // DEL
0x00, // DC1
0x00, // DC2
0x00, // DC3
0x00, // DC4
0x00, // NAK
0x00, // SYN
0x00, // ETB
0x00, // CAN
0x00, // EM
0x00, // SUB
0x00, // ESC
0x00, // FS
0x00, // GS
0x00, // RS
0x00, // US
0x2c, // ' '
0x1e | SHIFT, // !
0x34 | SHIFT, // "
0x20 | SHIFT, // #
0x21 | SHIFT, // $
0x22 | SHIFT, // %
0x24 | SHIFT, // &
0x34, // '
0x26 | SHIFT, // (
0x27 | SHIFT, // )
0x25 | SHIFT, // *
0x2e | SHIFT, // +
0x36, // ,
0x2d, // -
0x37, // .
0x38, // /
0x27, // 0
0x1e, // 1
0x1f, // 2
0x20, // 3
0x21, // 4
0x22, // 5
0x23, // 6
0x24, // 7
0x25, // 8
0x26, // 9
0x33 | SHIFT, // :
0x33, // ;
0x36 | SHIFT, // <
0x2e, // =
0x37 | SHIFT, // >
0x38 | SHIFT, // ?
0x1f | SHIFT, // @
0x04 | SHIFT, // A
0x05 | SHIFT, // B
0x06 | SHIFT, // C
0x07 | SHIFT, // D
0x08 | SHIFT, // E
0x09 | SHIFT, // F
0x0a | SHIFT, // G
0x0b | SHIFT, // H
0x0c | SHIFT, // I
0x0d | SHIFT, // J
0x0e | SHIFT, // K
0x0f | SHIFT, // L
0x10 | SHIFT, // M
0x11 | SHIFT, // N
0x12 | SHIFT, // O
0x13 | SHIFT, // P
0x14 | SHIFT, // Q
0x15 | SHIFT, // R
0x16 | SHIFT, // S
0x17 | SHIFT, // T
0x18 | SHIFT, // U
0x19 | SHIFT, // V
0x1a | SHIFT, // W
0x1b | SHIFT, // X
0x1c | SHIFT, // Y
0x1d | SHIFT, // Z
0x2f, // [
0x31, // bslash
0x30, // ]
0x23 | SHIFT, // ^
0x2d | SHIFT, // _
0x35, // `
0x04, // a
0x05, // b
0x06, // c
0x07, // d
0x08, // e
0x09, // f
0x0a, // g
0x0b, // h
0x0c, // i
0x0d, // j
0x0e, // k
0x0f, // l
0x10, // m
0x11, // n
0x12, // o
0x13, // p
0x14, // q
0x15, // r
0x16, // s
0x17, // t
0x18, // u
0x19, // v
0x1a, // w
0x1b, // x
0x1c, // y
0x1d, // z
0x2f | SHIFT, // {
0x31 | SHIFT, // |
0x30 | SHIFT, // }
0x35 | SHIFT, // ~
0, // DEL
];
#[derive(IntoBytes, Immutable)]
#[repr(packed)]
struct KeyReport {
modifiers: u8,
reserved: u8,
keys: [u8; 6],
}
struct Keyboard {
server: &'static mut BLEServer,
input_keyboard: Arc<Mutex<BLECharacteristic>>,
output_keyboard: Arc<Mutex<BLECharacteristic>>,
input_media_keys: Arc<Mutex<BLECharacteristic>>,
key_report: KeyReport,
}
impl Keyboard {
fn new() -> anyhow::Result<Self> {
let device = BLEDevice::take();
device
.security()
.set_auth(AuthReq::all())
.set_io_cap(SecurityIOCap::NoInputNoOutput)
.resolve_rpa();
let server = device.get_server();
let mut hid = BLEHIDDevice::new(server);
let input_keyboard = hid.input_report(KEYBOARD_ID);
let output_keyboard = hid.output_report(KEYBOARD_ID);
let input_media_keys = hid.input_report(MEDIA_KEYS_ID);
hid.manufacturer("Espressif");
hid.pnp(0x02, 0x05ac, 0x820a, 0x0210);
hid.hid_info(0x00, 0x01);
hid.report_map(HID_REPORT_DISCRIPTOR);
hid.set_battery_level(100);
let ble_advertising = device.get_advertising();
ble_advertising.lock().scan_response(false).set_data(
BLEAdvertisementData::new()
.name("ESP32 Keyboard")
.appearance(0x03C1)
.add_service_uuid(hid.hid_service().lock().uuid()),
)?;
ble_advertising.lock().start()?;
Ok(Self {
server,
input_keyboard,
output_keyboard,
input_media_keys,
key_report: KeyReport {
modifiers: 0,
reserved: 0,
keys: [0; 6],
},
})
}
fn connected(&self) -> bool {
self.server.connected_count() > 0
}
fn write(&mut self, str: &str) {
for char in str.as_bytes() {
self.press(*char);
self.release();
}
}
fn press(&mut self, char: u8) {
let mut key = ASCII_MAP[char as usize];
if (key & SHIFT) > 0 {
self.key_report.modifiers |= 0x02;
key &= !SHIFT;
}
self.key_report.keys[0] = key;
self.send_report(&self.key_report);
}
fn release(&mut self) {
self.key_report.modifiers = 0;
self.key_report.keys.fill(0);
self.send_report(&self.key_report);
}
fn send_report(&self, keys: &KeyReport) {
self.input_keyboard
.lock()
.set_value(keys.as_bytes())
.notify();
esp_idf_svc::hal::delay::Ets::delay_ms(7);
}
}
fn main() -> anyhow::Result<()> {
esp_idf_svc::sys::link_patches();
esp_idf_svc::log::EspLogger::initialize_default();
let mut keyboard = Keyboard::new()?;
loop {
if keyboard.connected() {
::log::info!("Sending 'Hello world'...");
keyboard.write("Hello world\n");
}
esp_idf_svc::hal::delay::FreeRtos::delay_ms(5000);
}
}