├── .gitignore
├── include
    ├── Battery1004.hpp
    ├── Battery1000.hpp
    ├── WebsocketServer.hpp
    ├── Battery.hpp
    ├── LGSTrayHID_common.hpp
    ├── MapWrapper.hpp
    ├── HIDDevice.hpp
    ├── HIDPPMsg.hpp
    ├── Battery1001.hpp
    └── LogiDevice.hpp
├── src
    ├── CMakeProject1.h
    ├── LGSTrayHID_common.cpp
    ├── Battery1004.cpp
    ├── Battery1000.cpp
    ├── Battery1001.cpp
    ├── HIDPPMsg.cpp
    ├── MapWrapper.cpp
    ├── CMakeProject1.cpp
    ├── WebsocketServer.cpp
    ├── HIDDevice.cpp
    └── LogiDevice.cpp
├── external
    ├── nlohmann_json
    │   └── CMakeLists.txt
    ├── websocketpp
    │   └── CMakeLists.txt
    └── hidapi-win
    │   └── CMakeLists.txt
├── readme.md
├── CMakeLists.txt
├── CMakePresets.json
└── LICENSE


/.gitignore:
--------------------------------------------------------------------------------
1 | .vs/**
2 | .vscode/**
3 | out/**


--------------------------------------------------------------------------------
/include/Battery1004.hpp:
--------------------------------------------------------------------------------
1 | #pragma once
2 | 
3 | #include <tuple>
4 | #include "Battery.hpp"
5 | #include "HIDPPMsg.hpp"
6 | 
7 | namespace LGSTrayHID {
8 | 	std::tuple<int, Battery::Power_supply_status> Battery1004_parse(const HIDPPMsg_20& msg);
9 | }


--------------------------------------------------------------------------------
/include/Battery1000.hpp:
--------------------------------------------------------------------------------
 1 | #pragma once
 2 | 
 3 | #include <tuple>
 4 | 
 5 | #include "HIDPPMsg.hpp"
 6 | #include "Battery.hpp"
 7 | 
 8 | namespace LGSTrayHID {
 9 | 	std::tuple<int, Battery::Power_supply_status> Battery1000_parse(const HIDPPMsg_20& msg);
10 | }


--------------------------------------------------------------------------------
/src/CMakeProject1.h:
--------------------------------------------------------------------------------
1 | // CMakeProject1.h : Include file for standard system include files,
2 | // or project specific include files.
3 | 
4 | #pragma once
5 | 
6 | #include <iostream>
7 | 
8 | // TODO: Reference additional headers your program requires here.
9 | 


--------------------------------------------------------------------------------
/external/nlohmann_json/CMakeLists.txt:
--------------------------------------------------------------------------------
1 | cmake_minimum_required (VERSION 3.14)
2 | 
3 | message("-- nlohmann_json")
4 | 
5 | FetchContent_Declare(json 
6 | 	URL https://github.com/nlohmann/json/releases/download/v3.11.2/json.tar.xz
7 | )
8 | 
9 | FetchContent_MakeAvailable(json)


--------------------------------------------------------------------------------
/include/WebsocketServer.hpp:
--------------------------------------------------------------------------------
 1 | #pragma once
 2 | 
 3 | #include <nlohmann/json.hpp>
 4 | 
 5 | namespace LGSTrayHID {
 6 | namespace WebsocketServer {
 7 | 	void init_and_serve(int port);
 8 | 	void notify_subscriptions(std::string path, nlohmann::json payload_json);
 9 | }
10 | }


--------------------------------------------------------------------------------
/include/Battery.hpp:
--------------------------------------------------------------------------------
 1 | #pragma once
 2 | 
 3 | namespace LGSTrayHID {
 4 | 	namespace Battery {
 5 | 		enum class Power_supply_status : uint8_t {
 6 | 			POWER_SUPPLY_STATUS_CHARGING,
 7 | 			POWER_SUPPLY_STATUS_FULL,
 8 | 			POWER_SUPPLY_STATUS_NOT_CHARGING,
 9 | 			POWER_SUPPLY_STATUS_DISCHARGING,
10 | 			POWER_SUPPLY_STATUS_UNKNOWN
11 | 		};
12 | 	}
13 | }


--------------------------------------------------------------------------------
/src/LGSTrayHID_common.cpp:
--------------------------------------------------------------------------------
 1 | #include "LGSTrayHID_common.hpp"
 2 | 
 3 | namespace LGSTrayHID {
 4 | 	size_t hidpp_enum_length(HIDPP_length hidpp_length) {
 5 | 		if (hidpp_length == HIDPP_SHORT) {
 6 | 			return HIDPP_SHORT_SIZE;
 7 | 		}
 8 | 		else if (hidpp_length == HIDPP_LONG) {
 9 | 			return HIDPP_LONG_SIZE;
10 | 		}
11 | 
12 | 		return -1;
13 | 	}
14 | }


--------------------------------------------------------------------------------
/include/LGSTrayHID_common.hpp:
--------------------------------------------------------------------------------
 1 | #pragma once
 2 | 
 3 | #include <cinttypes>
 4 | 
 5 | namespace LGSTrayHID {
 6 | 	enum HIDPP_length : uint8_t {
 7 | 		HIDPP_SHORT = 0x10,
 8 | 		HIDPP_LONG = 0x11
 9 | 	};
10 | 
11 | 	constexpr uint8_t SW_ID = 0X0A;
12 | 
13 | 	constexpr uint8_t HIDPP_SHORT_SIZE = 7;
14 | 	constexpr uint8_t HIDPP_LONG_SIZE = 20;
15 | 
16 | 	size_t hidpp_enum_length(HIDPP_length hidpp_length);
17 | }


--------------------------------------------------------------------------------
/include/MapWrapper.hpp:
--------------------------------------------------------------------------------
 1 | #pragma once
 2 | 
 3 | #include <memory>
 4 | #include <unordered_map>
 5 | 
 6 | #include <nlohmann/json.hpp>
 7 | 
 8 | #include "LogiDevice.hpp"
 9 | 
10 | namespace LGSTrayHID {
11 | 	namespace MapWrapper {
12 | 		typedef std::string KeyType;
13 | 		void add_LogiDevice(KeyType key, const std::shared_ptr<LogiDevice>& logiDevice);
14 | 
15 | 		nlohmann::json to_json();
16 | 		nlohmann::json get_battery_summary(KeyType key);
17 | 
18 | 		void clear_map();
19 | 	}
20 | }


--------------------------------------------------------------------------------
/readme.md:
--------------------------------------------------------------------------------
 1 | # HID++ Battery Monitor
 2 | Logitech HID++ device battery monitor for use with [LGSTrayBattery](https://github.com/andyvorld/LGSTrayBattery).
 3 | 
 4 | ## Features
 5 | The program replicates a small subset of the Logitech GHUB's websocket API, utilizing a json payload system.
 6 | 
 7 | Example payload,
 8 | ```
 9 | {
10 |     "msgId": "1234-5678-90",
11 |     "origin": "backend",
12 |     "verb": "GET",
13 |     "path", "/devices/list"
14 | }
15 | ```
16 | 
17 | ## Build Instructions
18 | Boost 1.79.0+ required to be built and installed.
19 | 
20 | Other pre-requisites will be downloaded as part of the CMake configuration step.
21 | 
22 | Built with Visual Studio 2022, native CMake project.


--------------------------------------------------------------------------------
/src/Battery1004.cpp:
--------------------------------------------------------------------------------
 1 | #include "Battery1004.hpp"
 2 | 
 3 | namespace LGSTrayHID {
 4 | 	using namespace Battery;
 5 | 
 6 | 	std::tuple<int, Power_supply_status> Battery1004_parse(const HIDPPMsg_20& msg) {
 7 | 		using enum Power_supply_status;
 8 | 
 9 | 		int capacity = msg.get_result_data()[0];
10 | 		Power_supply_status status = POWER_SUPPLY_STATUS_UNKNOWN;
11 | 
12 | 		switch (msg.get_result_data()[2]) {
13 | 		case 0: /* discharging */
14 | 			status = POWER_SUPPLY_STATUS_DISCHARGING;
15 | 			break;
16 | 		case 1: /* charging */
17 | 		case 2: /* charging slow */
18 | 			status = POWER_SUPPLY_STATUS_CHARGING;
19 | 			break;
20 | 		case 3: /* complete */
21 | 			status = POWER_SUPPLY_STATUS_FULL;
22 | 			break;
23 | 		default:
24 | 			status = POWER_SUPPLY_STATUS_NOT_CHARGING;
25 | 			break;
26 | 		}
27 | 
28 | 		return { capacity, status };
29 | 	}
30 | }


