├── src ├── app ├── console_app_shell_type.h ├── main.cpp ├── ggroohauga │ ├── console.h │ ├── app.h │ └── device.h ├── app.cpp ├── console.cpp └── device.cpp ├── requirements.txt ├── .uuid-uk ├── requirements.txt └── Jenkinsfile ├── .gitmodules ├── .gitignore ├── Makefile ├── pio_local.ini.example ├── platformio.ini ├── README.rst └── COPYING /src/app: -------------------------------------------------------------------------------- 1 | ../app/src -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | pipenv 2 | -------------------------------------------------------------------------------- /.uuid-uk/requirements.txt: -------------------------------------------------------------------------------- 1 | ../requirements.txt -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "mcu-app"] 2 | path = app 3 | url = ../mcu-app 4 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /.cache/ 2 | /.pio/ 3 | /pio_local.ini 4 | /compile_commands.json 5 | -------------------------------------------------------------------------------- /.uuid-uk/Jenkinsfile: -------------------------------------------------------------------------------- 1 | @Library("uuid") _ 2 | 3 | platformioApplicationPipeline() 4 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: all clean upload compile_commands.json 2 | 3 | all: 4 | platformio run 5 | 6 | clean: 7 | platformio run -t clean 8 | rm -rf .pio 9 | 10 | upload: 11 | platformio run -t upload 12 | 13 | compile_commands.json: 14 | platformio run -t compiledb 15 | -------------------------------------------------------------------------------- /pio_local.ini.example: -------------------------------------------------------------------------------- 1 | [env:s3_lolin] 2 | build_src_flags = ${env.build_src_flags} 3 | -DOTA_URL="\"https://ota.test/ggroohauga/s3_lolin/firmware.bin\"" 4 | 5 | [env:s3_devkitc] 6 | build_src_flags = ${env.build_src_flags} 7 | -DOTA_URL="\"https://ota.test/ggroohauga/s3_devkitc/firmware.bin\"" 8 | 9 | [env:s3_devkitm] 10 | build_src_flags = ${env.build_src_flags} 11 | -DOTA_URL="\"https://ota.test/ggroohauga/s3_devkitm/firmware.bin\"" 12 | -------------------------------------------------------------------------------- /platformio.ini: -------------------------------------------------------------------------------- 1 | [platformio] 2 | extra_configs = 3 | app/pio/config.ini 4 | pio_local.ini 5 | 6 | [env] 7 | custom_app_name = ggroohauga 8 | 9 | [app:common] 10 | build_flags = ${env.build_flags} 11 | lib_deps = ${env.lib_deps} 12 | adafruit/Adafruit NeoPixel@^1.15.1 13 | extra_scripts = ${env.extra_scripts} 14 | 15 | [app:native_common] 16 | build_flags = 17 | 18 | [env:s3_lolin] 19 | extends = app:s3_lolin 20 | 21 | [env:s3_devkitc] 22 | extends = app:s3_devkitc 23 | 24 | [env:s3_devkitm] 25 | extends = app:s3_devkitm 26 | -------------------------------------------------------------------------------- /src/console_app_shell_type.h: -------------------------------------------------------------------------------- 1 | /* 2 | * ggroohauga - Alternative console and simulated amplifier interface 3 | * Copyright 2022 Simon Arlott 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with this program. If not, see . 17 | */ 18 | 19 | #define APP_SHELL_TYPE ::ggroohauga::GgroohaugaShell 20 | 21 | #include "ggroohauga/console.h" 22 | -------------------------------------------------------------------------------- /src/main.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | * ggroohauga - Alternative console and simulated amplifier interface 3 | * Copyright 2022 Simon Arlott 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with this program. If not, see . 17 | */ 18 | 19 | #include 20 | 21 | #include "esp32-hal.h" 22 | #include "ggroohauga/app.h" 23 | 24 | static ggroohauga::App application; 25 | 26 | void setup() { 27 | application.start(); 28 | } 29 | 30 | void loop() { 31 | application.loop(); 32 | ::yield(); 33 | } 34 | -------------------------------------------------------------------------------- /src/ggroohauga/console.h: -------------------------------------------------------------------------------- 1 | /* 2 | * ggroohauga - Alternative console and simulated amplifier interface 3 | * Copyright 2022,2024 Simon Arlott 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with this program. If not, see . 17 | */ 18 | 19 | #pragma once 20 | 21 | #include "app/console.h" 22 | 23 | #include 24 | #include 25 | #include 26 | 27 | namespace ggroohauga { 28 | 29 | class GgroohaugaShell: public app::AppShell { 30 | public: 31 | ~GgroohaugaShell() override = default; 32 | 33 | protected: 34 | GgroohaugaShell(app::App &app, Stream &stream, unsigned int context, unsigned int flags); 35 | 36 | void display_banner() override; 37 | }; 38 | 39 | } // namespace ggroohauga 40 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | Logitech® Z906 Surround Sound Speakers 2 | ====================================== 3 | 4 | Overview 5 | -------- 6 | 7 | Alternative console and simulated amplifier interface for the ESP32-S3 8 | microcontroller interacting with Logitech® Z906 Surround Sound Speakers. 9 | 10 | Glod picked up his horn. Cliff sat down and found his hammers. Buddy walked 11 | to the centre of the stage and, to Cliff's amazement, just stood there 12 | looking down at his feet. 13 | 14 | The cheering began to subside. And then it died away altogether. The huge 15 | hall was filled with the hush of hundreds of people holding their breath. 16 | 17 | Buddy's fingers moved. He picked out three simple little chords. And then he 18 | looked up. 19 | 20 | "Hello, Ankh-Morpork!" 21 | 22 | Cliff felt the music rise up behind him and rush him forward into a tunnel 23 | of fire and sparks and excitement. He brought his hammers down. And it was 24 | Music With Rocks In. 25 | 26 | -- `Terry Pratchett `_ 27 | (`Soul Music, 1994 `_) 28 | 29 | Purpose 30 | ------- 31 | 32 | Provide an unofficial alternative console (to control the amplifier directly 33 | without the original console) and simulated amplifier interface (to indirectly 34 | control an amplifier with the original console). 35 | 36 | Related Documentation 37 | --------------------- 38 | 39 | * `Console firmware/interface/protocol `_ 40 | 41 | Related Hardware 42 | --------------------- 43 | 44 | * `PCB to interface with the console/amplifier `_ 45 | 46 | Notices 47 | ------- 48 | 49 | "Logitech" is a trademark of `Logitech International SA `_. 50 | -------------------------------------------------------------------------------- /src/app.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | * ggroohauga - Alternative console and simulated amplifier interface 3 | * Copyright 2022,2025 Simon Arlott 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with this program. If not, see . 17 | */ 18 | 19 | #include "ggroohauga/app.h" 20 | 21 | #include 22 | 23 | namespace ggroohauga { 24 | 25 | App::App() 26 | : con_detect_(F("console"), F("detect"), CON_DETECT, LogicValue::Low, 27 | 5, 5, F("announce"), CON_ANNOUNCE, false, {}), 28 | con_(F("console"), con_serial_, CON_TX, CON_RX, false, { con_detect_ }), 29 | amp_detect_(F("amplifier"), F("detect"), AMP_DETECT, LogicValue::Low, 30 | 0, 0, F("announce"), AMP_ANNOUNCE, false, {}), 31 | power_(F("amplifier"), F("power-in"), AMP_POWER_IN, LogicValue::High, 32 | 5, 5, F("power-out"), CON_POWER_OUT, true, [this] (bool on) { 33 | if (on) { 34 | power_on(); 35 | } else { 36 | power_off(); 37 | } 38 | }), 39 | amp_(F("amplifier"), amp_serial_, AMP_TX, AMP_RX, true, { amp_detect_, power_ }) { 40 | } 41 | 42 | void App::start() { 43 | app::App::start(); 44 | 45 | con_.start(amp_); 46 | amp_.start(con_); 47 | amp_.activate(); 48 | amp_detect_.activate(); 49 | power_.activate(); 50 | led_.begin(); 51 | } 52 | 53 | void App::loop() { 54 | app::App::loop(); 55 | 56 | con_.loop(); 57 | amp_.loop(); 58 | 59 | if (millis() - last_led_ms_ >= 1000) { 60 | led_.show(); 61 | last_led_ms_ = millis(); 62 | } 63 | } 64 | 65 | void App::power_on() { 66 | con_.activate(); 67 | con_detect_.activate(); 68 | } 69 | 70 | void App::power_off() { 71 | con_detect_.deactivate(); 72 | con_.deactivate(); 73 | } 74 | 75 | 76 | } // namespace ggroohauga 77 | -------------------------------------------------------------------------------- /src/console.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | * ggroohauga - Alternative console and simulated amplifier interface 3 | * Copyright 2022 Simon Arlott 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with this program. If not, see . 17 | */ 18 | 19 | #include "ggroohauga/console.h" 20 | 21 | #include 22 | #include 23 | #include 24 | 25 | #include 26 | #include 27 | 28 | #include "ggroohauga/app.h" 29 | #include "app/config.h" 30 | #include "app/console.h" 31 | 32 | using ::uuid::flash_string_vector; 33 | using ::uuid::console::Commands; 34 | using ::uuid::console::Shell; 35 | using LogLevel = ::uuid::log::Level; 36 | using LogFacility = ::uuid::log::Facility; 37 | 38 | using ::app::AppShell; 39 | using ::app::CommandFlags; 40 | using ::app::Config; 41 | using ::app::ShellContext; 42 | 43 | #define MAKE_PSTR(string_name, string_literal) static const char __pstr__##string_name[] __attribute__((__aligned__(sizeof(int)))) PROGMEM = string_literal; 44 | #define MAKE_PSTR_WORD(string_name) MAKE_PSTR(string_name, #string_name) 45 | #define F_(string_name) FPSTR(__pstr__##string_name) 46 | 47 | namespace ggroohauga { 48 | 49 | #pragma GCC diagnostic push 50 | #pragma GCC diagnostic error "-Wunused-const-variable" 51 | #pragma GCC diagnostic pop 52 | 53 | static constexpr inline AppShell &to_app_shell(Shell &shell) { 54 | return static_cast(shell); 55 | } 56 | 57 | static constexpr inline App &to_app(Shell &shell) { 58 | return static_cast(to_app_shell(shell).app_); 59 | } 60 | 61 | static constexpr inline GgroohaugaShell &to_shell(Shell &shell) { 62 | return static_cast(shell); 63 | } 64 | 65 | #define NO_ARGUMENTS std::vector{} 66 | 67 | static inline void setup_commands(std::shared_ptr &commands) { 68 | 69 | } 70 | 71 | GgroohaugaShell::GgroohaugaShell(app::App &app, Stream &stream, unsigned int context, unsigned int flags) 72 | : AppShell(app, stream, context, flags) { 73 | 74 | } 75 | 76 | void GgroohaugaShell::display_banner() { 77 | AppShell::display_banner(); 78 | println(F("┌─────────────┐")); 79 | println(F("│ 🧙 DEAN │")); 80 | println(F("│ BORN TO 🤘 │")); 81 | println(F("│🎸 LIVE FATS │")); 82 | println(F("│DIE YO GNU 🎶│")); 83 | println(F("└─────────────┘")); 84 | println(); 85 | } 86 | 87 | } // namespace ggroohauga 88 | 89 | namespace app { 90 | 91 | void setup_commands(std::shared_ptr &commands) { 92 | ggroohauga::setup_commands(commands); 93 | } 94 | 95 | } // namespace app 96 | -------------------------------------------------------------------------------- /src/ggroohauga/app.h: -------------------------------------------------------------------------------- 1 | /* 2 | * ggroohauga - Alternative console and simulated amplifier interface 3 | * Copyright 2022,2025 Simon Arlott 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with this program. If not, see . 17 | */ 18 | 19 | #pragma once 20 | 21 | #include 22 | #include 23 | 24 | #include 25 | 26 | #include "app/app.h" 27 | #include "device.h" 28 | 29 | namespace ggroohauga { 30 | 31 | class App: public app::App { 32 | private: 33 | #if defined(ARDUINO_LOLIN_S3) 34 | static constexpr int LED_PIN = 38; 35 | 36 | static constexpr int CON_RX = 4; /* MCU TX (Console RX) */ 37 | static constexpr int CON_TX = 6; /* MCU RX (Console TX) */ 38 | static constexpr int CON_DETECT = 17; 39 | static constexpr int CON_ANNOUNCE = 41; /* no glitches on power cycle */ 40 | static constexpr int CON_POWER_OUT = 40; /* no glitches on power cycle */ 41 | static constexpr auto &con_serial_ = Serial1; 42 | 43 | static constexpr int AMP_RX = 10; /* MCU TX (Amplifier RX) */ 44 | static constexpr int AMP_TX = 9; /* MCU RX (Amplifier TX) */ 45 | static constexpr int AMP_DETECT = 21; 46 | static constexpr int AMP_ANNOUNCE = 13; 47 | static constexpr int AMP_POWER_IN = 8; 48 | static constexpr auto &_serial_ = Serial2; 49 | #elif defined(ARDUINO_ESP_S3_DEVKITC) 50 | static constexpr int LED_PIN = 38; 51 | 52 | static constexpr int CON_RX = 4; /* MCU TX (Console RX) */ 53 | static constexpr int CON_TX = 6; /* MCU RX (Console TX) */ 54 | static constexpr int CON_DETECT = 17; 55 | static constexpr int CON_ANNOUNCE = 41; /* no glitches on power cycle */ 56 | static constexpr int CON_POWER_OUT = 40; /* no glitches on power cycle */ 57 | static constexpr auto &con_serial_ = Serial1; 58 | 59 | static constexpr int AMP_RX = 10; /* MCU TX (Amplifier RX) */ 60 | static constexpr int AMP_TX = 9; /* MCU RX (Amplifier TX) */ 61 | static constexpr int AMP_DETECT = 21; 62 | static constexpr int AMP_ANNOUNCE = 47; 63 | static constexpr int AMP_POWER_IN = 8; 64 | static constexpr auto &_serial_ = Serial2; 65 | #elif defined(ARDUINO_ESP_S3_DEVKITM) 66 | static constexpr int LED_PIN = 48; 67 | 68 | static constexpr int CON_RX = 2; /* MCU TX (Console RX) */ 69 | static constexpr int CON_TX = 4; /* MCU RX (Console TX) */ 70 | static constexpr int CON_DETECT = 8; 71 | static constexpr int CON_ANNOUNCE = 42; /* no glitches on power cycle */ 72 | static constexpr int CON_POWER_OUT = 41; /* no glitches on power cycle */ 73 | static constexpr auto &con_serial_ = Serial1; 74 | 75 | static constexpr int AMP_RX = 14; /* MCU TX (Amplifier RX) */ 76 | static constexpr int AMP_TX = 13; /* MCU RX (Amplifier TX) */ 77 | static constexpr int AMP_DETECT = 21; 78 | static constexpr int AMP_ANNOUNCE = 26; 79 | static constexpr int AMP_POWER_IN = 10; 80 | static constexpr auto &_serial_ = Serial2; 81 | #else 82 | # error "Unknown board" 83 | #endif 84 | 85 | public: 86 | App(); 87 | 88 | void start() override; 89 | void loop() override; 90 | 91 | private: 92 | void power_on(); 93 | void power_off(); 94 | 95 | Proxy con_detect_; 96 | Device con_; 97 | Proxy amp_detect_; 98 | Proxy power_; 99 | Device amp_; 100 | 101 | Adafruit_NeoPixel led_{1, LED_PIN, NEO_GRB | NEO_KHZ800}; 102 | unsigned long last_led_ms_{0}; 103 | }; 104 | 105 | } // namespace ggroohauga 106 | -------------------------------------------------------------------------------- /src/ggroohauga/device.h: -------------------------------------------------------------------------------- 1 | /* 2 | * ggroohauga - Alternative console and simulated amplifier interface 3 | * Copyright 2022,2025 Simon Arlott 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with this program. If not, see . 17 | */ 18 | 19 | #pragma once 20 | 21 | #include 22 | 23 | #include 24 | #include 25 | 26 | #include 27 | 28 | #include "app/app.h" 29 | 30 | namespace ggroohauga { 31 | 32 | enum class LogicValue : int8_t { 33 | Low = -1, 34 | Unknown = 0, 35 | High = 1, 36 | }; 37 | 38 | inline int operator*(const LogicValue &value) { 39 | return value == LogicValue::Low ? LOW : HIGH; 40 | } 41 | 42 | inline LogicValue& operator<<(LogicValue &lhs, const int &rhs) { 43 | return lhs = (rhs == LOW ? LogicValue::Low : LogicValue::High); 44 | } 45 | 46 | inline int& operator<<(int &lhs, const LogicValue &rhs) { 47 | return lhs = *rhs; 48 | } 49 | 50 | inline const __FlashStringHelper* to_string(const LogicValue &value) { 51 | switch (value) { 52 | case LogicValue::Low: 53 | return F("LOW"); 54 | case LogicValue::High: 55 | return F("HIGH"); 56 | case LogicValue::Unknown: 57 | break; 58 | } 59 | return F("UNKNOWN"); 60 | } 61 | 62 | inline LogicValue operator!(const LogicValue &value) { 63 | switch (value) { 64 | case LogicValue::Low: 65 | return LogicValue::High; 66 | case LogicValue::High: 67 | return LogicValue::Low; 68 | case LogicValue::Unknown: 69 | break; 70 | } 71 | return LogicValue::Unknown; 72 | } 73 | 74 | class Device; 75 | 76 | class Monitor { 77 | public: 78 | Monitor(const __FlashStringHelper *name, uint8_t pin, uint8_t mode); 79 | virtual ~Monitor() = default; 80 | 81 | Monitor(const Monitor&) = delete; 82 | Monitor& operator=(const Monitor&) = delete; 83 | 84 | virtual void start(Device *device = nullptr); 85 | virtual void activate(); 86 | virtual void deactivate(); 87 | virtual void loop(); 88 | 89 | protected: 90 | virtual void changed(LogicValue value); 91 | 92 | uuid::log::Logger logger_; 93 | Device *device_ = nullptr; 94 | 95 | private: 96 | const uint8_t pin_; 97 | const uint8_t mode_; 98 | bool suspend_ = true; 99 | LogicValue value_ = LogicValue::Unknown; 100 | }; 101 | 102 | class Proxy: public Monitor { 103 | public: 104 | Proxy(const __FlashStringHelper *name, 105 | const __FlashStringHelper *src_name, uint8_t src_pin, 106 | LogicValue on_state, unsigned long debounce_on_millis, 107 | unsigned long hold_off_millis, const __FlashStringHelper *dst_name, 108 | uint8_t dst_pin, bool invert, 109 | std::function change_func); 110 | 111 | Proxy(const Proxy&) = delete; 112 | Proxy& operator=(const Proxy&) = delete; 113 | 114 | void start(Device *device = nullptr) override; 115 | void activate() override; 116 | void deactivate() override; 117 | void loop() override; 118 | 119 | protected: 120 | void changed(LogicValue value) override; 121 | 122 | private: 123 | void update(LogicValue value); 124 | void log(LogicValue value); 125 | 126 | const __FlashStringHelper *src_name_; 127 | const __FlashStringHelper *dst_name_; 128 | const uint8_t src_pin_; 129 | const uint8_t dst_pin_; 130 | const LogicValue on_state_; 131 | const unsigned long debounce_on_millis_; 132 | const unsigned long hold_off_millis_; 133 | const bool invert_; 134 | bool suspend_ = true; 135 | LogicValue dst_value_ = LogicValue::Unknown; 136 | bool on_pending_ = false; 137 | bool hold_ = false; 138 | unsigned long debounce_start_millis_; 139 | unsigned long hold_start_millis_; 140 | std::function change_func_; 141 | }; 142 | 143 | class Device { 144 | public: 145 | static constexpr int BAUD_RATE = 57600; 146 | static constexpr int UART_CONFIG = SERIAL_8O1; 147 | static constexpr size_t MAX_MESSAGE_LEN = 259; 148 | 149 | Device(const __FlashStringHelper *name, HardwareSerial &serial, 150 | uint8_t rx_pin, uint8_t tx_pin, bool wait, 151 | const std::vector> &proxies); 152 | 153 | Device(const Device&) = delete; 154 | Device& operator=(const Device&) = delete; 155 | 156 | void start(Device &other); 157 | void activate(); 158 | void deactivate(); 159 | void loop(); 160 | void report_both(); 161 | 162 | private: 163 | static constexpr unsigned long MAX_REPORT_DELAY_MS = 45; 164 | 165 | void report(); 166 | 167 | uuid::log::Logger logger_; 168 | HardwareSerial &serial_; 169 | const uint8_t rx_pin_; 170 | const uint8_t tx_pin_; 171 | const bool wait_for_other_; 172 | std::vector> proxies_; 173 | Device *other_; 174 | bool waiting_; 175 | 176 | bool suspend_ = true; 177 | std::vector buffer_; 178 | unsigned long last_millis_; 179 | }; 180 | 181 | } // namespace ggroohauga 182 | -------------------------------------------------------------------------------- /src/device.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | * ggroohauga - Alternative console and simulated amplifier interface 3 | * Copyright 2022,2025 Simon Arlott 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with this program. If not, see . 17 | */ 18 | 19 | #include "ggroohauga/device.h" 20 | 21 | #include 22 | 23 | #include 24 | #include 25 | 26 | #include 27 | 28 | namespace ggroohauga { 29 | 30 | Device::Device(const __FlashStringHelper *name, HardwareSerial &serial, 31 | uint8_t rx_pin, uint8_t tx_pin, bool wait, 32 | const std::vector> &proxies) 33 | : logger_(name, uuid::log::Facility::UUCP), serial_(serial), 34 | rx_pin_(rx_pin), tx_pin_(tx_pin), wait_for_other_(wait), 35 | proxies_(proxies) { 36 | 37 | } 38 | 39 | void Device::start(Device &other) { 40 | other_ = &other; 41 | waiting_ = wait_for_other_; 42 | 43 | for (auto &proxy : proxies_) { 44 | proxy.get().start(this); 45 | } 46 | } 47 | 48 | void Device::activate() { 49 | if (suspend_) { 50 | suspend_ = false; 51 | 52 | logger_.trace(F("Activate serial")); 53 | serial_.begin(BAUD_RATE, UART_CONFIG, rx_pin_, tx_pin_); 54 | waiting_ = wait_for_other_; 55 | } 56 | } 57 | 58 | void Device::deactivate() { 59 | if (!suspend_) { 60 | suspend_ = true; 61 | 62 | logger_.trace(F("Deactivate serial")); 63 | serial_.end(); 64 | buffer_.clear(); 65 | } 66 | } 67 | 68 | void Device::loop() { 69 | unsigned long now_ms = millis(); 70 | int data = 0; 71 | 72 | for (auto &proxy : proxies_) { 73 | proxy.get().loop(); 74 | } 75 | 76 | if (suspend_) { 77 | return; 78 | } 79 | 80 | do { 81 | int available_rx = serial_.available(); 82 | int available_tx = serial_.available(); 83 | 84 | if (available_rx <= 0 || available_tx <= 0) { 85 | break; 86 | } 87 | 88 | while (available_rx-- > 0 && available_tx-- > 0) { 89 | data = serial_.read(); 90 | 91 | if (data == -1) { 92 | break; 93 | } 94 | 95 | if (!other_->buffer_.empty()) { 96 | other_->report(); 97 | } 98 | 99 | if (data == 0xAA 100 | && !buffer_.empty() 101 | && buffer_[0] != 0xAA) { 102 | report(); 103 | } 104 | 105 | buffer_.push_back(data); 106 | if (!waiting_) { 107 | other_->serial_.write(data); 108 | other_->waiting_ = false; 109 | } 110 | 111 | if (buffer_.size() == MAX_MESSAGE_LEN) { 112 | report(); 113 | } else if (buffer_.size() >= 4 114 | && buffer_[0] == 0xAA 115 | && buffer_.size() >= buffer_[2] + 4) { 116 | report(); 117 | } 118 | 119 | now_ms = millis(); 120 | last_millis_ = now_ms; 121 | } 122 | } while (data != -1); 123 | 124 | if (!buffer_.empty() && now_ms - last_millis_ >= MAX_REPORT_DELAY_MS) { 125 | report(); 126 | } 127 | } 128 | 129 | void Device::report_both() { 130 | other_->report(); 131 | report(); 132 | } 133 | 134 | void Device::report() { 135 | if (logger_.enabled(uuid::log::Level::TRACE)) { 136 | static constexpr uint8_t BYTES_PER_LINE = 24; 137 | static constexpr uint8_t CHARS_PER_BYTE = 3; 138 | std::array message{}; 139 | uint8_t pos = 0; 140 | 141 | for (uint16_t i = 0; i < buffer_.size(); i++) { 142 | snprintf_P(&message[CHARS_PER_BYTE * pos++], CHARS_PER_BYTE + 1, 143 | PSTR(" %02X"), buffer_[i]); 144 | 145 | if (pos == BYTES_PER_LINE || i == buffer_.size() - 1) { 146 | logger_.trace(F("%s%S"), &message.data()[1], 147 | waiting_ ? F(" [discarded]") : F("")); 148 | pos = 0; 149 | } 150 | } 151 | } 152 | 153 | buffer_.clear(); 154 | } 155 | 156 | Monitor::Monitor(const __FlashStringHelper *name, uint8_t pin, uint8_t mode) 157 | : logger_(name, uuid::log::Facility::UUCP), pin_(pin), mode_(mode) { 158 | 159 | } 160 | 161 | void Monitor::start(Device *device) { 162 | device_ = device; 163 | logger_.trace(F("Pin %d: high-impedance"), pin_); 164 | pinMode(pin_, INPUT); 165 | } 166 | 167 | void Monitor::activate() { 168 | if (suspend_) { 169 | suspend_ = false; 170 | 171 | if (mode_ == INPUT_PULLUP) { 172 | logger_.trace(F("Pin %d: pull-up"), pin_); 173 | } else if (mode_ == INPUT_PULLDOWN) { 174 | logger_.trace(F("Pin %d: pull-down"), pin_); 175 | } else { 176 | logger_.trace(F("Pin %d: high-impedance"), pin_); 177 | } 178 | pinMode(pin_, mode_); 179 | } 180 | } 181 | 182 | void Monitor::deactivate() { 183 | if (!suspend_) { 184 | suspend_ = true; 185 | value_ = LogicValue::Unknown; 186 | logger_.trace(F("Pin %d: high-impedance"), pin_); 187 | pinMode(pin_, INPUT); 188 | } 189 | } 190 | 191 | void Monitor::loop() { 192 | LogicValue value; 193 | 194 | if (suspend_) { 195 | return; 196 | } 197 | 198 | value << digitalRead(pin_); 199 | 200 | if (value != value_) { 201 | changed(value); 202 | value_ = value; 203 | } 204 | } 205 | 206 | void Monitor::changed(LogicValue value) { 207 | if (device_) 208 | device_->report_both(); 209 | 210 | logger_.trace(F("Pin %d: %S"), pin_, 211 | value == LogicValue::High ? F("HIGH") : F("LOW")); 212 | } 213 | 214 | Proxy::Proxy(const __FlashStringHelper *name, 215 | const __FlashStringHelper *src_name, uint8_t src_pin, 216 | LogicValue on_state, unsigned long debounce_on_millis, 217 | unsigned long hold_off_millis, const __FlashStringHelper *dst_name, 218 | uint8_t dst_pin, bool invert, std::function change_func) 219 | : Monitor(name, src_pin, 220 | on_state == LogicValue::High ? INPUT_PULLDOWN : INPUT_PULLUP), 221 | src_name_(src_name), dst_name_(dst_name), src_pin_(src_pin), 222 | dst_pin_(dst_pin), on_state_(on_state), 223 | debounce_on_millis_(debounce_on_millis), 224 | hold_off_millis_(hold_off_millis), 225 | invert_(invert), change_func_(change_func) { 226 | 227 | } 228 | 229 | void Proxy::start(Device *device) { 230 | Monitor::start(device); 231 | pinMode(dst_pin_, INPUT); 232 | } 233 | 234 | void Proxy::activate() { 235 | Monitor::activate(); 236 | 237 | if (suspend_) { 238 | suspend_ = false; 239 | 240 | logger_.trace(F("Activate pin %d (%S) -> %d (%S)"), 241 | src_pin_, src_name_, dst_pin_, dst_name_); 242 | 243 | if (dst_value_ != LogicValue::Unknown) { 244 | LogicValue input_value = invert_ ? !dst_value_ : dst_value_; 245 | 246 | digitalWrite(dst_pin_, *dst_value_); 247 | pinMode(dst_pin_, OUTPUT); 248 | 249 | logger_.trace(F("Pin %d (%S) -> %d (%S): %S (%S -> %S) [unsuspended]"), 250 | src_pin_, src_name_, dst_pin_, dst_name_, 251 | input_value == on_state_ ? F("on") : F("off"), 252 | to_string(input_value), to_string(dst_value_)); 253 | 254 | if (input_value == on_state_ && change_func_) { 255 | change_func_(true); 256 | } 257 | } 258 | } 259 | } 260 | 261 | void Proxy::deactivate() { 262 | if (!suspend_) { 263 | LogicValue input_value = invert_ ? !dst_value_ : dst_value_; 264 | 265 | suspend_ = true; 266 | 267 | logger_.trace(F("Deactivate pin %d (%S) -> %d (%S)"), 268 | src_pin_, src_name_, dst_pin_, dst_name_); 269 | 270 | pinMode(dst_pin_, INPUT); 271 | 272 | if (input_value == on_state_ && change_func_) { 273 | change_func_(false); 274 | } 275 | 276 | dst_value_ = LogicValue::Unknown; 277 | } 278 | 279 | Monitor::deactivate(); 280 | } 281 | 282 | void Proxy::loop() { 283 | Monitor::loop(); 284 | 285 | if (hold_ && ::millis() - hold_start_millis_ >= hold_off_millis_) { 286 | hold_ = false; 287 | } 288 | 289 | if (on_pending_ && !hold_ 290 | && ::millis() - debounce_start_millis_ >= debounce_on_millis_) { 291 | device_->report_both(); 292 | 293 | update(on_state_); 294 | on_pending_ = false; 295 | } 296 | } 297 | 298 | void Proxy::changed(LogicValue value) { 299 | device_->report_both(); 300 | 301 | if (value == on_state_) { 302 | if (debounce_on_millis_ > 0) { 303 | debounce_start_millis_ = ::millis(); 304 | on_pending_ = true; 305 | } else if (hold_) { 306 | on_pending_ = true; 307 | } 308 | 309 | if (on_pending_) { 310 | log(value); 311 | } else { 312 | update(value); 313 | } 314 | } else { 315 | if (hold_off_millis_ > 0 && dst_value_ != LogicValue::Unknown) { 316 | hold_ = true; 317 | hold_start_millis_ = ::millis(); 318 | } 319 | 320 | on_pending_ = false; 321 | update(value); 322 | } 323 | } 324 | 325 | void Proxy::update(LogicValue value) { 326 | LogicValue output_value = invert_ ? !value : value; 327 | 328 | if (dst_value_ != output_value) { 329 | bool suspended = suspend_; 330 | 331 | dst_value_ = output_value; 332 | 333 | if (!suspend_ && value != on_state_ && change_func_) { 334 | change_func_(false); 335 | } 336 | 337 | if (suspend_) { 338 | logger_.trace(F("Pin %d (%S) -> %d (%S): %S (%S -> %S) [suspended]"), 339 | src_pin_, src_name_, dst_pin_, dst_name_, 340 | value == on_state_ ? F("on") : F("off"), 341 | to_string(value), to_string(output_value)); 342 | } else { 343 | if (!suspended) { 344 | digitalWrite(dst_pin_, *output_value); 345 | pinMode(dst_pin_, OUTPUT); 346 | 347 | logger_.trace(F("Pin %d (%S) -> %d (%S): %S (%S -> %S)"), 348 | src_pin_, src_name_, dst_pin_, dst_name_, 349 | value == on_state_ ? F("on") : F("off"), 350 | to_string(value), to_string(output_value)); 351 | } 352 | 353 | if (value == on_state_ && change_func_) { 354 | change_func_(true); 355 | } 356 | } 357 | } else { 358 | log(value); 359 | } 360 | } 361 | 362 | void Proxy::log(LogicValue value) { 363 | logger_.trace(F("Pin %d (%S): %S (%S)%S%S"), 364 | src_pin_, src_name_, 365 | value == on_state_ ? F("on") : F("off"), to_string(value), 366 | (on_pending_ && debounce_on_millis_ > 0) ? F(" [debounce]") : F(""), 367 | hold_ ? F(" [hold]") : F("")); 368 | } 369 | 370 | } // namespace ggroohauga 371 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 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 | 635 | Copyright (C) 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 . 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 | Copyright (C) 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 | . 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 | . 675 | --------------------------------------------------------------------------------