├── .gitignore ├── berry ├── autoexec.be └── led.be ├── README.md ├── .github ├── FUNDING.yml └── workflows │ └── build_release.yml ├── config ├── platformio_tasmota_user_env.ini ├── platformio_override.ini └── user_config_override.h └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | Tasmota 2 | *code* -------------------------------------------------------------------------------- /berry/autoexec.be: -------------------------------------------------------------------------------- 1 | load("led.be") -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Uni GW 2 | 3 | Universal gateway for OpenTherm/eBus/RS485 4 | 5 | Firmware is custom Tasmota build 6 | -------------------------------------------------------------------------------- /berry/led.be: -------------------------------------------------------------------------------- 1 | import animate 2 | var strip = Leds(1, gpio.pin(gpio.WS2812, 0)) 3 | var anim = animate.core(strip, 100) 4 | var pulse = animate.pulse(0x000000, 1, 1) 5 | var palette = animate.palette(animate.PALETTE_STANDARD_TAG, 10000) 6 | palette.set_cb(pulse, pulse.set_color) 7 | anim.start() -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: xyzroe 4 | patreon: # Replace with a single Patreon username 5 | open_collective: # Replace with a single Open Collective username 6 | ko_fi: # Replace with a single Ko-fi username 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry 12 | polar: # Replace with a single Polar username 13 | buy_me_a_coffee: xyzroe 14 | custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] 15 | -------------------------------------------------------------------------------- /config/platformio_tasmota_user_env.ini: -------------------------------------------------------------------------------- 1 | [env:UniGW-MindBrd_WT32-ETH01] 2 | extends = env:tasmota32_base 3 | build_flags = ${env:tasmota32_base.build_flags} 4 | -DUGW_MB_ETH01 5 | -DCLEAR_BUILD 6 | 7 | [env:UniGW-MindBrd_Wemos32] 8 | extends = env:tasmota32_base 9 | build_flags = ${env:tasmota32_base.build_flags} 10 | -DUGW_MB_WMS32 11 | -DCLEAR_BUILD 12 | 13 | [env:UniGW_T-Internet-COM] 14 | extends = env:tasmota32_base 15 | build_flags = ${env:tasmota32_base.build_flags} 16 | -DFIRMWARE_TASMOTA32 17 | -DUGW_T-INET 18 | custom_files_upload = ../berry/autoexec.be 19 | ../berry/led.be 20 | 21 | [env:UniGW_Wemos-D1_mini] 22 | board = esp8266_4M2M 23 | build_flags = ${env.build_flags} 24 | -DCODE_IMAGE_STR='"tasmota-4M"' 25 | -DCLEAR_BUILD 26 | -DUGW_WMS_D1M 27 | -------------------------------------------------------------------------------- /config/platformio_override.ini: -------------------------------------------------------------------------------- 1 | ; *** Example PlatformIO Project Configuration Override File *** 2 | ; *** Changes done here override settings in platformio.ini *** 3 | ; 4 | ; ***************************************************************** 5 | ; *** to activate rename this file to platformio_override.ini *** 6 | ; ***************************************************************** 7 | ; 8 | ; Please visit documentation for the options and examples 9 | ; http://docs.platformio.org/en/stable/projectconf.html 10 | 11 | [platformio] 12 | ; For best Gitpod performance remove the ";" in the next line. Needed Platformio files are cached and installed at first run 13 | ;core_dir = .platformio 14 | ; For unrelated compile errors with Windows it can help to shorten Platformio project path 15 | ;workspace_dir = c:\.pio 16 | extra_configs = platformio_tasmota_user_env.ini 17 | 18 | ; *** Build/upload environment 19 | default_envs = 20 | UniGW-MindBrd_WT32-ETH01 21 | UniGW-MindBrd_Wemos32 22 | UniGW_T-Internet-COM 23 | UniGW_Wemos-D1_mini 24 | ; tasmota 25 | ; tasmota32 26 | 27 | [tasmota] 28 | ; *** Global build / unbuild compile time flags for ALL Tasmota / Tasmota32 [env] 29 | ;build_unflags = 30 | build_flags = -DUSE_BERRY_PARTITION_WIZARD 31 | 32 | [env] 33 | ;build_unflags = ${common.build_unflags} 34 | ; -Wswitch-unreachable 35 | ;build_flags = ${common.build_flags} 36 | ; -DF_CRYSTAL=26000000 37 | ; -Wno-switch-unreachable 38 | ; *** Optional Debug messages 39 | ; -DDEBUG_TASMOTA_CORE 40 | ; -DDEBUG_TASMOTA_DRIVER 41 | ; -DDEBUG_TASMOTA_SENSOR 42 | ; Build variant 1MB = 1MB firmware no filesystem (default) 43 | ;board = ${common.board} 44 | ; Build variant 2MB = 1MB firmware, 1MB filesystem (most Shelly devices) 45 | ;board = esp8266_2M1M 46 | ; Build variant 4MB = 1MB firmware, 1MB OTA, 2MB filesystem (WEMOS D1 Mini, NodeMCU, Sonoff POW) 47 | ;board = esp8266_4M2M 48 | ;board_build.f_cpu = 160000000L 49 | ;board_build.f_flash = 40000000L 50 | ; *** Define serial port used for erasing/flashing/terminal 51 | ;upload_port = COM4 52 | ;monitor_port = COM4 53 | lib_extra_dirs = ${library.lib_extra_dirs} 54 | 55 | [env:tasmota32_base] 56 | framework = ${common.framework} 57 | platform = ${core32.platform} 58 | platform_packages = ${core32.platform_packages} 59 | board_build.filesystem = ${common.board_build.filesystem} 60 | custom_unpack_dir = ${common.custom_unpack_dir} 61 | board_build.variants_dir = ${common.board_build.variants_dir} 62 | board = esp32 63 | monitor_speed = ${common.monitor_speed} 64 | monitor_echo = ${common.monitor_echo} 65 | upload_resetmethod = ${common.upload_resetmethod} 66 | extra_scripts = ${esp32_defaults.extra_scripts} 67 | build_unflags = ${core32.build_unflags} 68 | build_flags = ${core32.build_flags} 69 | lib_ldf_mode = ${common.lib_ldf_mode} 70 | lib_compat_mode = ${common.lib_compat_mode} 71 | lib_extra_dirs = ${common.lib_extra_dirs} 72 | lib/libesp32 73 | ;lib/libesp32_lvgl 74 | ;lib/libesp32_audio 75 | lib_ignore = ${esp32_defaults.lib_ignore} 76 | MFRC522 77 | universal display Library 78 | ESP8266Audio 79 | ESP8266SAM 80 | ;FFat 81 | ;SD 82 | ;SD_MMC 83 | UdpListener 84 | ;Berry 85 | ;Berry mapping to C 86 | ;Berry Tasmota mapping 87 | ;Berry int64 implementation for 32 bits architecture 88 | ;Berry Matter protocol implementation 89 | Micro-RTSP 90 | TTGO TWatch Library 91 | epdiy 92 | ; Add files to Filesystem for all env (global). Remove no files entry and add add a line with the file to include 93 | ; Example for adding the Partition Manager 94 | ; custom_files_upload = 95 | ; tasmota/berry/modules/Partition_Manager.tapp 96 | custom_files_upload = no_files 97 | 98 | 99 | [library] 100 | shared_libdeps_dir = lib 101 | ; *** Library disable / enable for variant Tasmota(32). Disable reduces compile time 102 | ; *** !!! Disabling needed libs will generate compile errors !!! 103 | ; *** The resulting firmware will NOT be different if you leave all libs enabled 104 | ; *** Disabling by putting a ";" in front of the lib name 105 | ; *** If you dont know what it is all about, do not change 106 | lib_extra_dirs = 107 | ; *** Only disabled for Tasmota minimal and Tasmota light. For all other variants needed! 108 | lib/lib_basic 109 | ; **** I2C devices. Most sensors. Disable only if you dont have ANY I2C device enabled 110 | lib/lib_i2c 111 | ; *** Displays. Disable if you dont have any Display activated 112 | ; lib/lib_display 113 | ; *** Bear SSL and base64. Disable if you dont have SSL or TLS activated 114 | lib/lib_ssl 115 | ; *** Audio needs a lot of time to compile. Mostly not used functions. Recommended to disable 116 | ; lib/lib_audio 117 | ; *** RF 433 stuff (not RF Bridge). Recommended to disable 118 | ; lib/lib_rf 119 | ; *** Mostly not used functions. Recommended to disable 120 | lib/lib_div 121 | -------------------------------------------------------------------------------- /.github/workflows/build_release.yml: -------------------------------------------------------------------------------- 1 | name: Build firmware and release 2 | 3 | permissions: 4 | contents: write 5 | 6 | on: 7 | workflow_dispatch: 8 | push: 9 | tags: 10 | - "v*" # Push events to matching v*, i.e. v1.0, v20.15.10 11 | 12 | jobs: 13 | build_safeboot_images: 14 | runs-on: ubuntu-latest 15 | continue-on-error: true 16 | strategy: 17 | matrix: 18 | variant: 19 | - tasmota32-safeboot 20 | steps: 21 | - name: Checkout UniGW repository 22 | uses: actions/checkout@v3 23 | - name: Clone Tasmota repository 24 | run: | 25 | git clone https://github.com/arendst/Tasmota.git 26 | - name: Set up Python 27 | uses: actions/setup-python@v4 28 | with: 29 | python-version: '3.x' 30 | - name: Install dependencies 31 | run: | 32 | pip install wheel 33 | pip install -U platformio 34 | cp Tasmota/platformio_override_sample.ini Tasmota/platformio_override.ini 35 | - name: Run PlatformIO 36 | run: | 37 | cd Tasmota 38 | platformio run -e ${{ matrix.variant }} 39 | - name: Upload safeboot firmware artifacts 40 | uses: actions/upload-artifact@v3 41 | with: 42 | name: firmware_safeboot 43 | path: Tasmota/build_output 44 | 45 | build_firmware_8266: 46 | runs-on: ubuntu-latest 47 | continue-on-error: true 48 | strategy: 49 | matrix: 50 | variant: 51 | - UniGW_Wemos-D1_mini 52 | steps: 53 | - name: Checkout UniGW repository 54 | uses: actions/checkout@v3 55 | - name: Clone Tasmota repository, add custom files 56 | run: | 57 | git clone https://github.com/arendst/Tasmota.git 58 | echo "git clone Tasmota - ok" 59 | cp config/platformio_tasmota_user_env.ini Tasmota/platformio_tasmota_user_env.ini 60 | echo "platformio_tasmota_user_env.ini - copy ok" 61 | cp config/platformio_override.ini Tasmota/platformio_override.ini 62 | echo "platformio_override.ini - copy ok" 63 | cp config/user_config_override.h Tasmota/tasmota/user_config_override.h 64 | echo "user_config_override.h - copy ok" 65 | - name: Set up Python 66 | uses: actions/setup-python@v4 67 | with: 68 | python-version: '3.x' 69 | - name: Install dependencies 70 | run: | 71 | pip install wheel 72 | pip install -U platformio 73 | - name: Run PlatformIO 74 | run: | 75 | cd Tasmota 76 | platformio run -e ${{ matrix.variant }} 77 | - name: Upload firmware artifacts 78 | uses: actions/upload-artifact@v3 79 | with: 80 | name: firmware_8266 81 | path: Tasmota/build_output 82 | 83 | build_firmware_32: 84 | needs: build_safeboot_images 85 | runs-on: ubuntu-latest 86 | continue-on-error: true 87 | strategy: 88 | matrix: 89 | variant: 90 | - UniGW-MindBrd_Wemos32 91 | - UniGW-MindBrd_WT32-ETH01 92 | - UniGW_T-Internet-COM 93 | steps: 94 | - name: Checkout UniGW repository 95 | uses: actions/checkout@v3 96 | - name: Clone Tasmota repository, add custom files 97 | run: | 98 | git clone https://github.com/arendst/Tasmota.git 99 | echo "git clone Tasmota - ok" 100 | cp config/platformio_tasmota_user_env.ini Tasmota/platformio_tasmota_user_env.ini 101 | echo "platformio_tasmota_user_env.ini - copy ok" 102 | cp config/platformio_override.ini Tasmota/platformio_override.ini 103 | echo "platformio_override.ini - copy ok" 104 | cp config/user_config_override.h Tasmota/tasmota/user_config_override.h 105 | echo "user_config_override.h - copy ok" 106 | - name: Set up Python 107 | uses: actions/setup-python@v4 108 | with: 109 | python-version: "3.x" 110 | - name: Install dependencies 111 | run: | 112 | pip install wheel 113 | pip install -U platformio 114 | - name: Download safeboot firmwares 115 | uses: actions/download-artifact@v3 116 | with: 117 | name: firmware_safeboot 118 | path: Tasmota/firmware 119 | - name: Display downloaded files 120 | run: | 121 | ls -R Tasmota/firmware/ 122 | - name: Run PlatformIO 123 | run: | 124 | cd Tasmota 125 | platformio run -e ${{ matrix.variant }} 126 | - name: Upload firmware artifacts 127 | uses: actions/upload-artifact@v3 128 | with: 129 | name: firmware 130 | path: Tasmota/build_output 131 | 132 | release_firmware: 133 | runs-on: ubuntu-latest 134 | needs: [build_firmware_32, build_firmware_8266] 135 | steps: 136 | - name: Clone UniGW repository 137 | run: | 138 | git clone https://github.com/xyzroe/UniGW.git 139 | echo "git clone UniGW - ok" 140 | - name: Get latest FW Release Version 141 | id: fw_version 142 | shell: bash 143 | run: | 144 | cd UniGW 145 | value=$(git describe --tags $(git rev-list --tags --max-count=1)) 146 | echo "fw_version=$value" >> $GITHUB_OUTPUT 147 | - name: Git clone Tasmota 148 | run: | 149 | git clone https://github.com/arendst/Tasmota.git 150 | echo "git clone Tasmota - ok" 151 | - name: Download firmwares ESP32 152 | uses: actions/download-artifact@v3 153 | with: 154 | name: firmware 155 | path: Tasmota/firmware 156 | - name: Download firmwares ESP8266 157 | uses: actions/download-artifact@v3 158 | with: 159 | name: firmware_8266 160 | path: Tasmota/firmware 161 | - name: Display downloaded files 162 | run: | 163 | ls -R Tasmota/firmware/ 164 | - name: Get latest Tasmota Release Version 165 | id: tasmota_version 166 | shell: bash 167 | run: | 168 | cd Tasmota 169 | value=$(git describe --tags $(git rev-list --tags --max-count=1)) 170 | echo "tasmota_version=$value" >> $GITHUB_OUTPUT 171 | - name: Get current date 172 | id: date 173 | run: echo "date=$(date +'%d%m%y')" >> $GITHUB_OUTPUT 174 | - name: Release 175 | uses: softprops/action-gh-release@v1 176 | with: 177 | generate_release_notes: true 178 | tag_name: ${{ steps.fw_version.outputs.fw_version }} 179 | name: "${{ steps.fw_version.outputs.fw_version }} (${{ steps.date.outputs.date }}, ${{ steps.tasmota_version.outputs.tasmota_version }})" 180 | files: | 181 | Tasmota/firmware/firmware/* -------------------------------------------------------------------------------- /config/user_config_override.h: -------------------------------------------------------------------------------- 1 | /* 2 | user_config_override.h - user configuration overrides my_user_config.h for Tasmota 3 | 4 | Copyright (C) 2021 Theo Arends 5 | 6 | This program is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU General Public License as published by 8 | the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | 11 | This program is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU General Public License for more details. 15 | 16 | You should have received a copy of the GNU General Public License 17 | along with this program. If not, see . 18 | */ 19 | 20 | #ifndef _USER_CONFIG_OVERRIDE_H_ 21 | #define _USER_CONFIG_OVERRIDE_H_ 22 | 23 | /*****************************************************************************************************\ 24 | * USAGE: 25 | * To modify the stock configuration without changing the my_user_config.h file: 26 | * (1) copy this file to "user_config_override.h" (It will be ignored by Git) 27 | * (2) define your own settings below 28 | * 29 | ****************************************************************************************************** 30 | * ATTENTION: 31 | * - Changes to SECTION1 PARAMETER defines will only override flash settings if you change define CFG_HOLDER. 32 | * - Expect compiler warnings when no ifdef/undef/endif sequence is used. 33 | * - You still need to update my_user_config.h for major define USE_MQTT_TLS. 34 | * - All parameters can be persistent changed online using commands via MQTT, WebConsole or Serial. 35 | \*****************************************************************************************************/ 36 | 37 | // All unnecessary stuff. Clean 38 | #ifdef CLEAR_BUILD 39 | #undef USE_AC_ZERO_CROSS_DIMMER 40 | #undef USE_DOMOTICZ 41 | #undef USE_EMULATION_HUE 42 | #undef USE_EMULATION_WEMO 43 | #undef USE_LIGHT // Add support for light control 44 | #undef USE_WS2812 // WS2812 Led string using library NeoPixelBus (+5k code, +1k mem, 232 iram) - Disable by // 45 | #undef USE_IR_REMOTE 46 | #undef USE_IR_SEND_NEC // Support IRsend NEC protocol 47 | #undef USE_IR_SEND_RC5 // Support IRsend Philips RC5 protocol 48 | #undef USE_IR_SEND_RC6 // Support IRsend Philips RC6 protocol 49 | #undef USE_TUYA_MCU // Add support for Tuya Serial MCU 50 | #undef TUYA_DIMMER_ID // Default dimmer Id 51 | #undef USE_TUYA_TIME // Add support for Set Time in Tuya MCU 52 | // Enable IR devoder via GPIO `IR Recv` - always enabled if `USE_IR_REMOTE_FULL` 53 | #undef USE_IR_RECEIVE 54 | #ifdef ESP32 55 | #undef ROTARY_V1 // Add support for Rotary Encoder as used in MI Desk Lamp (+0k8 code) 56 | #undef ROTARY_MAX_STEPS // Rotary step boundary 57 | #undef USE_SONOFF_RF // Add support for Sonoff Rf Bridge (+3k2 code) 58 | #undef USE_RF_FLASH // Add support for flashing the EFM8BB1 chip on the Sonoff RF Bridge. C2CK must be connected to GPIO4, C2D to GPIO5 on the PCB (+2k7 code) 59 | #undef USE_SONOFF_SC // Add support for Sonoff Sc (+1k1 code) 60 | 61 | // #undef USE_TUYAMCUBR // Add support for TuyaMCU Bridge 62 | #undef USE_ARMTRONIX_DIMMERS // Add support for Armtronix Dimmers (+1k4 code) 63 | #undef USE_PS_16_DZ // Add support for PS-16-DZ Dimmer (+2k code) 64 | #undef USE_SONOFF_IFAN // Add support for Sonoff iFan02 and iFan03 (+2k code) 65 | #undef USE_BUZZER // Add support for a buzzer (+0k6 code) 66 | #undef USE_ARILUX_RF // Add support for Arilux RF remote controller (+0k8 code, 252 iram (non 2.3.0)) 67 | #undef USE_SHUTTER // Add Shutter support for up to 4 shutter with different motortypes (+11k code) 68 | #undef USE_DEEPSLEEP // Add support for deepsleep (+1k code) 69 | #undef USE_EXS_DIMMER // Add support for ES-Store Wi-Fi Dimmer (+1k5 code) 70 | // #undef EXS_MCU_CMNDS // Add command to send MCU commands (+0k8 code) 71 | // #undef USE_HOTPLUG // Add support for sensor HotPlug 72 | #undef USE_DEVICE_GROUPS // Add support for device groups (+5k5 code) 73 | #undef DEVICE_GROUPS_ADDRESS // Device groups multicast address 74 | #undef DEVICE_GROUPS_PORT // Device groups multicast port 75 | #undef USE_DEVICE_GROUPS_SEND // Add support for the DevGroupSend command (+0k6 code) 76 | #undef USE_PWM_DIMMER // Add support for MJ-SD01/acenx/NTONPOWER PWM dimmers (+2k3 code, DGR=0k7) 77 | #undef USE_PWM_DIMMER_REMOTE // Add support for remote switches to PWM Dimmer (requires USE_DEVICE_GROUPS) (+0k6 code) 78 | // #undef USE_KEELOQ // Add support for Jarolift rollers by Keeloq algorithm (+4k5 code) 79 | #undef USE_SONOFF_D1 // Add support for Sonoff D1 Dimmer (+0k7 code) 80 | #undef USE_SHELLY_DIMMER // Add support for Shelly Dimmer (+3k code) 81 | #undef SHELLY_CMDS // Add command to send co-processor commands (+0k3 code) 82 | #undef SHELLY_FW_UPGRADE // Add firmware upgrade option for co-processor (+3k4 code) 83 | 84 | // -- Optional light modules ---------------------- 85 | #undef USE_LIGHT // Add support for light control 86 | #undef USE_WS2812 // WS2812 Led string using library NeoPixelBus (+5k code, +1k mem, 232 iram) - Disable by // 87 | 88 | #undef USE_MY92X1 // Add support for MY92X1 RGBCW led controller as used in Sonoff B1, Ailight and Lohas 89 | #undef USE_SM16716 // Add support for SM16716 RGB LED controller (+0k7 code) 90 | #undef USE_SM2135 // Add support for SM2135 RGBCW led control as used in Action LSC (+0k6 code) 91 | #undef USE_SM2335 // Add support for SM2335 RGBCW led control as used in SwitchBot Color Bulb (+0k7 code) 92 | #undef USE_BP1658CJ // Add support for BP1658CJ RGBCW led control as used in Orein OS0100411267 Bulb 93 | #undef USE_BP5758D // Add support for BP5758D RGBCW led control as used in some Tuya lightbulbs (+0k8 code) 94 | #undef USE_SONOFF_L1 // Add support for Sonoff L1 led control 95 | #undef USE_ELECTRIQ_MOODL // Add support for ElectriQ iQ-wifiMOODL RGBW LED controller (+0k3 code) 96 | #undef USE_LIGHT_PALETTE // Add support for color palette (+0k7 code) 97 | #undef USE_LIGHT_VIRTUAL_CT // Add support for Virtual White Color Temperature (+1.1k code) 98 | #undef USE_DGR_LIGHT_SEQUENCE // Add support for device group light sequencing (requires USE_DEVICE_GROUPS) (+0k2 code) 99 | // #undef USE_LSC_MCSL // Add support for GPE Multi color smart light as sold by Action in the Netherlands (+1k1 code) 100 | 101 | // #undef USE_LIGHT_ARTNET // Add support for DMX/ArtNet via UDP on port 6454 (+3.5k code) 102 | #undef USE_LIGHT_ARTNET_MCAST // Multicast address used to listen: 239.255.25.54 103 | 104 | #undef USE_DISPLAY_MODES1TO5 // Enable display mode 1 to 5 in addition to mode 0 105 | #undef USE_DISPLAY_LCD // [DisplayModel 1] [I2cDriver3] Enable Lcd display (I2C addresses 0x27 and 0x3F) (+6k code) 106 | #undef USE_DISPLAY_SSD1306 // [DisplayModel 2] [I2cDriver4] Enable SSD1306 Oled 128x64 display (I2C addresses 0x3C and 0x3D) (+16k code) 107 | #undef USE_DISPLAY_MATRIX // [DisplayModel 3] [I2cDriver5] Enable 8x8 Matrix display (I2C adresseses see below) (+11k code) 108 | #undef MTX_ADDRESS1 // [DisplayAddress1] I2C address of first 8x8 matrix module 109 | #undef MTX_ADDRESS2 // [DisplayAddress2] I2C address of second 8x8 matrix module 110 | #undef MTX_ADDRESS3 // [DisplayAddress3] I2C address of third 8x8 matrix module 111 | #undef MTX_ADDRESS4 // [DisplayAddress4] I2C address of fourth 8x8 matrix module 112 | #undef MTX_ADDRESS5 // [DisplayAddress5] I2C address of fifth 8x8 matrix module 113 | #undef MTX_ADDRESS6 // [DisplayAddress6] I2C address of sixth 8x8 matrix module 114 | #undef MTX_ADDRESS7 // [DisplayAddress7] I2C address of seventh 8x8 matrix module 115 | #undef MTX_ADDRESS8 // [DisplayAddress8] I2C address of eigth 8x8 matrix module 116 | #undef USE_DISPLAY_SEVENSEG 117 | 118 | #undef USE_DHT 119 | 120 | 121 | 122 | #undef USE_ZIGBEE_ZNP 123 | 124 | #undef USE_ADC 125 | 126 | #undef USE_NETWORK_LIGHT_SCHEMES 127 | 128 | #undef USE_AUTOCONF // Enable Esp32 autoconf feature, requires USE_BERRY and USE_WEBCLIENT_HTTPS (12KB Flash) 129 | 130 | #undef USE_BERRY // Enable Berry scripting language 131 | #undef USE_BERRY_PYTHON_COMPAT // Enable by default `import python_compat` 132 | #undef USE_BERRY_PSRAM // Allocate Berry memory in PSRAM if PSRAM is connected - this might be slightly slower but leaves main memory intact 133 | #undef USE_BERRY_IRAM // Allocate some data structures in IRAM (which is ususally unused) when possible and if no PSRAM is available 134 | #undef USE_WEBCLIENT // Enable `webclient` to make HTTP/HTTPS requests. Can be disabled for security reasons. 135 | #undef USE_BERRY_WEBCLIENT_USERAGENT "TasmotaClient" // default user-agent used, can be changed with `wc.set_useragent()` 136 | #undef USE_BERRY_WEBCLIENT_TIMEOUT 2000 // Default timeout in milliseconds 137 | #undef USE_BERRY_PARTITION_WIZARD_URL "http://ota.tasmota.com/tapp/partition_wizard.bec" 138 | #undef USE_BERRY_GPIOVIEWER_URL "http://ota.tasmota.com/tapp/gpioviewer.bec" 139 | #undef USE_BERRY_TCPSERVER // Enable TCP socket server (+0.6k) 140 | #undef USE_BERRY_CRYPTO_AES_GCM // enable AES GCM 256 bits 141 | #undef USE_BERRY_CRYPTO_SHA256 // enable SHA256 hash function 142 | #undef USE_BERRY_CRYPTO_HMAC_SHA256 // enable HMAC SHA256 hash function 143 | 144 | #undef USE_CSE7761 // Add support for CSE7761 Energy monitor as used in Sonoff Dual R3 145 | 146 | // -- LVGL Graphics Library --------------------------------- 147 | // #undef USE_LVGL // LVGL Engine, requires Berry (+382KB) 148 | #undef USE_LVGL_PSRAM // Allocate LVGL memory in PSRAM if PSRAM is connected - this might be slightly slower but leaves main memory intact 149 | // #undef USE_LVGL_HASPMOTA // Enable OpenHASP compatiblity and Robotocondensed fonts (+90KB flash) 150 | #undef USE_LVGL_MAX_SLEEP 10 // max sleep in ms when LVGL is enabled, more than 10ms will make display less responsive 151 | #undef USE_LVGL_PNG_DECODER // include a PNG image decoder from file system (+16KB) 152 | // #undef USE_LVGL_TOUCHSCREEN // Use virtual touch screen with Berry driver 153 | // #undef USE_LVGL_FREETYPE // Use the FreeType renderer to display fonts using native TTF files in file system (+77KB flash) 154 | #undef LV_USE_FT_CACHE_MANAGER 1 // define whether glyphs are cached by FreeType library 155 | #undef USE_LVGL_FREETYPE_MAX_FACES 64 // max number of FreeType faces in cache 156 | #undef USE_LVGL_FREETYPE_MAX_SIZES 4 // max number of sizes in cache 157 | #undef USE_LVGL_FREETYPE_MAX_BYTES 16 * 1024 // max bytes in cache 158 | #undef USE_LVGL_FREETYPE_MAX_BYTES_PSRAM 64 * 1024 // max bytes in cache when using PSRAM 159 | #undef USE_LVGL_BG_DEFAULT 0x000000 // Default color for the uninitialized background screen (black) 160 | 161 | #undef BE_LV_WIDGET_ARC 162 | #undef BE_LV_WIDGET_BAR 163 | #undef BE_LV_WIDGET_BTN 164 | #undef BE_LV_WIDGET_BTNMATRIX 165 | #undef BE_LV_WIDGET_CANVAS 166 | #undef BE_LV_WIDGET_CHECKBOX 167 | #undef BE_LV_WIDGET_DROPDOWN 168 | #undef BE_LV_WIDGET_IMG 169 | #undef BE_LV_WIDGET_LABEL 170 | #undef BE_LV_WIDGET_LINE 171 | #undef BE_LV_WIDGET_ROLLER 172 | #undef BE_LV_WIDGET_SLIDER 173 | #undef BE_LV_WIDGET_SWITCH 174 | #undef BE_LV_WIDGET_TABLE 175 | #undef BE_LV_WIDGET_TEXTAREA 176 | 177 | #undef BE_LV_WIDGET_CHART 178 | #undef BE_LV_WIDGET_COLORWHEEL 179 | #undef BE_LV_WIDGET_IMGBTN 180 | #undef BE_LV_WIDGET_LED 181 | #undef BE_LV_WIDGET_METER 182 | #undef BE_LV_WIDGET_MSGBOX 183 | #undef BE_LV_WIDGET_SPINBOX 184 | #undef BE_LV_WIDGET_SPINNER 185 | 186 | #undef BE_LV_WIDGET_QRCODE 187 | 188 | #endif 189 | #endif 190 | /* 191 | Examples : 192 | 193 | // -- Master parameter control -------------------- 194 | #undef CFG_HOLDER 195 | #define CFG_HOLDER 4617 // [Reset 1] Change this value to load SECTION1 configuration parameters to flash 196 | 197 | // -- Setup your own Wifi settings --------------- 198 | #undef STA_SSID1 199 | #define STA_SSID1 "YourSSID" // [Ssid1] Wifi SSID 200 | 201 | #undef STA_PASS1 202 | #define STA_PASS1 "YourWifiPassword" // [Password1] Wifi password 203 | 204 | // -- Setup your own MQTT settings --------------- 205 | #undef MQTT_HOST 206 | #define MQTT_HOST "your-mqtt-server.com" // [MqttHost] 207 | 208 | #undef MQTT_PORT 209 | #define MQTT_PORT 1883 // [MqttPort] MQTT port (10123 on CloudMQTT) 210 | 211 | #undef MQTT_USER 212 | #define MQTT_USER "YourMqttUser" // [MqttUser] Optional user 213 | 214 | #undef MQTT_PASS 215 | #define MQTT_PASS "YourMqttPass" // [MqttPassword] Optional password 216 | 217 | // You might even pass some parameters from the command line ---------------------------- 218 | // Ie: export PLATFORMIO_BUILD_FLAGS='-DUSE_CONFIG_OVERRIDE -DMY_IP="192.168.1.99" -DMY_GW="192.168.1.1" -DMY_DNS="192.168.1.1"' 219 | 220 | #ifdef MY_IP 221 | #undef WIFI_IP_ADDRESS 222 | #define WIFI_IP_ADDRESS MY_IP // Set to 0.0.0.0 for using DHCP or enter a static IP address 223 | #endif 224 | 225 | #ifdef MY_GW 226 | #undef WIFI_GATEWAY 227 | #define WIFI_GATEWAY MY_GW // if not using DHCP set Gateway IP address 228 | #endif 229 | 230 | #ifdef MY_DNS 231 | #undef WIFI_DNS 232 | #define WIFI_DNS MY_DNS // If not using DHCP set DNS IP address (might be equal to WIFI_GATEWAY) 233 | #endif 234 | 235 | #ifdef MY_DNS2 236 | #undef WIFI_DNS2 237 | #define WIFI_DNS2 MY_DNS2 // If not using DHCP set DNS IP address (might be equal to WIFI_GATEWAY) 238 | #endif 239 | 240 | // !!! Remember that your changes GOES AT THE BOTTOM OF THIS FILE right before the last #endif !!! 241 | */ 242 | 243 | #define FRIENDLY_NAME "Uni GW" 244 | #define PROJECT "Uni_GW" 245 | 246 | #define MODULE USER_MODULE 247 | #define FALLBACK_MODULE USER_MODULE 248 | 249 | #ifdef ESP8266 250 | 251 | #ifdef UGW_WMS_D1M 252 | #define USER_TEMPLATE "{\"NAME\":\"Wemos D1 mini\",\"GPIO\":[1,1,1,1,1,1,0,0,1,4928,1,4960,1,0],\"FLAG\":0,\"BASE\":18}" 253 | #define OTA_URL "https://github.com/xyzroe/UniGW/releases/latest/download/UniGW_Wemos-D1_mini.bin.gz" 254 | #endif // UGW_WMS_D1M 255 | 256 | #endif // ESP8266 257 | 258 | #ifdef ESP32 259 | 260 | #ifdef UGW_MB_ETH01 261 | #define USER_TEMPLATE "{\"NAME\":\"Mind board WT32-ETH01\",\"GPIO\":[0,5312,0,5344,0,5472,0,0,0,0,608,640,3840,5504,5600,0,0,0,0,5568,0,0,0,0,0,0,0,0,1312,0,0,0,0,0,0,0],\"FLAG\":0,\"BASE\":1}" 262 | #define OTA_URL "https://github.com/xyzroe/UniGW/releases/latest/download/UniGW-MindBrd_WT32-ETH01.bin" 263 | #define USE_ETHERNET // Add support for ethernet (+20k code) 264 | #define ETH_TYPE 0 // [EthType] 0 = ETH_PHY_LAN8720, 1 = ETH_PHY_TLK110/ETH_PHY_IP101, 2 = ETH_PHY_RTL8201, 3 = ETH_PHY_DP83848, 4 = ETH_PHY_DM9051, 5 = ETH_PHY_KSZ8081 265 | #define ETH_ADDRESS 1 // [EthAddress] 0 = PHY0 .. 31 = PHY31 266 | #define ETH_CLKMODE 0 // [EthClockMode] 0 = ETH_CLOCK_GPIO0_IN, 1 = ETH_CLOCK_GPIO0_OUT, 2 = ETH_CLOCK_GPIO16_OUT, 3 = ETH_CLOCK_GPIO17_OUT 267 | #endif // UGW_MB_ETH01 268 | 269 | #ifdef UGW_MB_WMS32 270 | #define USER_TEMPLATE "{\"NAME\":\"Mind board Wemos32\",\"GPIO\":[0,0,0,0,0,0,0,0,0,0,608,640,5312,0,5344,0,0,5472,5504,0,0,0,0,0,0,0,0,0,1312,0,0,0,0,0,0,0],\"FLAG\":0,\"BASE\":1}" 271 | #define OTA_URL "https://github.com/xyzroe/UniGW/releases/latest/download/UniGW-MindBrd_Wemos32.bin" 272 | #endif // UGW_MB_WMS32 273 | 274 | #ifdef UGW_T - INET 275 | #define USER_TEMPLATE "{\"NAME\":\"T-Internet-COM\",\"GPIO\":[0,0,1,0,5536,0,0,0,1376,1,1,1,0,0,5600,0,0,0,0,5568,0,0,0,0,0,0,0,0,0,9408,0,9440,0,0,0,0],\"FLAG\":0,\"BASE\":1}" 276 | #define OTA_URL "https://github.com/xyzroe/UniGW/releases/latest/download/UniGW_T-Internet-COM.bin" 277 | #define USE_ETHERNET 278 | #define ETH_CLKMODE 1 279 | #define ETH_TYPE 0 280 | #define ETH_ADDRESS 0 281 | 282 | #endif // UGW_T-INET 283 | 284 | // #define USE_HOME_ASSISTANT // Enable Home Assistant Discovery Support (+12k code, +6 bytes mem) 285 | // #define HOME_ASSISTANT_DISCOVERY_PREFIX "homeassistant" // Home Assistant discovery prefix 286 | // #define HOME_ASSISTANT_LWT_TOPIC "homeassistant/status" // home Assistant Birth and Last Will Topic (default = homeassistant/status) 287 | // #define HOME_ASSISTANT_LWT_SUBSCRIBE true 288 | 289 | #define USE_ENHANCED_GUI_WIFI_SCAN 290 | 291 | #endif // ESP32 292 | 293 | #define MY_LANGUAGE uk_UA // Ukrainian in Ukraine 294 | 295 | #ifdef COLOR_BUTTON 296 | #undef COLOR_BUTTON 297 | #endif 298 | #ifdef COLOR_BUTTON_HOVER 299 | #undef COLOR_BUTTON_HOVER 300 | #endif 301 | 302 | #define COLOR_BUTTON "#0056b9" // [WebColor11] Button color - Vivid blue 303 | #define COLOR_BUTTON_HOVER "#ffd800" // [WebColor12] Button color when hovered over - Dark blue 304 | 305 | #define MDNS_ENABLED true 306 | 307 | #ifndef USE_SCRIPT 308 | #define USE_SCRIPT // adds about 17k flash size, variable ram size 309 | #define USE_SCRIPT_WEB_DISPLAY 310 | #endif 311 | #ifdef USE_RULES 312 | #undef USE_RULES 313 | #endif 314 | 315 | #define START_SCRIPT_FROM_BOOT 316 | #define USER_BACKLOG "script 1" 317 | #define PRECONFIGURED_SCRIPT ">D\n>W\n\n\n$