--------------------------------------------------------------------------------
/include/HIDDevice.hpp:
--------------------------------------------------------------------------------
 1 | #pragma once
 2 | 
 3 | #include <hidapi.h>
 4 | 
 5 | #include <memory>
 6 | #include <thread>
 7 | #include <unordered_map>
 8 | #include "LogiDevice.hpp"
 9 | 
10 | namespace LGSTrayHID {
11 | 	class HIDDevice {
12 | 	private:
13 | 		std::atomic_bool cancellationToken = false;
14 | 
15 | 		std::shared_ptr<hid_device> _short_dev = NULL;
16 | 		std::shared_ptr<hid_device> _long_dev = NULL;
17 | 
18 | 		std::unique_ptr<std::thread> _short_reader = NULL;
19 | 		std::unique_ptr<std::thread> _long_reader = NULL;
20 | 
21 | 		void _check_if_ready();
22 | 	public:
23 | 		std::mutex devices_map_mutex;
24 | 		std::unordered_map<int, std::shared_ptr<LogiDevice>> devices;
25 | 		const std::string container_name;
26 | 
27 | 		HIDDevice(std::string container_name);
28 | 		~HIDDevice();
29 | 
30 | 		void assign_short(std::shared_ptr<hid_device> short_dev);
31 | 		void assign_long(std::shared_ptr<hid_device> short_dev);
32 | 	};
33 | }


--------------------------------------------------------------------------------
/include/HIDPPMsg.hpp:
--------------------------------------------------------------------------------
 1 | #pragma once
 2 | 
 3 | #include <memory>
 4 | #include <hidapi.h>
 5 | #include "LGSTrayHID_common.hpp"
 6 | 
 7 | namespace LGSTrayHID {
 8 | 	class HIDPPMsg {
 9 | 	protected:
10 | 		std::unique_ptr<uint8_t[]> _buffer;
11 | 	public:
12 | 		HIDPPMsg(HIDPP_length hidpp_length);
13 | 		HIDPPMsg(std::unique_ptr<uint8_t[]> buffer);
14 | 		~HIDPPMsg();
15 | 
16 | 		uint8_t* data();
17 | 		std::unique_ptr<uint8_t[]> move_ptr();
18 | 
19 | 		HIDPP_length get_length();
20 | 		uint8_t get_device_idx();
21 | 
22 | 		const uint8_t* get_result_data() const;
23 | 	};
24 | 
25 | 	class HIDPPMsg_10 : public HIDPPMsg {
26 | 	public:
27 | 		using HIDPPMsg::HIDPPMsg;
28 | 		uint8_t get_sub_id();
29 | 		uint8_t get_address();
30 | 	};
31 | 
32 | 	class HIDPPMsg_20 : public HIDPPMsg {
33 | 	public:
34 | 		using HIDPPMsg::HIDPPMsg;
35 | 		uint8_t get_feature_index();
36 | 		uint8_t get_function_id();
37 | 		uint8_t get_sw_id();
38 | 	};
39 | }


--------------------------------------------------------------------------------
/external/websocketpp/CMakeLists.txt:
--------------------------------------------------------------------------------
 1 | cmake_minimum_required (VERSION 3.14)
 2 | 
 3 | message("-- websocketpp")
 4 | 
 5 | set(Boost_USE_STATIC_LIBS ON) 
 6 | set(Boost_USE_MULTITHREADED ON)  
 7 | set(Boost_USE_STATIC_RUNTIME OFF) 
 8 | find_package(Boost 1.79.0 REQUIRED COMPONENTS filesystem system thread regex)
 9 | 
10 | include(FetchContent)
11 | FetchContent_Declare(
12 |   websocketpp
13 |   URL https://github.com/zaphoyd/websocketpp/archive/refs/tags/0.8.2.zip
14 | )
15 | 
16 | FetchContent_GetProperties(websocketpp)
17 | if(NOT websocketpp_POPULATED)
18 | 	FetchContent_Populate(websocketpp)
19 | endif()
20 | 
21 | FetchContent_GetProperties(websocketpp)
22 | if(NOT websocketpp_POPULATED)
23 |   FetchContent_Populate(websocketpp)
24 |   add_subdirectory(${websocketpp_SOURCE_DIR} ${websocketpp_BINARY_DIR} EXCLUDE_FROM_ALL)
25 | endif()
26 | 
27 | add_library(websocketpp INTERFACE)
28 | target_include_directories(websocketpp INTERFACE ${websocketpp_SOURCE_DIR})
29 | target_link_libraries(websocketpp INTERFACE Boost::system Boost::thread Boost::regex)


--------------------------------------------------------------------------------
/external/hidapi-win/CMakeLists.txt:
--------------------------------------------------------------------------------
 1 | cmake_minimum_required (VERSION 3.14)
 2 | 
 3 | message("-- hidapi-win")
 4 | 
 5 | include(FetchContent)
 6 | FetchContent_Declare(
 7 |   hidapi_win
 8 |   URL https://github.com/libusb/hidapi/releases/download/hidapi-0.12.0/hidapi-win.zip
 9 | )
10 | 
11 | FetchContent_GetProperties(hidapi_win)
12 | if(NOT hidapi_win_POPULATED)
13 | 	FetchContent_Populate(hidapi_win)
14 | endif()
15 | 
16 | if(!MSVC)
17 | message(FATAL_ERROR "Toolchain not setup for non MSVC builds")
18 | endif()
19 | 
20 | if(CMAKE_SIZEOF_VOID_P GREATER 4)
21 | 	message("    x64 hidapi")
22 | 	set(hidapi_win_LIB_DIR "${hidapi_win_SOURCE_DIR}/x64")
23 | else()
24 | 	message("    x86 hidapi")
25 | 	set(hidapi_win_LIB_DIR "${hidapi_win_SOURCE_DIR}/x86")
26 | endif()
27 | 
28 | add_library(hidapi_win INTERFACE)
29 | target_include_directories(hidapi_win INTERFACE "${hidapi_win_SOURCE_DIR}/include/")
30 | target_link_libraries(hidapi_win INTERFACE "${hidapi_win_LIB_DIR}/hidapi.lib")
31 | file(COPY "${hidapi_win_LIB_DIR}/hidapi.dll" DESTINATION ${CMAKE_BINARY_DIR})


--------------------------------------------------------------------------------
/src/Battery1000.cpp:
--------------------------------------------------------------------------------
 1 | #include "Battery1000.hpp"
 2 | 
 3 | namespace LGSTrayHID {
 4 | 	using namespace Battery;
 5 | 
 6 | 	std::tuple<int, Power_supply_status> LGSTrayHID::Battery1000_parse(const HIDPPMsg_20& msg) {
 7 | 		using enum Power_supply_status;
 8 | 
 9 | 		int capacity = msg.get_result_data()[0];
10 | 		Power_supply_status status = POWER_SUPPLY_STATUS_UNKNOWN;
11 | 
12 | 		switch (msg.get_result_data()[2]) {
13 | 		case 0: /* discharging (in use) */
14 | 			status = POWER_SUPPLY_STATUS_DISCHARGING;
15 | 			break;
16 | 		case 1: /* recharging */
17 | 			status = POWER_SUPPLY_STATUS_CHARGING;
18 | 			break;
19 | 		case 2: /* charge in final stage */
20 | 			status = POWER_SUPPLY_STATUS_CHARGING;
21 | 			break;
22 | 		case 3: /* charge complete */
23 | 			status = POWER_SUPPLY_STATUS_FULL;
24 | 			break;
25 | 		case 4: /* recharging below optimal speed */
26 | 			status = POWER_SUPPLY_STATUS_CHARGING;
27 | 			break;
28 | 		default:
29 | 			status = POWER_SUPPLY_STATUS_NOT_CHARGING;
30 | 			break;
31 | 		}
32 | 
33 | 		return { capacity, status };
34 | 	}
35 | }


