summaryrefslogtreecommitdiff
path: root/hid/lib/drivers/keyboard.h
blob: 1128def9cb977adcbc5babe6b9f90a89a42c07c5 (plain)
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
/*****************************************************************************
#                                                                            #
#    KVMD - The main PiKVM daemon.                                           #
#                                                                            #
#    Copyright (C) 2018-2023  Maxim Devaev <[email protected]>               #
#                                                                            #
#    This program is free software: you can redistribute it and/or modify    #
#    it under the terms of the GNU General Public License as published by    #
#    the Free Software Foundation, either version 3 of the License, or       #
#    (at your option) any later version.                                     #
#                                                                            #
#    This program is distributed in the hope that it will be useful,         #
#    but WITHOUT ANY WARRANTY; without even the implied warranty of          #
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the           #
#    GNU General Public License for more details.                            #
#                                                                            #
#    You should have received a copy of the GNU General Public License       #
#    along with this program.  If not, see <https://www.gnu.org/licenses/>.  #
#                                                                            #
*****************************************************************************/


#pragma once

#include <stdint.h>

#include "driver.h"


namespace DRIVERS {
	typedef struct {
		bool caps;
		bool scroll;
		bool num;
	} KeyboardLedsState;

	struct Keyboard : public Driver {
		using Driver::Driver;
		
		virtual void begin() {}
	
		/**
		* Release all keys
		*/
		virtual void clear() {}
	
		/**
		* Sends key
		* @param code ???
		* @param state true pressed, false released
		*/
		virtual void sendKey(uint8_t code, bool state) {}
	
		virtual void periodic() {}
	
		/**
		* False if online or unknown. Otherwise true.
		*/
		virtual bool isOffline() {
			return false;
		}
	
		virtual KeyboardLedsState getLeds() {
			KeyboardLedsState result = {0};
			return result;
		}
	};
}