Need help 📄?


UniGW build by xyzroe
\n>B\n=>Backlog TCPBaudrate 9600;TCPConfig 8N1;TCPStart 8888" 318 | 319 | #ifndef USE_OPENTHERM 320 | #define USE_OPENTHERM 321 | #endif 322 | 323 | #ifndef USE_TCP_BRIDGE 324 | #define USE_TCP_BRIDGE // Add support for Serial to TCP bridge (+1.3k code) 325 | #endif 326 | 327 | #ifndef USE_DS18x20 328 | #define USE_DS18x20 // Add support for DS18x20 sensors with id sort, single scan and read retry (+2k6 code) 329 | // #define W1_PARASITE_POWER // Optimize for parasite powered sensors 330 | #endif 331 | 332 | #ifndef USE_AHT2x 333 | #define USE_AHT2x // [I2cDriver43] Enable AHT20/AM2301B instead of AHT1x humidity and temperature sensor (I2C address 0x38) (+0k8 code) 334 | #endif 335 | 336 | #ifndef USE_BMP 337 | #define USE_BMP // [I2cDriver10] Enable BMP085/BMP180/BMP280/BME280 sensors (I2C addresses 0x76 and 0x77) (+4k4 code) 338 | #endif 339 | 340 | #endif // _USER_CONFIG_OVERRIDE_H_ 341 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 | --------------------------------------------------------------------------------