--------------------------------------------------------------------------------
/src/Battery1001.cpp:
--------------------------------------------------------------------------------
 1 | #include "Battery1001.hpp"
 2 | 
 3 | #include <iostream>
 4 | #include <tuple>
 5 | 
 6 | namespace LGSTrayHID {
 7 | 	using namespace Battery;
 8 | 	
 9 | 	std::tuple<int, int, Power_supply_status> Battery1001_parse(const HIDPPMsg_20& msg) {
10 | 		using enum Power_supply_status;
11 | 
12 | 		int battery_mvolt = (msg.get_result_data()[0] << 8) + (msg.get_result_data()[1]);
13 | 		int battery_capacity = Battery1001_mv_to_capacity(battery_mvolt);
14 | 
15 | 		uint8_t flags = msg.get_result_data()[2];
16 | 
17 | 		Power_supply_status status = POWER_SUPPLY_STATUS_UNKNOWN;
18 | 
19 | 		if (flags & 0x80) {
20 | 			switch (flags & 0x07) {
21 | 			case 0:
22 | 				status = POWER_SUPPLY_STATUS_CHARGING;
23 | 				break;
24 | 			case 1:
25 | 				status = POWER_SUPPLY_STATUS_FULL;
26 | 				break;
27 | 			case 2:
28 | 				status = POWER_SUPPLY_STATUS_NOT_CHARGING;
29 | 				break;
30 | 			default:
31 | 				status = POWER_SUPPLY_STATUS_UNKNOWN;
32 | 				break;
33 | 			}
34 | 		}
35 | 		else {
36 | 			status = POWER_SUPPLY_STATUS_DISCHARGING;
37 | 		}
38 | 
39 | 		return { battery_mvolt, battery_capacity, status };
40 | 	}
41 | }


--------------------------------------------------------------------------------
/CMakeLists.txt:
--------------------------------------------------------------------------------
 1 | # CMakeList.txt : Top-level CMake project file, do global configuration
 2 | # and include sub-projects here.
 3 | #
 4 | cmake_minimum_required (VERSION 3.14)
 5 | include(FetchContent)
 6 | 
 7 | set(CMAKE_CXX_STANDARD 20)
 8 | set(CMAKE_CXX_STANDARD_REQUIRED TRUE)
 9 | 
10 | project("libHidTest")
11 | 
12 | set(EXEC_NAME "hidpp_mon")
13 | 
14 | add_subdirectory("${CMAKE_SOURCE_DIR}/external/hidapi-win")
15 | add_subdirectory("${CMAKE_SOURCE_DIR}/external/websocketpp")
16 | add_subdirectory("${CMAKE_SOURCE_DIR}/external/nlohmann_json")
17 | 
18 | 
19 | add_executable(${EXEC_NAME} 
20 | 	"src/CMakeProject1.cpp" 
21 | 	"src/HIDDevice.cpp" 
22 | 	"src/HIDPPMsg.cpp"
23 |  "src/LogiDevice.cpp" "src/LGSTrayHID_common.cpp" "src/Battery1001.cpp" "src/Battery1000.cpp" "src/Battery1004.cpp" "src/MapWrapper.cpp" "src/WebsocketServer.cpp")
24 | 
25 | target_link_libraries(
26 | 	${EXEC_NAME} PUBLIC
27 | 	hidapi_win
28 | 	websocketpp
29 | 	nlohmann_json::nlohmann_json
30 | )
31 | target_include_directories(
32 | 	${EXEC_NAME} PUBLIC 
33 | 	"include"
34 | )
35 | 
36 | if(MSVC)
37 | 	target_compile_options(${EXEC_NAME} PRIVATE "/external:anglebrackets")
38 | endif(MSVC)


--------------------------------------------------------------------------------
/include/Battery1001.hpp:
--------------------------------------------------------------------------------
 1 | #pragma once
 2 | 
 3 | #include <array>
 4 | #include <tuple>
 5 | 
 6 | #include "HIDPPMsg.hpp"
 7 | #include "Battery.hpp"
 8 | 
 9 | namespace LGSTrayHID {
10 | 	namespace {
11 | 		constexpr std::array<int, 100> voltages = {
12 | 			4186, 4156, 4143, 4133, 4122, 4113, 4103, 4094, 4086, 4075,
13 | 			4067, 4059, 4051, 4043, 4035, 4027, 4019, 4011, 4003, 3997,
14 | 			3989, 3983, 3976, 3969, 3961, 3955, 3949, 3942, 3935, 3929,
15 | 			3922, 3916, 3909, 3902, 3896, 3890, 3883, 3877, 3870, 3865,
16 | 			3859, 3853, 3848, 3842, 3837, 3833, 3828, 3824, 3819, 3815,
17 | 			3811, 3808, 3804, 3800, 3797, 3793, 3790, 3787, 3784, 3781,
18 | 			3778, 3775, 3772, 3770, 3767, 3764, 3762, 3759, 3757, 3754,
19 | 			3751, 3748, 3744, 3741, 3737, 3734, 3730, 3726, 3724, 3720,
20 | 			3717, 3714, 3710, 3706, 3702, 3697, 3693, 3688, 3683, 3677,
21 | 			3671, 3666, 3662, 3658, 3654, 3646, 3633, 3612, 3579, 3537
22 | 		};
23 | 	}
24 | 
25 | 	inline int Battery1001_mv_to_capacity(int voltage) {
26 | 		if ((voltage < 3500) || (voltage >= 5000)) {
27 | 			// Potentially incorrect voltage curve
28 | 			return -1;
29 | 		}
30 | 
31 | 		for (int i = 0; i < voltages.size(); i++) {
32 | 			if (voltage >= voltages[i]) {
33 | 				return ((int) voltages.size()) - i;
34 | 			}
35 | 		}
36 | 
37 | 		// Should never reach
38 | 		return -1;
39 | 	}
40 | 
41 | 	std::tuple<int, int, Battery::Power_supply_status> Battery1001_parse(const HIDPPMsg_20& msg);
42 | }


--------------------------------------------------------------------------------
/src/HIDPPMsg.cpp:
--------------------------------------------------------------------------------
 1 | #include "HIDPPMsg.hpp"
 2 | 
 3 | #include <type_traits>
 4 | 
 5 | namespace LGSTrayHID {
 6 | 	HIDPPMsg::HIDPPMsg(HIDPP_length hidpp_length) : _buffer(new uint8_t[hidpp_enum_length(hidpp_length)])
 7 | 	{
 8 | 	}
 9 | 	HIDPPMsg::HIDPPMsg(std::unique_ptr <uint8_t[]> buffer) : _buffer(std::move(buffer)) {
10 | 
11 | 	}
12 | 	HIDPPMsg::~HIDPPMsg()
13 | 	{
14 | 	}
15 | 	uint8_t* HIDPPMsg::data()
16 | 	{
17 | 		return this->_buffer.get();
18 | 	}
19 | 	std::unique_ptr<uint8_t[]> HIDPPMsg::move_ptr()
20 | 	{
21 | 		return std::move(_buffer);
22 | 	}
23 | 	HIDPP_length HIDPPMsg::get_length()
24 | 	{
25 | 		return static_cast<HIDPP_length>(this->_buffer[0]);
26 | 	}
27 | 	uint8_t HIDPPMsg::get_device_idx()
28 | 	{
29 | 		return this->_buffer[1];
30 | 	}
31 | 	const uint8_t* HIDPPMsg::get_result_data() const
32 | 	{
33 | 		return this->_buffer.get() + 4;
34 | 	}
35 | 	uint8_t HIDPPMsg_20::get_feature_index()
36 | 	{
37 | 		return this->_buffer[2];
38 | 	}
39 | 	uint8_t HIDPPMsg_20::get_function_id()
40 | 	{
41 | 		return (this->_buffer[3] & 0xF0) >> 4;
42 | 	}
43 | 	uint8_t HIDPPMsg_20::get_sw_id()
44 | 	{
45 | 		return (this->_buffer[3] & 0x0F);
46 | 	}
47 | 	uint8_t HIDPPMsg_10::get_sub_id()
48 | 	{
49 | 		return this->_buffer[2];
50 | 	}
51 | 	uint8_t HIDPPMsg_10::get_address()
52 | 	{
53 | 		return this->_buffer[3];
54 | 	}
55 | }
56 | 
57 | // Bug with intellisense, failing static_assert
58 | #ifndef __INTELLISENSE__
59 | using namespace LGSTrayHID;
60 | static_assert(std::is_layout_compatible_v<HIDPPMsg, HIDPPMsg_10>);
61 | static_assert(std::is_layout_compatible_v<HIDPPMsg, HIDPPMsg_20>);
62 | #endif


--------------------------------------------------------------------------------
/src/MapWrapper.cpp:
--------------------------------------------------------------------------------
 1 | #include "MapWrapper.hpp"
 2 | 
 3 | #include <sstream>
 4 | 
 5 | #include <mutex>
 6 | #include <map>
 7 | 
 8 | #include <nlohmann/json.hpp>
 9 | 
10 | namespace LGSTrayHID {
11 | 	namespace MapWrapper {
12 | 		std::mutex logiDevice_map_mutex;
13 | 		std::map<KeyType, std::weak_ptr<LogiDevice>> logiDevice_map;
14 | 
15 | 		void add_LogiDevice(KeyType key, const std::shared_ptr<LogiDevice>& logiDevice) {
16 | 			const std::lock_guard<std::mutex> lock(logiDevice_map_mutex);
17 | 			logiDevice_map[key] = logiDevice;
18 | 		}
19 | 
20 | 		nlohmann::json to_json() {
21 | 			nlohmann::json json_payload;
22 | 			json_payload["deviceInfos"] = nlohmann::json::array();
23 | 
24 | 			const std::lock_guard<std::mutex> lock(logiDevice_map_mutex);
25 | 
26 | 			for (const auto &pair : logiDevice_map) {
27 | 				const std::shared_ptr<const LogiDevice> device = pair.second.lock();
28 | 				if (device == nullptr) {
29 | 					continue;
30 | 				}
31 | 
32 | 				json_payload["deviceInfos"].insert(
33 | 					json_payload["deviceInfos"].end(),
34 | 					device->device_summary()
35 | 				);
36 | 			}
37 | 
38 | 			return json_payload;
39 | 		}
40 | 
41 | 		nlohmann::json get_battery_summary(KeyType key)
42 | 		{
43 | 			const std::lock_guard<std::mutex> lock(logiDevice_map_mutex);
44 | 			const std::shared_ptr<const LogiDevice> device = logiDevice_map[key].lock();
45 | 			if (device == nullptr) {
46 | 				throw std::out_of_range("Invalid device id");
47 | 			}
48 | 
49 | 			return device->battery_summary();
50 | 		}
51 | 
52 | 		void clear_map() {
53 | 			const std::lock_guard<std::mutex> lock(logiDevice_map_mutex);
54 | 			logiDevice_map.clear();
55 | 		}
56 | 	}
57 | }


--------------------------------------------------------------------------------
/CMakePresets.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "version": 3,
 3 |     "configurePresets": [
 4 |         {
 5 |             "name": "windows-base",
 6 |             "hidden": true,
 7 |             "generator": "Ninja",
 8 |             "binaryDir": "${sourceDir}/out/build/${presetName}",
 9 |             "installDir": "${sourceDir}/out/install/${presetName}",
10 |             "cacheVariables": {
11 |                 "CMAKE_C_COMPILER": "cl.exe",
12 |                 "CMAKE_CXX_COMPILER": "cl.exe"
13 |             },
14 |             "condition": {
15 |                 "type": "equals",
16 |                 "lhs": "${hostSystemName}",
17 |                 "rhs": "Windows"
18 |             }
19 |         },
20 |         {
21 |             "name": "x64-debug",
22 |             "displayName": "x64 Debug",
23 |             "inherits": "windows-base",
24 |             "architecture": {
25 |                 "value": "x64",
26 |                 "strategy": "external"
27 |             },
28 |             "cacheVariables": {
29 |                 "CMAKE_BUILD_TYPE": "Debug"
30 |             }
31 |         },
32 |         {
33 |             "name": "x64-release",
34 |             "displayName": "x64 Release",
35 |             "inherits": "x64-debug",
36 |             "cacheVariables": {
37 |                 "CMAKE_BUILD_TYPE": "Release"
38 |             }
39 |         }
40 |         //{
41 |         //    "name": "x86-debug",
42 |         //    "displayName": "x86 Debug",
43 |         //    "inherits": "windows-base",
44 |         //    "architecture": {
45 |         //        "value": "x86",
46 |         //        "strategy": "external"
47 |         //    },
48 |         //    "cacheVariables": {
49 |         //        "CMAKE_BUILD_TYPE": "Debug"
50 |         //    }
51 |         //},
52 |         //{
53 |         //    "name": "x86-release",
54 |         //    "displayName": "x86 Release",
55 |         //    "inherits": "x86-debug",
56 |         //    "cacheVariables": {
57 |         //        "CMAKE_BUILD_TYPE": "Release"
58 |         //    }
59 |         //}
60 |     ]
61 | }
62 | 


--------------------------------------------------------------------------------
/include/LogiDevice.hpp:
--------------------------------------------------------------------------------
  1 | #pragma once
  2 | 
  3 | #include <string>
  4 | #include <memory>
  5 | #include <functional>
  6 | #include <hidapi.h>
  7 | 
  8 | #include <nlohmann/json.hpp>
  9 | 
 10 | #include "Battery.hpp"
 11 | 
 12 | namespace LGSTrayHID {
 13 | 	enum class LogiDeviceType : uint8_t {
 14 | 		Keyboard = 0,
 15 | 		RemoteControl,
 16 | 		Numpad,
 17 | 		Mouse,
 18 | 		Touchpad,
 19 | 		Trackball,
 20 | 		Presenter,
 21 | 		Receiver
 22 | 	};		
 23 | 
 24 | 	inline const char* LogiDeviceTypeEnumToString(LogiDeviceType type) {
 25 | 		using enum LogiDeviceType;
 26 | 
 27 | 		switch (type)
 28 | 		{
 29 | 		case Keyboard:
 30 | 			return "KEYBOARD";
 31 | 		case RemoteControl:
 32 | 			return "REMOTECONTROL";
 33 | 		case Numpad:
 34 | 			return "NUMPAD";
 35 | 		case Mouse:
 36 | 			return "MOUSE";
 37 | 		case Touchpad:
 38 | 			return "TOUCHPAD";
 39 | 		case Trackball:
 40 | 			return "TRACKBALL";
 41 | 		case Presenter:
 42 | 			return "PRESENTER";
 43 | 		case Receiver:
 44 | 			return "RECEIVER";
 45 | 		default:
 46 | 			return "MOUSE";
 47 | 		}
 48 | 	}
 49 | 
 50 | 	class LogiDevice : public std::enable_shared_from_this<LogiDevice> {
 51 | 	public:
 52 | 		typedef std::function<void(const LogiDevice&)> Battery_update_cb;
 53 | 		typedef std::function<void(const LogiDevice&)> Device_ready_cb;
 54 | 
 55 | 	private:
 56 | 		uint8_t dev_idx = 0;
 57 | 
 58 | 		std::shared_ptr<hid_device> _short_dev;
 59 | 		std::shared_ptr<hid_device> _long_dev;
 60 | 
 61 | 		uint8_t _device_name_idx = 0;
 62 | 		uint8_t _device_name_step = 0;
 63 | 		uint8_t _device_name_count = 0;
 64 | 
 65 | 		uint8_t _battery_step = 0;
 66 | 		uint8_t _battery_1000_idx = 0;
 67 | 		uint8_t _battery_1001_idx = 0;
 68 | 		uint8_t _battery_1004_idx = 0;
 69 | 
 70 | 		bool _ready = false;
 71 | 
 72 | 		std::function<void(std::unique_ptr<uint8_t[]>)> _write_cb;
 73 | 
 74 | 		LogiDevice(uint8_t dev_idx, std::string container_name, const std::shared_ptr<hid_device>& short_dev, const std::shared_ptr<hid_device>& long_dev);
 75 | 		
 76 | 		void check_proto_ver_cb(std::unique_ptr<uint8_t[]> buf);
 77 | 		void feature_set_cb(std::unique_ptr<uint8_t[]> buf);
 78 | 		void device_name_cb(std::unique_ptr<uint8_t[]> buf);
 79 | 		void battery_status_cb(std::unique_ptr<uint8_t[]> buf);
 80 | 
 81 | 		static inline Battery_update_cb battery_update_cb;
 82 | 		static inline Device_ready_cb device_ready_cb;
 83 | 		static std::string gen_dev_id(uint8_t dev_idx, std::string container_name);
 84 | 
 85 | 	public:
 86 | 		std::string device_name;
 87 | 		const std::string dev_id;
 88 | 		LogiDeviceType device_type;
 89 | 
 90 | 		std::atomic<int> battery_voltage = -1;
 91 | 		std::atomic<int> battery_percentage = -1;
 92 | 		std::atomic<Battery::Power_supply_status> battery_status;
 93 | 
 94 | 		[[nodiscard]] static std::shared_ptr<LogiDevice> make_shared(uint8_t dev_idx, std::string container_name, const std::shared_ptr<hid_device>& short_dev, const std::shared_ptr<hid_device>& long_dev);
 95 | 		~LogiDevice() = default;
 96 | 
 97 | 		nlohmann::json battery_summary() const;
 98 | 		nlohmann::json device_summary() const;
 99 | 
100 | 		static void Register_battery_update_cb(Battery_update_cb cb);
101 | 		static void Register_device_ready_cb(Device_ready_cb cb);
102 | 
103 | 		void update_battery();
104 | 		void invoke_response(std::unique_ptr<uint8_t[]> buf);
105 | 	};
106 | }


--------------------------------------------------------------------------------
/src/CMakeProject1.cpp:
--------------------------------------------------------------------------------
  1 | // CMakeProject1.cpp : Defines the entry point for the application.
  2 | //
  3 | #include "CMakeProject1.h"
  4 | 
  5 | #include <type_traits>
  6 | #include <chrono>
  7 | #include <thread>
  8 | #include <map>
  9 | #include <functional>
 10 | 
 11 | #include <hidapi.h>
 12 | 
 13 | #include <cassert>
 14 | 
 15 | #ifdef _WIN32
 16 | #include <hidapi_winapi.h>
 17 | #endif
 18 | 
 19 | #include "HIDDevice.hpp"
 20 | #include "HIDPPMsg.hpp"
 21 | 
 22 | #include "MapWrapper.hpp"
 23 | #include "WebsocketServer.hpp"
 24 | 
 25 | #include <websocketpp/config/asio_no_tls.hpp>
 26 | #include <websocketpp/server.hpp>
 27 | 
 28 | #include <nlohmann/json.hpp>
 29 | 
 30 | namespace {
 31 | 	enum USAGE_PAGE : uint8_t {
 32 | 		SHORT = 0x01,
 33 | 		LONG = 0x02,
 34 | 		VERY_LONG = 0x04
 35 | 	};
 36 | }
 37 | 
 38 | std::string GUID_to_string(const GUID& guid) {
 39 | 	std::ostringstream os;
 40 | 
 41 | 	os << std::hex << guid.Data1;
 42 | 	os << std::hex << guid.Data2;
 43 | 	os << std::hex << guid.Data3;
 44 | 
 45 | 	for (size_t i = 0; i < 8; i++) {
 46 | 		os << std::hex << static_cast<int>(guid.Data4[i]);
 47 | 	}
 48 | 
 49 | 	return os.str();
 50 | }
 51 | 
 52 | struct GUIDComparer
 53 | {
 54 | 	bool operator()(const GUID& Left, const GUID& Right) const
 55 | 	{
 56 | 		// comparison logic goes here
 57 | 		return memcmp(&Left, &Right, sizeof(Right)) < 0;
 58 | 	}
 59 | };
 60 | 
 61 | typedef websocketpp::server<websocketpp::config::asio> server;
 62 | typedef server::message_ptr message_ptr;
 63 | 
 64 | using namespace std::placeholders;
 65 | 
 66 | int main(int argc, char **argv) {
 67 | 	int port = 9020;
 68 | 	if (argc > 1) {
 69 | 		int requested_port = std::atoi(argv[1]);
 70 | 
 71 | 		if ((1 < requested_port) && (requested_port <= UINT16_MAX)) {
 72 | 			port = requested_port;
 73 | 		}
 74 | 	}
 75 | 
 76 | 	LGSTrayHID::LogiDevice::Register_battery_update_cb([](const LGSTrayHID::LogiDevice& dev) {
 77 | 		std::cout << dev.battery_summary().dump() << std::endl;
 78 | 		std::cout << LGSTrayHID::MapWrapper::to_json().dump() << std::endl;
 79 | 
 80 | 		LGSTrayHID::WebsocketServer::notify_subscriptions("/battery/state/changed", dev.battery_summary());
 81 | 	});
 82 | 
 83 | 	LGSTrayHID::LogiDevice::Register_device_ready_cb([](const LGSTrayHID::LogiDevice& dev) {
 84 | 		LGSTrayHID::WebsocketServer::notify_subscriptions("/devices/state/changed", LGSTrayHID::MapWrapper::to_json());
 85 | 	});
 86 | 
 87 | 	hid_init();
 88 | 
 89 | 	auto devs = std::unique_ptr<hid_device_info, decltype(&hid_free_enumeration)>(hid_enumerate(0x046d, 0x00), &hid_free_enumeration);
 90 | 	auto cur_dev = devs.get();
 91 | 
 92 | 	std::map<GUID, std::unique_ptr<LGSTrayHID::HIDDevice>, GUIDComparer> hid_device_map;
 93 | 
 94 | 	while (cur_dev) {
 95 | 		if ((cur_dev->usage_page & 0xFF00) == 0xFF00) {
 96 | 			if ((cur_dev->usage == USAGE_PAGE::SHORT) || (cur_dev->usage == USAGE_PAGE::LONG)) {
 97 | 				auto c_hid_device = std::shared_ptr<hid_device>(hid_open_path(cur_dev->path), &hid_close);
 98 | 				GUID _guid;
 99 | 				hid_winapi_get_container_id(c_hid_device.get(), &_guid);
100 | 
101 | 				bool found = (hid_device_map.find(_guid) != hid_device_map.end());
102 | 
103 | 				if (!found) {
104 | 					hid_device_map[_guid] = std::unique_ptr<LGSTrayHID::HIDDevice>(new LGSTrayHID::HIDDevice(GUID_to_string(_guid)));
105 | 				}
106 | 
107 | 				if (cur_dev->usage == USAGE_PAGE::SHORT) {
108 | 					hid_device_map[_guid]->assign_short(c_hid_device);
109 | 				}
110 | 				else if (cur_dev->usage == USAGE_PAGE::LONG) {
111 | 					hid_device_map[_guid]->assign_long(c_hid_device);
112 | 				}
113 | 			}
114 | 		}
115 | 
116 | 		cur_dev = cur_dev->next;
117 | 	}
118 | 
119 | 	LGSTrayHID::WebsocketServer::init_and_serve(port);
120 | 
121 | 	return 0;
122 | }
123 | 


--------------------------------------------------------------------------------
/src/WebsocketServer.cpp:
--------------------------------------------------------------------------------
  1 | #include "WebsocketServer.hpp"
  2 | 
  3 | #include <nlohmann/json.hpp>
  4 | 
  5 | #include <websocketpp/config/asio_no_tls.hpp>
  6 | #include <websocketpp/server.hpp>
  7 | 
  8 | #include "MapWrapper.hpp"
  9 | 
 10 | using namespace std::placeholders;
 11 | 
 12 | 
 13 | namespace LGSTrayHID {
 14 | namespace WebsocketServer {
 15 | 	typedef websocketpp::server<websocketpp::config::asio> Server;
 16 | 	typedef Server::message_ptr message_ptr;
 17 | 
 18 | 	namespace {
 19 | 		struct Subscription_map_value {
 20 | 			Server* s;
 21 | 			websocketpp::connection_hdl hdl;
 22 | 		};
 23 | 	}
 24 | 
 25 | 	typedef std::multimap<std::string, Subscription_map_value> Subscription_map;
 26 | 
 27 | 	Server server;
 28 | 	Subscription_map subscription_map;
 29 | 
 30 | 	nlohmann::json gen_message_json(std::string msg_id, std::string verb, std::string path, nlohmann::json payload, std::string res_code) {
 31 | 		nlohmann::json ret =
 32 | 		{
 33 | 			{"msgId", msg_id},
 34 | 			{"origin", "backend"},
 35 | 			{"verb", verb},
 36 | 			{"path", path},
 37 | 			{"payload", payload}
 38 | 		};
 39 | 		ret["result"]["code"] = res_code;
 40 | 
 41 | 		return ret;
 42 | 	}
 43 | 
 44 | 	void on_get(Server* s, websocketpp::connection_hdl hdl, nlohmann::json payload_json) {
 45 | 		const std::string path = payload_json.value("path", "");
 46 | 
 47 | 		bool temp = (s == &server);
 48 | 
 49 | 		if (path.compare("/devices/list") == 0) {
 50 | 			std::cout << "requested /devices/list" << std::endl;
 51 | 
 52 | 			std::string ret_payload = gen_message_json("", "GET", "/devices/list", MapWrapper::to_json(), "SUCCESS").dump();
 53 | 
 54 | 			s->send(hdl, ret_payload, websocketpp::frame::opcode::text);
 55 | 		}
 56 | 		else if (path.compare(0, 8, "/battery") == 0) {
 57 | 			std::cout << "requested /battery" << std::endl;
 58 | 			std::cout << "payload " << payload_json.dump() << std::endl;
 59 | 
 60 | 			size_t delim1 = path.find('/', 1);
 61 | 			size_t delim2 = path.find('/', delim1+1);
 62 | 
 63 | 			if (delim2 < delim1) {
 64 | 				return;
 65 | 			}
 66 | 
 67 | 			std::string dev_id = path.substr(delim1+1, delim2-delim1-1);
 68 | 			std::string ret_payload;
 69 | 
 70 | 			try {
 71 | 				auto battery_summary = MapWrapper::get_battery_summary(dev_id);
 72 | 				ret_payload = gen_message_json("", "GET", path, battery_summary, "SUCCESS").dump();
 73 | 			}
 74 | 			catch (std::out_of_range&) {
 75 | 				ret_payload = gen_message_json("", "GET", path, {}, "NO_SUCH_PATH").dump();
 76 | 			}
 77 | 
 78 | 			s->send(hdl, ret_payload, websocketpp::frame::opcode::text);
 79 | 		}
 80 | 	}
 81 | 
 82 | 	void on_subscribe(Server* s, websocketpp::connection_hdl hdl, nlohmann::json payload_json) {
 83 | 		const std::string path = payload_json.value("path", "");
 84 | 
 85 | 		if (path.empty()) {
 86 | 			return;
 87 | 		}
 88 | 
 89 | 		subscription_map.emplace(path, Subscription_map_value{s, hdl});
 90 | 	}
 91 | 
 92 | 	void on_message(Server* s, websocketpp::connection_hdl hdl, message_ptr msg) {
 93 | 		//std::cout << "on_message called with hdl: " << hdl.lock().get()
 94 | 		//	<< " and message: " << msg->get_payload()
 95 | 		//	<< std::endl;
 96 | 
 97 | 		//try {
 98 | 		//	s->send(hdl, msg->get_payload(), msg->get_opcode());
 99 | 		//}
100 | 		//catch (websocketpp::exception const& e) {
101 | 		//	std::cout << "Echo failed because: "
102 | 		//		<< "(" << e.what() << ")" << std::endl;
103 | 		//}
104 | 
105 | 		nlohmann::json payload_json = nlohmann::json::parse(msg->get_payload());
106 | 
107 | 		const std::string verb = payload_json.value("verb", "");
108 | 
109 | 		if (verb.compare("GET") == 0) {
110 | 			on_get(s, hdl, payload_json);
111 | 		}
112 | 		else if (verb.compare("SUBSCRIBE") == 0) {
113 | 			on_subscribe(s, hdl, payload_json);
114 | 		}
115 | 	}
116 | 
117 | 	void init_and_serve(int port) {
118 | 		server.init_asio();
119 | 
120 | 		server.set_message_handler(std::bind(&on_message, &server, _1, _2));
121 | 
122 | 		websocketpp::lib::asio::ip::tcp::endpoint ep;
123 | 		ep.address(boost::asio::ip::address_v4::loopback());
124 | 		ep.port(port);
125 | 
126 | 		server.listen(ep);
127 | 		server.start_accept();
128 | 
129 | 		server.run();
130 | 	}
131 | 
132 | 	void notify_subscriptions(std::string path, nlohmann::json payload_json) {
133 | 		auto subscription_entries = subscription_map.equal_range(path);
134 | 		auto entry_length = std::distance(subscription_entries.first, subscription_entries.second);
135 | 
136 | 		//if (entry_length == 0) {
137 | 		//	return;
138 | 		//}
139 | 
140 | 		nlohmann::json output_payload = gen_message_json("", "BROADCAST", path, payload_json, "SUCCESS");
141 | 
142 | 		auto temp = output_payload.dump();
143 | 
144 | 		for (Subscription_map::iterator entry_iter = subscription_entries.first; entry_iter != subscription_entries.second;) {
145 | 			auto& entry = entry_iter->second;
146 | 			if (entry.hdl.expired()) {
147 | 				entry_iter = subscription_map.erase(entry_iter);
148 | 				continue;
149 | 			}
150 | 
151 | 			entry.s->send(entry.hdl, output_payload.dump(), websocketpp::frame::opcode::text);
152 | 
153 | 			++entry_iter;
154 | 		}
155 | 	}
156 | }
157 | }


--------------------------------------------------------------------------------
/src/HIDDevice.cpp:
--------------------------------------------------------------------------------
  1 | #include <mutex>
  2 | #include "HIDDevice.hpp"
  3 | #include "HIDPPMsg.hpp"
  4 | #include <iostream>
  5 | 
  6 | using namespace std::chrono_literals;
  7 | 
  8 | namespace LGSTrayHID {
  9 | 	std::mutex m;
 10 | 	constexpr int HID_TIMEOUT = 100;
 11 | 
 12 | 	HIDDevice::HIDDevice(std::string container_name) : container_name(container_name) {
 13 | 	}
 14 | 
 15 | 	HIDDevice::~HIDDevice() {
 16 | 		cancellationToken = true;
 17 | 
 18 | 		//hid_set_nonblocking(this->_short_dev.get(), 1);
 19 | 		//hid_set_nonblocking(this->_long_dev.get(), 1);
 20 | 
 21 | 		if (this->_short_reader) {
 22 | 			_short_reader->join();
 23 | 		}
 24 | 
 25 | 		if (this->_long_reader) {
 26 | 			_long_reader->join();
 27 | 		}
 28 | 	}
 29 | 
 30 | 	void HIDDevice::_check_if_ready() {
 31 | 		if (_short_reader && _long_reader) {
 32 | 			constexpr size_t short_buf_size = 7;
 33 | 			{
 34 | 				uint8_t buf[short_buf_size] = { 0x10, 0xFF, 0x80, 0x00, 0x00, 0x01, 0x00 };
 35 | 				hid_write(this->_short_dev.get(), buf, short_buf_size);
 36 | 			}
 37 | 			{
 38 | 				uint8_t buf[short_buf_size] = { 0x10, 0xFF, 0x80, 0x02, 0x02, 0x00, 0x00 };
 39 | 				hid_write(this->_short_dev.get(), buf, short_buf_size);
 40 | 			}
 41 | 
 42 | 			//std::this_thread::sleep_for(500ms);
 43 | 
 44 | 			for (size_t i = 0; i <= 10; ++i) {
 45 | 				uint8_t buf[short_buf_size] = { 0x10, i, 0x00, 0x10 | 0x00, 0x00, 0x00, 0x00 };
 46 | 				hid_write(this->_short_dev.get(), buf, short_buf_size);
 47 | 			}
 48 | 		}
 49 | 
 50 | 	}
 51 | 
 52 | 	void HIDDevice::assign_short(std::shared_ptr<hid_device> short_dev) {
 53 | 		this->_short_dev = short_dev;
 54 | 
 55 | 		this->_short_reader = std::unique_ptr<std::thread>(new std::thread([this]() {
 56 | 			while (true) {
 57 | 				if (cancellationToken) {
 58 | 					return;
 59 | 				}
 60 | 
 61 | 				HIDPPMsg msg(HIDPP_SHORT);
 62 | 				int ret = hid_read_timeout(_short_dev.get(), msg.data(), HIDPP_SHORT_SIZE, HID_TIMEOUT);
 63 | 				if (ret < 0) {
 64 | 					break;
 65 | 				}
 66 | 				if (ret == 0) {
 67 | 					continue;
 68 | 				}
 69 | 
 70 | 				m.lock();
 71 | 				printf("short_dev: ");
 72 | 				for (size_t i = 0; i < HIDPP_SHORT_SIZE; i++)
 73 | 				{
 74 | 					printf("0x%02X ", msg.data()[i]);
 75 | 				}
 76 | 				printf("\n");
 77 | 				m.unlock();
 78 | 
 79 | 				uint8_t dev_idx = msg.get_device_idx();
 80 | 
 81 | 				//if (dev_idx == 0xFF) {
 82 | 				//	continue;
 83 | 				//}
 84 | 
 85 | 				HIDPPMsg_10 *msg_10 = reinterpret_cast<HIDPPMsg_10*>(&msg);
 86 | 
 87 | 				std::unique_lock<std::mutex> lock(devices_map_mutex);
 88 | 				auto target_dev = this->devices.find(dev_idx);
 89 | 				if (target_dev == this->devices.end()) {
 90 | 					this->devices[dev_idx] = LogiDevice::make_shared(dev_idx, container_name, _short_dev, _long_dev);
 91 | 
 92 | 					uint8_t buf[HIDPP_SHORT_SIZE] = { HIDPP_SHORT, dev_idx, 0x00, 0x10, 0x00, 0x00, 0x00 };
 93 | 					hid_write(this->_short_dev.get(), buf, HIDPP_SHORT_SIZE);
 94 | 					continue;
 95 | 				}
 96 | 				lock.unlock();
 97 | 				
 98 | 				// On Connection notification
 99 | 				if (msg_10->get_sub_id() == 0x41) {
100 | 					uint8_t buf[HIDPP_SHORT_SIZE] = { HIDPP_SHORT, dev_idx, 0x00, 0x10, 0x00, 0x00, 0x00 };
101 | 					hid_write(this->_short_dev.get(), buf, HIDPP_SHORT_SIZE);
102 | 				}
103 | 				else {
104 | 					target_dev->second->invoke_response(std::move(msg.move_ptr()));
105 | 				}
106 | 			}
107 | 		}));
108 | 
109 | 		_check_if_ready();
110 | 	}
111 | 
112 | 	void HIDDevice::assign_long(std::shared_ptr<hid_device> long_dev) {
113 | 		this->_long_dev = long_dev;
114 | 
115 | 		this->_long_reader = std::unique_ptr<std::thread>(new std::thread([this]() {
116 | 			while (true) {
117 | 				if (cancellationToken) {
118 | 					return;
119 | 				}
120 | 
121 | 				HIDPPMsg msg(HIDPP_LONG);
122 | 
123 | 				int ret = hid_read_timeout(_long_dev.get(), msg.data(), HIDPP_LONG_SIZE, HID_TIMEOUT);
124 | 				if (ret < 0) {
125 | 					break;
126 | 				}
127 | 				if (ret == 0) {
128 | 					continue;
129 | 				}
130 | 
131 | 				m.lock();
132 | 				printf("long_dev: ");
133 | 				for (size_t i = 0; i < HIDPP_LONG_SIZE; i++)
134 | 				{
135 | 					printf("0x%02X ", msg.data()[i]);
136 | 				}
137 | 				printf("\n");
138 | 				m.unlock();
139 | 
140 | 				uint8_t dev_idx = msg.get_device_idx();
141 | 
142 | 				//if (dev_idx == 0xFF) {
143 | 				//	continue;
144 | 				//}
145 | 
146 | 				HIDPPMsg_20 &msg20 = reinterpret_cast<HIDPPMsg_20&>(msg);
147 | 
148 | 				std::unique_lock<std::mutex> lock(devices_map_mutex);
149 | 				auto target_dev = this->devices.find(dev_idx);
150 | 				if (target_dev == this->devices.end()) {
151 | 					if ((msg20.get_device_idx() < 0xFF) && (msg20.get_function_id() == 1) && (msg20.get_sw_id() == SW_ID)) {
152 | 						this->devices[dev_idx] = LogiDevice::make_shared(dev_idx, container_name, _short_dev, _long_dev);
153 | 
154 | 						uint8_t buf[HIDPP_SHORT_SIZE] = { HIDPP_SHORT, dev_idx, 0x00, 0x10, 0x00, 0x00, 0x00 };
155 | 						hid_write(this->_short_dev.get(), buf, HIDPP_SHORT_SIZE);
156 | 					}
157 | 					continue;
158 | 				}
159 | 				lock.unlock();
160 | 
161 | 				if (msg20.get_feature_index() >= 0x40) {
162 | 					// STUB ignore HIDPP 1.0 long messages
163 | 					continue;
164 | 				}
165 | 
166 | 				if ((msg20.get_sw_id() != SW_ID) && (msg20.get_sw_id() != 0x00)) {
167 | 					// STUB ignore HIDPP 2.0 long message not tagged with SW_ID or Notification 0x00
168 | 					continue;
169 | 				}
170 | 
171 | 				//if ((msg20.get_feature_index() == 0x00) && (msg20.get_function_id()) == 1 && (msg20.get_sw_id() == SW_ID)) {
172 | 				//	// Ignore SW_ID tagged ping response, should never be sent
173 | 				//	continue;
174 | 				//}
175 | 
176 | 				target_dev->second->invoke_response(msg.move_ptr());
177 | 			}
178 | 		}));
179 | 
180 | 		_check_if_ready();
181 | 	}
182 | }


--------------------------------------------------------------------------------
/src/LogiDevice.cpp:
--------------------------------------------------------------------------------
  1 | #include "LogiDevice.hpp"
  2 | 
  3 | #include "HIDPPMsg.hpp"
  4 | #include <iostream>
  5 | 
  6 | #include <thread>
  7 | #include <chrono>
  8 | 
  9 | #include "MapWrapper.hpp"
 10 | 
 11 | #include "Battery1000.hpp"
 12 | #include "Battery1001.hpp"
 13 | #include "Battery1004.hpp"
 14 | 
 15 | using namespace std::placeholders;
 16 | 
 17 | namespace LGSTrayHID {
 18 | 	void LogiDevice::check_proto_ver_cb(std::unique_ptr<uint8_t[]> buf)
 19 | 	{
 20 | 		HIDPPMsg_20 msg(std::move(buf));
 21 | 
 22 | 		if (msg.get_feature_index() != 0x00) {
 23 | 			std::cerr << "Device is not HID++ 2.0" << std::endl;
 24 | 			return;
 25 | 		}
 26 | 
 27 | 		std::cout << "Device is HID++ 2.0+" << std::endl;
 28 | 
 29 | 
 30 | 		this->_write_cb = [this](std::unique_ptr<uint8_t[]> buf) { this->feature_set_cb(std::move(buf)); };
 31 | 
 32 | 		uint8_t wbuf[HIDPP_LONG_SIZE] = { HIDPP_LONG, dev_idx, 0x00, 0x00 | SW_ID, 0x00, 0x05, 0x00 };
 33 | 		hid_write(_long_dev.get(), wbuf, HIDPP_LONG_SIZE);
 34 | 	}
 35 | 
 36 | 	void LogiDevice::feature_set_cb(std::unique_ptr<uint8_t[]> buf)
 37 | 	{
 38 | 		HIDPPMsg_20 msg(std::move(buf));
 39 | 
 40 | 		if (msg.get_feature_index() != 0x00) {
 41 | 			// Not IRoot feature index ignore
 42 | 			return;
 43 | 		}
 44 | 
 45 | 		if (msg.get_sw_id() != SW_ID) {
 46 | 			// Ignore if not tagged by SW_ID
 47 | 			return;
 48 | 		}
 49 | 
 50 | 		if (_device_name_idx == 0) {
 51 | 			_device_name_idx = msg.get_result_data()[0];
 52 | 
 53 | 			this->_write_cb = [this](std::unique_ptr<uint8_t[]> buf) { this->device_name_cb(std::move(buf)); };
 54 | 
 55 | 			uint8_t wbuf[HIDPP_LONG_SIZE] = { HIDPP_LONG, dev_idx, _device_name_idx, 0x00 | SW_ID, 0x00, 0x05, 0x00 };
 56 | 			hid_write(_long_dev.get(), wbuf, HIDPP_LONG_SIZE);
 57 | 		}
 58 | 		else if (_battery_step == 0) {
 59 | 			_battery_1000_idx = msg.get_result_data()[0];
 60 | 
 61 | 			if (_battery_1000_idx == 0) {
 62 | 				_battery_step++;
 63 | 
 64 | 				uint8_t wbuf[HIDPP_LONG_SIZE] = { HIDPP_LONG, dev_idx, 0x00, 0x00 | SW_ID, 0x10, 0x01, 0x00 };
 65 | 				hid_write(_long_dev.get(), wbuf, HIDPP_LONG_SIZE);
 66 | 			}
 67 | 			else {
 68 | 				_ready = true;
 69 | 			}
 70 | 		}
 71 | 		else if (_battery_step == 1) {
 72 | 			_battery_1001_idx = msg.get_result_data()[0];
 73 | 
 74 | 			if (_battery_1001_idx == 0) {
 75 | 				_battery_step++;
 76 | 
 77 | 				uint8_t wbuf[HIDPP_LONG_SIZE] = { HIDPP_LONG, dev_idx, 0x00, 0x00 | SW_ID, 0x10, 0x01, 0x00 };
 78 | 				hid_write(_long_dev.get(), wbuf, HIDPP_LONG_SIZE);
 79 | 			}
 80 | 			else {
 81 | 				_ready = true;
 82 | 			}
 83 | 		}
 84 | 		else if (_battery_step == 2) {
 85 | 			_battery_1004_idx = msg.get_result_data()[0];
 86 | 
 87 | 			if (_battery_1004_idx == 0) {
 88 | 				std::cerr << "No Battery info" << std::endl;
 89 | 
 90 | 				this->_write_cb = nullptr;
 91 | 			}
 92 | 			else {
 93 | 				_ready = true;
 94 | 			}
 95 | 		}
 96 | 
 97 | 		if (_ready) {
 98 | 			std::cout << device_name << std::endl;
 99 | 			std::cout << (int) device_type << std::endl;
100 | 			std::cout << (int)_battery_1000_idx << std::endl;
101 | 			std::cout << (int)_battery_1001_idx << std::endl;
102 | 			std::cout << (int)_battery_1004_idx << std::endl;
103 | 
104 | 			this->_write_cb = [this](std::unique_ptr<uint8_t[]> buf) { this->battery_status_cb(std::move(buf)); };
105 | 
106 | 			MapWrapper::add_LogiDevice(this->dev_id, this->shared_from_this());
107 | 
108 | 			this->update_battery();
109 | 
110 | 			if (device_ready_cb) {
111 | 				device_ready_cb(*this);
112 | 			}
113 | 
114 | 			//std::cout << "{" << MapWrapper::to_json() << "}" << std::endl;
115 | 		}
116 | 	}
117 | 
118 | 	void LogiDevice::device_name_cb(std::unique_ptr<uint8_t[]> buf) {
119 | 		HIDPPMsg_20 msg(std::move(buf));
120 | 
121 | 		if (msg.get_feature_index() != _device_name_idx) {
122 | 			// Ignore if not device name response
123 | 			return;
124 | 		}
125 | 
126 | 		if (msg.get_sw_id() != SW_ID) {
127 | 			// Ignore if not tagged by SW_ID
128 | 			return;
129 | 		}
130 | 
131 | 		if (_device_name_step == 0) {
132 | 			_device_name_count = msg.get_result_data()[0];
133 | 			_device_name_step++;
134 | 
135 | 			uint8_t wbuf[HIDPP_LONG_SIZE] = { HIDPP_LONG, dev_idx, _device_name_idx, 0x10 | SW_ID, 0x00, 0x00, 0x00 };
136 | 			hid_write(_long_dev.get(), wbuf, HIDPP_LONG_SIZE);
137 | 		}
138 | 		else if (_device_name_step == 1) {
139 | 			bool device_name_fin = false;
140 | 			for (size_t i = 0; i < 16; i++) {
141 | 				device_name.push_back(msg.get_result_data()[i]);
142 | 
143 | 				if (device_name.length() == _device_name_count) {
144 | 					device_name_fin = true;
145 | 					break;
146 | 				}
147 | 			}
148 | 
149 | 			if (!device_name_fin) {
150 | 				uint8_t wbuf[HIDPP_LONG_SIZE] = { HIDPP_LONG, dev_idx, _device_name_idx, 0x10 | SW_ID, (uint8_t) device_name.length(), 0x00, 0x00 };
151 | 				hid_write(_long_dev.get(), wbuf, HIDPP_LONG_SIZE);
152 | 			}
153 | 			else {
154 | 				_device_name_step++;
155 | 
156 | 				uint8_t wbuf[HIDPP_LONG_SIZE] = { HIDPP_LONG, dev_idx, _device_name_idx, 0x20 | SW_ID, 0x00, 0x00, 0x00 };
157 | 				hid_write(_long_dev.get(), wbuf, HIDPP_LONG_SIZE);
158 | 			}
159 | 		}
160 | 		else if (_device_name_step == 2) {
161 | 			device_type = static_cast<LogiDeviceType>(msg.get_result_data()[0]);
162 | 
163 | 			this->_write_cb = [this](std::unique_ptr<uint8_t[]> buf) { this->feature_set_cb(std::move(buf)); };
164 | 
165 | 			uint8_t wbuf[HIDPP_LONG_SIZE] = { HIDPP_LONG, dev_idx, 0x00, 0x00 | SW_ID, 0x10, 0x00, 0x00 };
166 | 			hid_write(_long_dev.get(), wbuf, HIDPP_LONG_SIZE);
167 | 		}
168 | 	}
169 | 
170 | 	void LogiDevice::battery_status_cb(std::unique_ptr<uint8_t[]> buf) {
171 | 		HIDPPMsg_20 msg(std::move(buf));
172 | 
173 | 		int battery_voltage = -1;
174 | 		int battery_percentage = -1;
175 | 		Battery::Power_supply_status battery_status = Battery::Power_supply_status::POWER_SUPPLY_STATUS_UNKNOWN;
176 | 
177 | 		if ((_battery_1000_idx > 0) && (msg.get_feature_index() == _battery_1000_idx)) {
178 | 			std::tie(battery_percentage, battery_status) = Battery1000_parse(msg);
179 | 		}
180 | 		else if ((_battery_1001_idx > 0) && (msg.get_feature_index() == _battery_1001_idx)) {
181 | 			std::tie(battery_voltage, battery_percentage, battery_status) = Battery1001_parse(msg);
182 | 
183 | 			std::cout << (double)battery_percentage << std::endl;
184 | 			std::cout << (double)battery_status << std::endl;
185 | 		}
186 | 		else if ((_battery_1004_idx > 0) && (msg.get_feature_index() == _battery_1004_idx)) {
187 | 			std::tie(battery_percentage, battery_status) = Battery1004_parse(msg);
188 | 		}
189 | 		else {
190 | 			// STUB: Battery protocol not known
191 | 			return;
192 | 		}
193 | 
194 | 		bool _updated = false;
195 | 
196 | 		if (this->battery_percentage != battery_percentage) {
197 | 			this->battery_percentage = battery_percentage;
198 | 			_updated = true;
199 | 		}
200 | 
201 | 		if (this->battery_status != battery_status) {
202 | 			this->battery_status = battery_status;
203 | 			_updated = true;
204 | 		}
205 | 
206 | 		if (this->battery_voltage != battery_voltage) {
207 | 			this->battery_voltage = battery_voltage;
208 | 			_updated = true;
209 | 		}
210 | 
211 | 		_updated = true;
212 | 		if (_updated && battery_update_cb) {
213 | 			battery_update_cb(*this);
214 | 		}
215 | 	}
216 | 
217 | 	LogiDevice::LogiDevice(uint8_t dev_idx, std::string container_name, const std::shared_ptr<hid_device>& short_dev, const std::shared_ptr<hid_device>& long_dev) :
218 | 		dev_idx(dev_idx), _short_dev(short_dev), _long_dev(long_dev), dev_id(gen_dev_id(dev_idx, container_name)) {
219 | 		this->_write_cb = [this](std::unique_ptr<uint8_t[]> buf) { this->check_proto_ver_cb(std::move(buf)); };
220 | 	}
221 | 
222 | 	std::string LogiDevice::gen_dev_id(uint8_t dev_idx, std::string container_name)
223 | 	{
224 | 		return "dev" + container_name + std::to_string(dev_idx);
225 | 	}
226 | 
227 | 	std::shared_ptr<LogiDevice> LogiDevice::make_shared(uint8_t dev_idx, std::string container_name, const std::shared_ptr<hid_device>& short_dev, const std::shared_ptr<hid_device>& long_dev)
228 | 	{
229 | 		return std::shared_ptr<LogiDevice>(new LogiDevice(dev_idx, container_name, short_dev, long_dev));
230 | 	}
231 | 
232 | 	nlohmann::json LogiDevice::battery_summary() const
233 | 	{
234 | 		return 
235 | 		{
236 | 			{"deviceId", this->dev_id},
237 | 			{"percentage", this->battery_percentage.load()},
238 | 			{"charging", this->battery_status.load() == LGSTrayHID::Battery::Power_supply_status::POWER_SUPPLY_STATUS_CHARGING},
239 | 			{"mileage", -1.0},
240 | 			{"voltage", this->battery_voltage.load()}
241 | 		};
242 | 	}
243 | 
244 | 	nlohmann::json LogiDevice::device_summary() const
245 | 	{
246 | 		nlohmann::json ret = 
247 | 		{
248 | 			{"deviceType", LogiDeviceTypeEnumToString(this->device_type)},
249 | 			{"id", this->dev_id},
250 | 			{"extendedDisplayName", this->device_name}
251 | 		};
252 | 		ret["capabilities"]["hasBatteryStatus"] = true;
253 | 
254 | 		return ret;
255 | 	}
256 | 
257 | 	void LogiDevice::Register_battery_update_cb(Battery_update_cb cb)
258 | 	{
259 | 		battery_update_cb = cb;
260 | 	}
261 | 
262 | 	void LogiDevice::Register_device_ready_cb(Device_ready_cb cb) {
263 | 		device_ready_cb = cb;
264 | 	}
265 | 
266 | 	void LogiDevice::update_battery()
267 | 	{
268 | 		uint8_t battery_idx = _battery_1000_idx | _battery_1001_idx | _battery_1004_idx;
269 | 
270 | 		if (battery_idx == 0) {
271 | 			// STUB: Battery protocol not known
272 | 			return;
273 | 		}
274 | 
275 | 		uint8_t buf[HIDPP_LONG_SIZE] = { HIDPP_LONG, dev_idx, battery_idx,  0x00 | SW_ID };
276 | 		hid_write(this->_long_dev.get(), buf, HIDPP_LONG_SIZE);
277 | 	}
278 | 
279 | 	void LogiDevice::invoke_response(std::unique_ptr<uint8_t[]> buf)
280 | 	{
281 | 		if (_write_cb) {
282 | 			_write_cb(std::move(buf));
283 | 			//std::this_thread::sleep_for(std::chrono::milliseconds(10));
284 | 		}
285 | 	}
286 | }


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     <one line to give the program's name and a brief idea of what it does.>
635 |     Copyright (C) <year>  <name of author>
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <https://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     <program>  Copyright (C) <year>  <name of author>
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <https://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <https://www.gnu.org/licenses/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------