├── .gitignore ├── pyproject.toml ├── .github ├── dependabot.yml ├── workflows │ ├── codeql.yml │ ├── pylint.yml │ └── publish.yml └── CODE_OF_CONDUCT.md ├── src └── TrimPy │ ├── enum │ ├── mode.py │ ├── trim.py │ ├── animation.py │ └── pattern.py │ ├── __init__.py │ ├── messages │ ├── helpers.py │ ├── parser.py │ └── message.py │ └── __main__.py ├── setup.py ├── README.md ├── CONTRIBUTING.md └── LICENSE.md /.gitignore: -------------------------------------------------------------------------------- 1 | __pycache__/ 2 | *.egg-info/ 3 | dist/ 4 | .DS_Store 5 | .venv/ 6 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | requires = [ 3 | "setuptools>=42", 4 | "wheel" 5 | ] 6 | build-backend = "setuptools.build_meta" 7 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | # Maintain dependencies for GitHub Actions 4 | - package-ecosystem: "github-actions" 5 | directory: "/" 6 | schedule: 7 | interval: "daily" 8 | -------------------------------------------------------------------------------- /src/TrimPy/enum/mode.py: -------------------------------------------------------------------------------- 1 | # TrimPy: A basic API implementation for Trimlight Select systems, 2 | # Copyright (C) 2021-2025 Ethan Dye 3 | # 4 | # TrimPy is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License version 3 as 6 | # published by the Free Software Foundation. 7 | # 8 | # TrimPy is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | # GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License 14 | # along with TrimPy. If not, see . 15 | 16 | from enum import Enum 17 | 18 | 19 | class Mode(Enum): 20 | TIMER = 0 21 | MANUAL = 1 22 | -------------------------------------------------------------------------------- /.github/workflows/codeql.yml: -------------------------------------------------------------------------------- 1 | name: CodeQL 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | paths: 8 | - '**.py' 9 | pull_request: 10 | branches: 11 | - main 12 | paths: 13 | - '**.py' 14 | schedule: 15 | - cron: '28 11 * * 1' 16 | 17 | jobs: 18 | analyze: 19 | name: Analyze 20 | runs-on: ubuntu-latest 21 | permissions: 22 | security-events: write 23 | strategy: 24 | fail-fast: false 25 | matrix: 26 | language: [ 'python' ] 27 | 28 | steps: 29 | - name: Checkout repository 30 | uses: actions/checkout@v6 31 | - name: Initialize CodeQL 32 | uses: github/codeql-action/init@v4 33 | with: 34 | languages: ${{ matrix.language }} 35 | - name: Perform CodeQL Analysis 36 | uses: github/codeql-action/analyze@v4 37 | -------------------------------------------------------------------------------- /.github/workflows/pylint.yml: -------------------------------------------------------------------------------- 1 | name: Lint 2 | on: 3 | push: 4 | branches: 5 | - main 6 | paths: 7 | - '**.py' 8 | pull_request: 9 | branches: 10 | - main 11 | paths: 12 | - '**.py' 13 | 14 | jobs: 15 | lint: 16 | name: Lint 17 | runs-on: ubuntu-latest 18 | 19 | steps: 20 | - uses: actions/checkout@v6 21 | - name: Set up Python 3.x 22 | uses: actions/setup-python@v6 23 | with: 24 | python-version: '3.x' 25 | - name: Install dependencies 26 | run: | 27 | python -m pip install --upgrade pip 28 | python -m pip install flake8 29 | - name: Lint with flake8 30 | run: | 31 | flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics 32 | flake8 . --count --max-complexity=10 --max-line-length=127 --statistics 33 | -------------------------------------------------------------------------------- /src/TrimPy/enum/trim.py: -------------------------------------------------------------------------------- 1 | # TrimPy: A basic API implementation for Trimlight Select systems, 2 | # Copyright (C) 2021-2025 Ethan Dye 3 | # 4 | # TrimPy is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License version 3 as 6 | # published by the Free Software Foundation. 7 | # 8 | # TrimPy is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | # GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License 14 | # along with TrimPy. If not, see . 15 | 16 | from enum import Enum 17 | 18 | 19 | class Trim(Enum): 20 | PORT = 8189 21 | START = 90 22 | END = 165 23 | CONN = 12 24 | MODE = 13 25 | SET_NAME = 14 26 | QUERY_PATTERN = 22 27 | CREATE_PATTERN = 6 28 | UPDATE_PATTERN = 5 29 | DELETE_PATTERN = 4 30 | PREVIEW_PATTERN = 19 31 | DISP = 3 32 | DOT_COUNT = 18 33 | -------------------------------------------------------------------------------- /src/TrimPy/enum/animation.py: -------------------------------------------------------------------------------- 1 | # TrimPy: A basic API implementation for Trimlight Select systems, 2 | # Copyright (C) 2021-2025 Ethan Dye 3 | # 4 | # TrimPy is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License version 3 as 6 | # published by the Free Software Foundation. 7 | # 8 | # TrimPy is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | # GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License 14 | # along with TrimPy. If not, see . 15 | 16 | from enum import Enum 17 | 18 | 19 | class Animation(Enum): 20 | STATIC = 0 21 | CHASE_FORWARD = 1 22 | CHASE_BACKWARD = 2 23 | MIDDLE_TO_OUT = 3 24 | OUT_TO_MIDDLE = 4 25 | STROBE = 5 26 | FADE = 6 27 | COMET_FORWARD = 7 28 | COMET_BACKWARD = 8 29 | WAVE_FORWARD = 9 30 | WAVE_BACKWARD = 10 31 | SOLID_FADE = 11 32 | -------------------------------------------------------------------------------- /src/TrimPy/enum/pattern.py: -------------------------------------------------------------------------------- 1 | # TrimPy: A basic API implementation for Trimlight Select systems, 2 | # Copyright (C) 2021-2025 Ethan Dye 3 | # 4 | # TrimPy is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License version 3 as 6 | # published by the Free Software Foundation. 7 | # 8 | # TrimPy is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | # GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License 14 | # along with TrimPy. If not, see . 15 | 16 | from enum import Enum 17 | 18 | 19 | # You may need to do some research / experimentation to figure out what your 20 | # patterns correspond to. Custom patterns can also be accessed using this same 21 | # format, they just come after the builtin patterns. 22 | class Pattern(Enum): 23 | NEW_YEAR = 1 24 | ST_VALENTINE = 2 25 | ST_PATRICK = 3 26 | MOTHERS_DAY = 4 27 | INDEPENDENCE_DAY = 5 28 | DEFAULT = 6 29 | HALLOWEEN = 7 30 | THANKSGIVING = 8 31 | CHRISTMAS = 9 32 | -------------------------------------------------------------------------------- /.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | name: Publish to PyPI 2 | 3 | on: 4 | push: 5 | tags: 6 | - '*' 7 | 8 | jobs: 9 | build: 10 | name: Build 11 | runs-on: ubuntu-latest 12 | steps: 13 | - uses: actions/checkout@v6 14 | - name: Set up Python 15 | uses: actions/setup-python@v6 16 | with: 17 | python-version: '3.x' 18 | - name: Install pypa/build 19 | run: python -m pip install build --user 20 | - name: Build a binary wheel and a source tarball 21 | run: python -m build --sdist --wheel --outdir dist/ . 22 | - name: Store the distribution packages 23 | uses: actions/upload-artifact@v6 24 | with: 25 | name: python-package-distributions 26 | path: dist/ 27 | 28 | publish: 29 | name: Publish 30 | needs: 31 | - build 32 | runs-on: ubuntu-latest 33 | environment: 34 | name: pypi 35 | url: https://pypi.org/p/TrimPy 36 | permissions: 37 | id-token: write # IMPORTANT: mandatory for trusted publishing 38 | steps: 39 | - uses: actions/download-artifact@v7 40 | with: 41 | name: python-package-distributions 42 | path: dist/ 43 | - name: Publish distribution to PyPI 44 | uses: pypa/gh-action-pypi-publish@release/v1 45 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import setuptools 2 | import os 3 | import sys 4 | sys.path.append(os.path.join(os.path.dirname(__file__), 'src/')) 5 | from TrimPy import __version__ # noqa: E402 6 | 7 | with open("README.md", "r", encoding="utf-8") as fh: 8 | long_description = fh.read() 9 | 10 | setuptools.setup( 11 | name="TrimPy", 12 | version=__version__, 13 | author="Ethan Dye", 14 | author_email="mrtops03@gmail.com", 15 | description="A basic API implementation for Trimlight Select systems.", 16 | long_description=long_description, 17 | long_description_content_type="text/markdown", 18 | url="https://github.com/ecdye/TrimPy", 19 | project_urls={ 20 | "Bug Tracker": "https://github.com/ecdye/TrimPy/issues", 21 | }, 22 | classifiers=[ 23 | "Programming Language :: Python :: 3.6", 24 | "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", 25 | "Operating System :: OS Independent", 26 | "Development Status :: 5 - Production/Stable" 27 | ], 28 | package_dir={"": "src"}, 29 | packages=['TrimPy', 'TrimPy.enum', 'TrimPy.messages'], 30 | python_requires=">=3.6", 31 | entry_points={ 32 | "console_scripts": [ 33 | "TrimPy = TrimPy.__main__:main", 34 | ], 35 | }, 36 | ) 37 | -------------------------------------------------------------------------------- /src/TrimPy/__init__.py: -------------------------------------------------------------------------------- 1 | # TrimPy: A basic API implementation for Trimlight Select systems, 2 | # Copyright (C) 2021-2025 Ethan Dye 3 | # 4 | # TrimPy is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License version 3 as 6 | # published by the Free Software Foundation. 7 | # 8 | # TrimPy is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | # GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License 14 | # along with TrimPy. If not, see . 15 | 16 | from .enum.pattern import Pattern 17 | from .enum.trim import Trim 18 | from .enum.mode import Mode 19 | from .enum.animation import Animation 20 | from .messages.message import formatConnMsg, formatModeMsg, formatDispMsg, formatNameMsg, formatQueryPatternMsg 21 | from .messages.message import formatUpdatePatternMsg, formatPreviewPatternMsg, formatDeletePatternMsg, formatDotMsg 22 | from .messages.message import checkPatternNumber 23 | from .messages.parser import parseOptions 24 | 25 | __all__ = ['Pattern', 'Trim', 'Mode', 'Animation', 'formatConnMsg', 'formatModeMsg', 'formatDispMsg', 'formatNameMsg', 26 | 'formatQueryPatternMsg', 'formatUpdatePatternMsg', 'formatPreviewPatternMsg', 'formatDeletePatternMsg', 27 | 'formatDotMsg', 'checkPatternNumber', 'parseOptions', '__version__'] 28 | __version__ = '1.1.0' 29 | -------------------------------------------------------------------------------- /src/TrimPy/messages/helpers.py: -------------------------------------------------------------------------------- 1 | # TrimPy: A basic API implementation for Trimlight Select systems, 2 | # Copyright (C) 2021-2025 Ethan Dye 3 | # 4 | # TrimPy is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License version 3 as 6 | # published by the Free Software Foundation. 7 | # 8 | # TrimPy is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | # GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License 14 | # along with TrimPy. If not, see . 15 | 16 | from TrimPy import Trim 17 | from random import randint 18 | 19 | 20 | def randByte(): 21 | while True: 22 | b = randint(0, 255) 23 | if ((b != Trim.START.value) and (b != Trim.END.value)): 24 | break 25 | return b 26 | 27 | 28 | def validatePatternOptions(options, querySrc): 29 | fields = [ 30 | options.patName, options.animation, options.speed, options.brightness, 31 | options.count_one, options.count_two, options.count_three, options.count_four, 32 | options.count_five, options.count_six, options.count_seven, 33 | options.color_one, options.color_two, options.color_three, 34 | options.color_four, options.color_five, options.color_six, 35 | options.color_seven 36 | ] 37 | if any(f is None for f in fields) and querySrc is None: 38 | print('All pattern options must be provided, or a pattern number must be provided to copy values from.') 39 | return False 40 | return True 41 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # TrimPy 2 | [![GitHub](https://img.shields.io/github/license/ecdye/TrimPy)](https://github.com/ecdye/TrimPy/blob/main/LICENSE.md) 3 | [![CodeQL](https://github.com/ecdye/TrimPy/actions/workflows/codeql.yml/badge.svg)](https://github.com/ecdye/TrimPy/actions/workflows/codeql.yml) 4 | [![Lint](https://github.com/ecdye/TrimPy/actions/workflows/pylint.yml/badge.svg)](https://github.com/ecdye/TrimPy/actions/workflows/pylint.yml) 5 | 6 | A basic API implementation for Trimlight Select systems. 7 | 8 | Install: 9 | 10 | ```sh 11 | python3 -m pip install --upgrade TrimPy 12 | ``` 13 | 14 | or 15 | 16 | ```sh 17 | pipx install TrimPy 18 | ``` 19 | 20 | Usage: 21 | ``` 22 | Usage: TrimPy [options] 23 | 24 | Options: 25 | -h, --help show this help message and exit 26 | -i IP, --ip=IP IP address to connect to (required) 27 | -m MODE, --mode=MODE set trimlight to mode: timer, or manual 28 | -p PATTERN, --pattern=PATTERN 29 | set trimlight to pattern: NEW_YEAR, ST_VALENTINE, 30 | ST_PATRICK, MOTHERS_DAY, INDEPENDENCE_DAY, DEFAULT, 31 | HALLOWEEN, THANKSGIVING, CHRISTMAS (also accepts 32 | custom values in the form of integers representing the 33 | pattern number) 34 | -n NAME, --set-name=NAME 35 | set trimlight device name (< 25 characters) 36 | -d N, --dot-count=N set trimlight device dot count to N (< 4096 dots) 37 | -q N, --query-pattern=N 38 | query trimlight for information about pattern number N 39 | -D N, --delete-pattern=N 40 | delete pattern number N 41 | -v, --verbose make lots of noise [default: False] 42 | -V, --version print version and exit 43 | 44 | Create/Update/Preview Pattern: 45 | create/update/preview a trimlight pattern to match your liking 46 | 47 | --preview-pattern preview a pattern specified by the options below, will 48 | not update pattern if using '--source-pattern' 49 | --source-pattern=N source values from pattern number N 50 | --dest-pattern=N write updated values to pattern number N 51 | --name=PATNAME set pattern name (< 25 characters) 52 | --animation=ANIMATION 53 | set animation style: STATIC, CHASE_FORWARD, 54 | CHASE_BACKWARD, MIDDLE_TO_OUT, OUT_TO_MIDDLE, STROBE, 55 | FADE, COMET_FORWARD, COMET_BACKWARD, WAVE_FORWARD, 56 | WAVE_BACKWARD, SOLID_FADE 57 | --speed=SPEED set animation speed [0-255] 58 | --brightness=BRIGHTNESS 59 | set brightness [0-255] 60 | --color-one=R G B set 'R G B' integer values for color index one 61 | --color-two=R G B set 'R G B' integer values for color index two 62 | --color-three=R G B 63 | set 'R G B' integer values for color index three 64 | --color-four=R G B set 'R G B' integer values for for color index four 65 | --color-five=R G B set 'R G B' integer values for color index five 66 | --color-six=R G B set 'R G B' integer values for color index six 67 | --color-seven=R G B 68 | set 'R G B' integer values for color index seven 69 | --count-one=N set color index one to repeat N times [0-30] 70 | --count-two=N set color index two to repeat N times [0-30] 71 | --count-three=N set color index three to repeat N times [0-30] 72 | --count-four=N set color index four to repeat N times [0-30] 73 | --count-five=N set color index five to repeat N times [0-30] 74 | --count-six=N set color index six to repeat N times [0-30] 75 | --count-seven=N set color index seven to repeat N times [0-30] 76 | ``` 77 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contribution Guidelines 2 | 3 | ## Pull requests are always welcome 4 | 5 | We are always thrilled to receive pull requests, and do our best to process them as fast as possible. 6 | Not sure if that typo is worth a pull request? 7 | Do it! 8 | We will appreciate it. 9 | 10 | If your pull request is not accepted on the first try, don't be discouraged! 11 | If there's a problem with the implementation, you will receive feedback on what to improve. 12 | 13 | We might decide against incorporating a new feature that does not match the scope of this project. 14 | Get in contact early in the development to propose your idea. 15 | 16 | ## Conventions 17 | 18 | Fork the repo and make changes on your fork in a feature branch. 19 | Then be sure to update the documentation when creating or modifying features. 20 | Test your changes for clarity, concision, and correctness. 21 | 22 | Always write clean, modular and testable code. 23 | We use [Flake8](https://flake8.pycqa.org/en/latest/index.html) as a linter for our code, and as our coding guidelines. 24 | See [Linter](#linter) below for more details on running Flake8. 25 | 26 | Pull requests descriptions should be as clear as possible and include a reference to all the issues that they address. 27 | 28 | Pull requests must not contain commits from other users or branches. 29 | 30 | Commit messages **must** start with a capitalized and short summary (max. 50 chars) written in the imperative, followed by an optional, more detailed explanatory text which is separated from the summary by an empty line. 31 | See [here](https://cbea.ms/git-commit/) for great explanation as to why. 32 | 33 | Code review comments may be added to your pull request. 34 | Discuss, then make the suggested modifications and push additional commits to your feature branch. 35 | Be sure to post a comment after pushing. 36 | The new commits will show up in the pull request automatically, but the reviewers will not be notified unless you comment. 37 | 38 | Pull requests will be tested on the GitHub Actions platform which **shall** pass. 39 | 40 | Commits that fix or close an issue should include a reference like `Closes #XXX` or `Fixes #XXX`, which will automatically close the issue when merged. 41 | 42 | Before the pull request is merged, your commits might get squashed, based on the size and style of your contribution. 43 | Include documentation changes in the same pull request, so that a revert would remove all traces of the feature or fix. 44 | 45 | ### Sign off your work 46 | 47 | The sign-off is a simple line at the end of the explanation for the patch, which certifies that you wrote it or otherwise have the right to pass it on as an open-source patch. 48 | The rules are pretty simple: if you can certify your patch under the guidelines provided by then you just add the following line to every git commit message. 49 | 50 | ``` 51 | Signed-off-by: Joe Smith 52 | ``` 53 | 54 | You must use your real name (sorry, no pseudonyms or anonymous contributions) and an e-mail address under which you can be reached (sorry, no GitHub no-reply e-mail addresses (such as username@users.noreply.github.com) or other non-reachable addresses are allowed). 55 | 56 | ### Sign your work using GPG 57 | 58 | You can additionally sign your contribution using GPG. 59 | Have a look at the [git documentation](https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work) for more details. 60 | This step is optional and not needed for the acceptance of your pull request. 61 | 62 | ### Linter 63 | 64 | The Flake8 linter can be run by using the following commands: 65 | 66 | ``` bash 67 | python -m pip install --upgrade pip 68 | python -m pip install --upgrade flake8 69 | flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics 70 | flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics 71 | ``` 72 | -------------------------------------------------------------------------------- /src/TrimPy/messages/parser.py: -------------------------------------------------------------------------------- 1 | # TrimPy: A basic API implementation for Trimlight Select systems, 2 | # Copyright (C) 2021-2025 Ethan Dye 3 | # 4 | # TrimPy is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License version 3 as 6 | # published by the Free Software Foundation. 7 | # 8 | # TrimPy is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | # GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License 14 | # along with TrimPy. If not, see . 15 | 16 | import TrimPy 17 | 18 | 19 | def parseOptions(options, trimSocket): # noqa: C901 20 | if (options.mode is not None): 21 | trimSocket.sendall(TrimPy.formatModeMsg(options.mode)) 22 | if (options.pattern is not None): 23 | trimSocket.sendall(TrimPy.formatDispMsg(options.pattern.upper())) 24 | if (options.name is not None): 25 | trimSocket.sendall(TrimPy.formatNameMsg(options.name)) 26 | if (options.query is not None): 27 | queryData = TrimPy.checkPatternNumber(trimSocket, options.query, options.verbose) 28 | parseQueryData(queryData) 29 | if (options.preview is not False): 30 | message = TrimPy.formatPreviewPatternMsg(trimSocket, options) 31 | if (message is not None): 32 | trimSocket.sendall(TrimPy.formatModeMsg('manual')) 33 | trimSocket.sendall(message) 34 | elif (options.dest is not None): 35 | message = TrimPy.formatUpdatePatternMsg(trimSocket, options) 36 | if (message is not None): 37 | trimSocket.sendall(message) 38 | if (options.delete is not None): 39 | trimSocket.sendall(TrimPy.formatDeletePatternMsg(options.delete)) 40 | if (options.count is not None): 41 | trimSocket.sendall(TrimPy.formatDotMsg(options.count)) 42 | 43 | 44 | def parsePatternOptions(options, request): 45 | request[0:1] = bytes([TrimPy.Animation[options.animation].value]) if (options.animation is not None) else request[0:1] 46 | request[1:2] = bytes([options.speed]) if (options.speed is not None) else request[1:2] 47 | request[2:3] = bytes([options.brightness]) if (options.brightness is not None) else request[2:3] 48 | request[3:4] = bytes([options.count_one]) if (options.count_one is not None) else request[3:4] 49 | request[4:5] = bytes([options.count_two]) if (options.count_two is not None) else request[4:5] 50 | request[5:6] = bytes([options.count_three]) if (options.count_three is not None) else request[5:6] 51 | request[6:7] = bytes([options.count_four]) if (options.count_four is not None) else request[6:7] 52 | request[7:8] = bytes([options.count_five]) if (options.count_five is not None) else request[7:8] 53 | request[8:9] = bytes([options.count_six]) if (options.count_six is not None) else request[8:9] 54 | request[9:10] = bytes([options.count_seven]) if (options.count_seven is not None) else request[9:10] 55 | request[10:13] = bytes(options.color_one) if (options.color_one is not None) else request[10:13] 56 | request[13:16] = bytes(options.color_two) if (options.color_two is not None) else request[13:16] 57 | request[16:19] = bytes(options.color_three) if (options.color_three is not None) else request[16:19] 58 | request[19:22] = bytes(options.color_four) if (options.color_four is not None) else request[19:22] 59 | request[22:25] = bytes(options.color_five) if (options.color_five is not None) else request[22:25] 60 | request[25:28] = bytes(options.color_six) if (options.color_six is not None) else request[25:28] 61 | request[28:31] = bytes(options.color_seven) if (options.color_seven is not None) else request[28:31] 62 | 63 | return request 64 | 65 | 66 | def parseQueryData(queryData): 67 | pattern_name = queryData[2:26].decode("ASCII").strip() 68 | animation = TrimPy.Animation(queryData[28]) 69 | speed = int(queryData[29]) 70 | brightness = int(queryData[30]) 71 | dot_repetition = [str(int(b)) for b in queryData[31:38]] 72 | dot_colors = [queryData[i: i + 3].hex() for i in range(38, 57, 3)] 73 | 74 | print("Pattern Name:", pattern_name) 75 | print("Animation:", animation) 76 | print("Speed:", speed) 77 | print("Brightness:", brightness) 78 | print("Dot Repetition:", " | ".join(dot_repetition)) 79 | print("Dot RGB hex:", " | ".join(dot_colors)) 80 | -------------------------------------------------------------------------------- /src/TrimPy/messages/message.py: -------------------------------------------------------------------------------- 1 | # TrimPy: A basic API implementation for Trimlight Select systems, 2 | # Copyright (C) 2021-2025 Ethan Dye 3 | # 4 | # TrimPy is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License version 3 as 6 | # published by the Free Software Foundation. 7 | # 8 | # TrimPy is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | # GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License 14 | # along with TrimPy. If not, see . 15 | 16 | from datetime import datetime 17 | from TrimPy import Trim, Pattern, Mode 18 | from .helpers import randByte, validatePatternOptions 19 | from .parser import parsePatternOptions 20 | from re import match 21 | 22 | 23 | def formatConnMsg(verbose): 24 | pad1 = randByte() 25 | pad2 = randByte() 26 | pad3 = randByte() 27 | date = datetime.now() 28 | year = int(date.strftime("%y")) 29 | month = int(date.strftime("%m")) 30 | day = int(date.strftime("%d")) 31 | wkday = int(date.strftime("%w")) + 1 # Python zero indexes from Sunday for week day 32 | hour = int(date.strftime("%H")) 33 | minute = int(date.strftime("%M")) 34 | second = int(date.strftime("%S")) 35 | date = bytes([pad1, pad2, pad3, year, month, day, wkday, hour, minute, second]) 36 | length = bytes([len(date) >> 8, len(date)]) 37 | n = (pad3 << 5 | pad1 >> 3 & 31 & pad2).to_bytes(2, 'big') 38 | if (verbose is True): 39 | print('Verify byte:', n[1:2].hex()) 40 | return bytes([Trim.START.value, Trim.CONN.value]) + length + date + bytes([Trim.END.value]) 41 | 42 | 43 | def formatModeMsg(m): 44 | mode = bytes([Mode.MANUAL.value]) if m == 'manual' else bytes([Mode.TIMER.value]) 45 | length = bytes([len(mode) >> 8, len(mode)]) 46 | return bytes([Trim.START.value, Trim.MODE.value]) + length + mode + bytes([Trim.END.value]) 47 | 48 | 49 | def formatDispMsg(p): 50 | if (p in Pattern.__members__): 51 | pattern = bytes([Pattern[p].value]) 52 | else: 53 | pattern = bytes([int(p)]) 54 | length = bytes([len(pattern) >> 8, len(pattern)]) 55 | return bytes([Trim.START.value, Trim.DISP.value]) + length + pattern + bytes([Trim.END.value]) 56 | 57 | 58 | def formatNameMsg(n): 59 | name = bytearray(n, "ASCII") 60 | length = bytes([len(name) >> 8, len(name)]) 61 | return bytes([Trim.START.value, Trim.SET_NAME.value]) + length + name + bytes([Trim.END.value]) 62 | 63 | 64 | def formatQueryPatternMsg(p): 65 | pattern = bytes([p]) 66 | length = bytes([len(pattern) >> 8, len(pattern)]) 67 | return bytes([Trim.START.value, Trim.QUERY_PATTERN.value]) + length + pattern + bytes([Trim.END.value]) 68 | 69 | 70 | def formatUpdatePatternMsg(trimSocket, options): 71 | querySrc = checkPatternNumber(trimSocket, options.src, options.verbose) 72 | queryDst = checkPatternNumber(trimSocket, options.dest, options.verbose) 73 | if (not validatePatternOptions(options, querySrc)): 74 | return 75 | 76 | p1 = bytearray([int(options.dest)]) 77 | p2 = bytearray(options.patName.ljust(24, '\0'), "ASCII") if (options.patName is not None) else querySrc[2:26] 78 | p3 = querySrc[26:28] + parsePatternOptions(options, bytearray(querySrc[28:59])) 79 | request = p1 + p2 + p3 80 | length = bytes([len(request) >> 8, len(request)]) 81 | cmd = Trim.CREATE_PATTERN.value if (queryDst is None) else Trim.UPDATE_PATTERN.value 82 | 83 | return bytes([Trim.START.value, cmd]) + length + request + bytes([Trim.END.value]) 84 | 85 | 86 | def formatPreviewPatternMsg(trimSocket, options): 87 | querySrc = checkPatternNumber(trimSocket, options.src, options.verbose) 88 | if (not validatePatternOptions(options, querySrc)): 89 | return 90 | 91 | request = (querySrc[26:28] + parsePatternOptions(options, bytearray(querySrc[28:59])) 92 | if (querySrc is not None) else parsePatternOptions(options, bytearray(32))) 93 | length = bytes([len(request) >> 8, len(request)]) 94 | return bytes([Trim.START.value, Trim.PREVIEW_PATTERN.value]) + length + request + bytes([Trim.END.value]) 95 | 96 | 97 | def formatDeletePatternMsg(p): 98 | pattern = bytes([p]) 99 | length = bytes([len(pattern) >> 8, len(pattern)]) 100 | return bytes([Trim.START.value, Trim.DELETE_PATTERN.value]) + length + pattern + bytes([Trim.END.value]) 101 | 102 | 103 | def formatDotMsg(c): 104 | count = c.to_bytes(2, 'big') 105 | length = bytes([len(count) >> 8, len(count)]) 106 | return bytes([Trim.START.value, Trim.DOT_COUNT.value]) + length + count + bytes([Trim.END.value]) 107 | 108 | 109 | def checkPatternNumber(trimSocket, num, verbose): 110 | if (num is not None): 111 | trimSocket.sendall(formatQueryPatternMsg(num)) 112 | queryData = trimSocket.recv(1024) 113 | if verbose: 114 | print('Received:', queryData.hex()) 115 | if (match(b'\x5a\xff.*\xff\xa5', queryData)): 116 | print('Pattern number provided does not exist!') 117 | return 118 | return queryData 119 | -------------------------------------------------------------------------------- /.github/CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, caste, color, religion, or sexual 10 | identity and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | * Demonstrating empathy and kindness toward other people 21 | * Being respectful of differing opinions, viewpoints, and experiences 22 | * Giving and gracefully accepting constructive feedback 23 | * Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | * Focusing on what is best not just for us as individuals, but for the overall 26 | community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | * The use of sexualized language or imagery, and sexual attention or advances of 31 | any kind 32 | * Trolling, insulting or derogatory comments, and personal or political attacks 33 | * Public or private harassment 34 | * Publishing others' private information, such as a physical or email address, 35 | without their explicit permission 36 | * Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official e-mail address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement at 63 | . 64 | All complaints will be reviewed and investigated promptly and fairly. 65 | 66 | All community leaders are obligated to respect the privacy and security of the 67 | reporter of any incident. 68 | 69 | ## Enforcement Guidelines 70 | 71 | Community leaders will follow these Community Impact Guidelines in determining 72 | the consequences for any action they deem in violation of this Code of Conduct: 73 | 74 | ### 1. Correction 75 | 76 | **Community Impact**: Use of inappropriate language or other behavior deemed 77 | unprofessional or unwelcome in the community. 78 | 79 | **Consequence**: A private, written warning from community leaders, providing 80 | clarity around the nature of the violation and an explanation of why the 81 | behavior was inappropriate. A public apology may be requested. 82 | 83 | ### 2. Warning 84 | 85 | **Community Impact**: A violation through a single incident or series of 86 | actions. 87 | 88 | **Consequence**: A warning with consequences for continued behavior. No 89 | interaction with the people involved, including unsolicited interaction with 90 | those enforcing the Code of Conduct, for a specified period of time. This 91 | includes avoiding interactions in community spaces as well as external channels 92 | like social media. Violating these terms may lead to a temporary or permanent 93 | ban. 94 | 95 | ### 3. Temporary Ban 96 | 97 | **Community Impact**: A serious violation of community standards, including 98 | sustained inappropriate behavior. 99 | 100 | **Consequence**: A temporary ban from any sort of interaction or public 101 | communication with the community for a specified period of time. No public or 102 | private interaction with the people involved, including unsolicited interaction 103 | with those enforcing the Code of Conduct, is allowed during this period. 104 | Violating these terms may lead to a permanent ban. 105 | 106 | ### 4. Permanent Ban 107 | 108 | **Community Impact**: Demonstrating a pattern of violation of community 109 | standards, including sustained inappropriate behavior, harassment of an 110 | individual, or aggression toward or disparagement of classes of individuals. 111 | 112 | **Consequence**: A permanent ban from any sort of public interaction within the 113 | community. 114 | 115 | ## Attribution 116 | 117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 118 | version 2.1, available at 119 | [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. 120 | 121 | Community Impact Guidelines were inspired by 122 | [Mozilla's code of conduct enforcement ladder][Mozilla CoC]. 123 | 124 | For answers to common questions about this code of conduct, see the FAQ at 125 | [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at 126 | [https://www.contributor-covenant.org/translations][translations]. 127 | 128 | [homepage]: https://www.contributor-covenant.org 129 | [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html 130 | [Mozilla CoC]: https://github.com/mozilla/diversity 131 | [FAQ]: https://www.contributor-covenant.org/faq 132 | [translations]: https://www.contributor-covenant.org/translations 133 | -------------------------------------------------------------------------------- /src/TrimPy/__main__.py: -------------------------------------------------------------------------------- 1 | # TrimPy: A basic API implementation for Trimlight Select systems, 2 | # Copyright (C) 2021-2025 Ethan Dye 3 | # 4 | # TrimPy is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License version 3 as 6 | # published by the Free Software Foundation. 7 | # 8 | # TrimPy is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | # GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License 14 | # along with TrimPy. If not, see . 15 | 16 | from optparse import OptionParser, OptionGroup 17 | import TrimPy 18 | import socket 19 | import sys 20 | 21 | 22 | def main() -> int: 23 | parser = OptionParser(usage="Usage: TrimPy [options]") 24 | parser.add_option("-i", "--ip", help="IP address to connect to (required)") 25 | parser.add_option("-m", "--mode", help="set trimlight to mode: timer, or manual") 26 | parser.add_option("-p", "--pattern", help=f"set trimlight to pattern: {', '.join([p.name for p in TrimPy.Pattern])} " 27 | "(also accepts custom values in the form of integers representing the pattern number)") 28 | parser.add_option("-n", "--set-name", dest="name", help="set trimlight device name (< 25 characters)") 29 | parser.add_option("-d", "--dot-count", dest="count", type="int", help="set trimlight device dot count to N (< 4096 dots)", 30 | metavar="N") 31 | parser.add_option("-q", "--query-pattern", dest="query", type="int", 32 | help="query trimlight for information about pattern number N", metavar="N") 33 | parser.add_option("-D", "--delete-pattern", dest="delete", type="int", help="delete pattern number N", metavar="N") 34 | parser.add_option("-v", "--verbose", action="store_true", default=False, help="make lots of noise [default: %default]") 35 | parser.add_option("-V", "--version", action="store_true", default=False, help="print version and exit") 36 | 37 | group = OptionGroup(parser, "Create/Update/Preview Pattern", 38 | "create/update/preview a trimlight pattern to match your liking") 39 | group.add_option("--preview-pattern", dest="preview", action="store_true", default=False, 40 | help="preview a pattern specified by the options below, " 41 | "will not update pattern if using '--source-pattern'") 42 | group.add_option("--source-pattern", dest="src", type="int", help="source values from pattern number N", metavar="N") 43 | group.add_option("--dest-pattern", dest="dest", type="int", help="write updated values to pattern number N", metavar="N") 44 | group.add_option("--name", dest="patName", help="set pattern name (< 25 characters)") 45 | group.add_option("--animation", dest="animation", help="set animation style: " 46 | f"{', '.join([a.name for a in TrimPy.Animation])}") 47 | group.add_option("--speed", dest="speed", type="int", help="set animation speed [0-255]") 48 | group.add_option("--brightness", dest="brightness", type="int", help="set brightness [0-255]") 49 | group.add_option("--color-one", nargs=3, type="int", help="set 'R G B' integer values for color index one", 50 | metavar="R G B") 51 | group.add_option("--color-two", nargs=3, type="int", help="set 'R G B' integer values for color index two", 52 | metavar="R G B") 53 | group.add_option("--color-three", nargs=3, type="int", help="set 'R G B' integer values for color index three", 54 | metavar="R G B") 55 | group.add_option("--color-four", nargs=3, type="int", help="set 'R G B' integer values for for color index four", 56 | metavar="R G B") 57 | group.add_option("--color-five", nargs=3, type="int", help="set 'R G B' integer values for color index five", 58 | metavar="R G B") 59 | group.add_option("--color-six", nargs=3, type="int", help="set 'R G B' integer values for color index six", 60 | metavar="R G B") 61 | group.add_option("--color-seven", nargs=3, type="int", help="set 'R G B' integer values for color index seven", 62 | metavar="R G B") 63 | group.add_option("--count-one", type="int", help="set color index one to repeat N times [0-30]", metavar="N") 64 | group.add_option("--count-two", type="int", help="set color index two to repeat N times [0-30]", metavar="N") 65 | group.add_option("--count-three", type="int", help="set color index three to repeat N times [0-30]", metavar="N") 66 | group.add_option("--count-four", type="int", help="set color index four to repeat N times [0-30]", metavar="N") 67 | group.add_option("--count-five", type="int", help="set color index five to repeat N times [0-30]", metavar="N") 68 | group.add_option("--count-six", type="int", help="set color index six to repeat N times [0-30]", metavar="N") 69 | group.add_option("--count-seven", type="int", help="set color index seven to repeat N times [0-30]", metavar="N") 70 | parser.add_option_group(group) 71 | 72 | (options, args) = parser.parse_args() 73 | if (options.version is True): 74 | print("TrimPy", TrimPy.__version__) 75 | print('Copyright (C) 2021-2025 Ethan Dye') 76 | print('License GPLv3: GNU GPL version 3 .\n') 77 | print('TrimPy is free software: you are free to change and redistribute it.') 78 | print('There is NO WARRANTY, to the extent permitted by law.') 79 | return 0 80 | elif (options.ip is None): 81 | parser.print_help() 82 | return 0 83 | 84 | trimSocket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) 85 | 86 | # Connect to trimlight 87 | trimSocket.connect((options.ip, TrimPy.Trim.PORT.value)) 88 | trimSocket.sendall(TrimPy.formatConnMsg(options.verbose)) 89 | connData = trimSocket.recv(1024) 90 | 91 | nameLen = connData[3] + 4 92 | pixCntStart = nameLen + 2 # Skip padding after Device name 93 | pixCntEnd = nameLen + 4 # Pixel count is represented as two bytes in hex 94 | 95 | deviceName = connData[4:nameLen].decode("ASCII") 96 | pixelCount = int.from_bytes(connData[pixCntStart:pixCntEnd], 'big') 97 | 98 | if (options.verbose is True): 99 | print('Received:', connData.hex()) 100 | print('Device Name:', deviceName) 101 | print('Pixel Count:', pixelCount) 102 | 103 | TrimPy.parseOptions(options, trimSocket) 104 | 105 | trimSocket.close() 106 | return 0 107 | 108 | 109 | if __name__ == '__main__': 110 | sys.exit(main()) 111 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | ### GNU GENERAL PUBLIC LICENSE 2 | 3 | Version 3, 29 June 2007 4 | 5 | Copyright (C) 2007 Free Software Foundation, Inc. 6 | 7 | 8 | Everyone is permitted to copy and distribute verbatim copies of this 9 | license document, but changing it is not allowed. 10 | 11 | ### Preamble 12 | 13 | The GNU General Public License is a free, copyleft license for 14 | software and other kinds of works. 15 | 16 | The licenses for most software and other practical works are designed 17 | to take away your freedom to share and change the works. By contrast, 18 | the GNU General Public License is intended to guarantee your freedom 19 | to share and change all versions of a program--to make sure it remains 20 | free software for all its users. We, the Free Software Foundation, use 21 | the GNU General Public License for most of our software; it applies 22 | also to any other work released this way by its authors. You can apply 23 | it to your programs, too. 24 | 25 | When we speak of free software, we are referring to freedom, not 26 | price. Our General Public Licenses are designed to make sure that you 27 | have the freedom to distribute copies of free software (and charge for 28 | them if you wish), that you receive source code or can get it if you 29 | want it, that you can change the software or use pieces of it in new 30 | free programs, and that you know you can do these things. 31 | 32 | To protect your rights, we need to prevent others from denying you 33 | these rights or asking you to surrender the rights. Therefore, you 34 | have certain responsibilities if you distribute copies of the 35 | software, or if you modify it: responsibilities to respect the freedom 36 | of others. 37 | 38 | For example, if you distribute copies of such a program, whether 39 | gratis or for a fee, you must pass on to the recipients the same 40 | freedoms that you received. You must make sure that they, too, receive 41 | or can get the source code. And you must show them these terms so they 42 | know their rights. 43 | 44 | Developers that use the GNU GPL protect your rights with two steps: 45 | (1) assert copyright on the software, and (2) offer you this License 46 | giving you legal permission to copy, distribute and/or modify it. 47 | 48 | For the developers' and authors' protection, the GPL clearly explains 49 | that there is no warranty for this free software. For both users' and 50 | authors' sake, the GPL requires that modified versions be marked as 51 | changed, so that their problems will not be attributed erroneously to 52 | authors of previous versions. 53 | 54 | Some devices are designed to deny users access to install or run 55 | modified versions of the software inside them, although the 56 | manufacturer can do so. This is fundamentally incompatible with the 57 | aim of protecting users' freedom to change the software. The 58 | systematic pattern of such abuse occurs in the area of products for 59 | individuals to use, which is precisely where it is most unacceptable. 60 | Therefore, we have designed this version of the GPL to prohibit the 61 | practice for those products. If such problems arise substantially in 62 | other domains, we stand ready to extend this provision to those 63 | domains in future versions of the GPL, as needed to protect the 64 | freedom of users. 65 | 66 | Finally, every program is threatened constantly by software patents. 67 | States should not allow patents to restrict development and use of 68 | software on general-purpose computers, but in those that do, we wish 69 | to avoid the special danger that patents applied to a free program 70 | could make it effectively proprietary. To prevent this, the GPL 71 | assures that patents cannot be used to render the program non-free. 72 | 73 | The precise terms and conditions for copying, distribution and 74 | modification follow. 75 | 76 | ### TERMS AND CONDITIONS 77 | 78 | #### 0. Definitions. 79 | 80 | "This License" refers to version 3 of the GNU General Public License. 81 | 82 | "Copyright" also means copyright-like laws that apply to other kinds 83 | of works, such as semiconductor masks. 84 | 85 | "The Program" refers to any copyrightable work licensed under this 86 | License. Each licensee is addressed as "you". "Licensees" and 87 | "recipients" may be individuals or organizations. 88 | 89 | To "modify" a work means to copy from or adapt all or part of the work 90 | in a fashion requiring copyright permission, other than the making of 91 | an exact copy. The resulting work is called a "modified version" of 92 | the earlier work or a work "based on" the earlier work. 93 | 94 | A "covered work" means either the unmodified Program or a work based 95 | on the Program. 96 | 97 | To "propagate" a work means to do anything with it that, without 98 | permission, would make you directly or secondarily liable for 99 | infringement under applicable copyright law, except executing it on a 100 | computer or modifying a private copy. Propagation includes copying, 101 | distribution (with or without modification), making available to the 102 | public, and in some countries other activities as well. 103 | 104 | To "convey" a work means any kind of propagation that enables other 105 | parties to make or receive copies. Mere interaction with a user 106 | through a computer network, with no transfer of a copy, is not 107 | conveying. 108 | 109 | An interactive user interface displays "Appropriate Legal Notices" to 110 | the extent that it includes a convenient and prominently visible 111 | feature that (1) displays an appropriate copyright notice, and (2) 112 | tells the user that there is no warranty for the work (except to the 113 | extent that warranties are provided), that licensees may convey the 114 | work under this License, and how to view a copy of this License. If 115 | the interface presents a list of user commands or options, such as a 116 | menu, a prominent item in the list meets this criterion. 117 | 118 | #### 1. Source Code. 119 | 120 | The "source code" for a work means the preferred form of the work for 121 | making modifications to it. "Object code" means any non-source form of 122 | a work. 123 | 124 | A "Standard Interface" means an interface that either is an official 125 | standard defined by a recognized standards body, or, in the case of 126 | interfaces specified for a particular programming language, one that 127 | is widely used among developers working in that language. 128 | 129 | The "System Libraries" of an executable work include anything, other 130 | than the work as a whole, that (a) is included in the normal form of 131 | packaging a Major Component, but which is not part of that Major 132 | Component, and (b) serves only to enable use of the work with that 133 | Major Component, or to implement a Standard Interface for which an 134 | implementation is available to the public in source code form. A 135 | "Major Component", in this context, means a major essential component 136 | (kernel, window system, and so on) of the specific operating system 137 | (if any) on which the executable work runs, or a compiler used to 138 | produce the work, or an object code interpreter used to run it. 139 | 140 | The "Corresponding Source" for a work in object code form means all 141 | the source code needed to generate, install, and (for an executable 142 | work) run the object code and to modify the work, including scripts to 143 | control those activities. However, it does not include the work's 144 | System Libraries, or general-purpose tools or generally available free 145 | programs which are used unmodified in performing those activities but 146 | which are not part of the work. For example, Corresponding Source 147 | includes interface definition files associated with source files for 148 | the work, and the source code for shared libraries and dynamically 149 | linked subprograms that the work is specifically designed to require, 150 | such as by intimate data communication or control flow between those 151 | subprograms and other parts of the work. 152 | 153 | The Corresponding Source need not include anything that users can 154 | regenerate automatically from other parts of the Corresponding Source. 155 | 156 | The Corresponding Source for a work in source code form is that same 157 | work. 158 | 159 | #### 2. Basic Permissions. 160 | 161 | All rights granted under this License are granted for the term of 162 | copyright on the Program, and are irrevocable provided the stated 163 | conditions are met. This License explicitly affirms your unlimited 164 | permission to run the unmodified Program. The output from running a 165 | covered work is covered by this License only if the output, given its 166 | content, constitutes a covered work. This License acknowledges your 167 | rights of fair use or other equivalent, as provided by copyright law. 168 | 169 | You may make, run and propagate covered works that you do not convey, 170 | without conditions so long as your license otherwise remains in force. 171 | You may convey covered works to others for the sole purpose of having 172 | them make modifications exclusively for you, or provide you with 173 | facilities for running those works, provided that you comply with the 174 | terms of this License in conveying all material for which you do not 175 | control copyright. Those thus making or running the covered works for 176 | you must do so exclusively on your behalf, under your direction and 177 | control, on terms that prohibit them from making any copies of your 178 | copyrighted material outside their relationship with you. 179 | 180 | Conveying under any other circumstances is permitted solely under the 181 | conditions stated below. Sublicensing is not allowed; section 10 makes 182 | it unnecessary. 183 | 184 | #### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 185 | 186 | No covered work shall be deemed part of an effective technological 187 | measure under any applicable law fulfilling obligations under article 188 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 189 | similar laws prohibiting or restricting circumvention of such 190 | measures. 191 | 192 | When you convey a covered work, you waive any legal power to forbid 193 | circumvention of technological measures to the extent such 194 | circumvention is effected by exercising rights under this License with 195 | respect to the covered work, and you disclaim any intention to limit 196 | operation or modification of the work as a means of enforcing, against 197 | the work's users, your or third parties' legal rights to forbid 198 | circumvention of technological measures. 199 | 200 | #### 4. Conveying Verbatim Copies. 201 | 202 | You may convey verbatim copies of the Program's source code as you 203 | receive it, in any medium, provided that you conspicuously and 204 | appropriately publish on each copy an appropriate copyright notice; 205 | keep intact all notices stating that this License and any 206 | non-permissive terms added in accord with section 7 apply to the code; 207 | keep intact all notices of the absence of any warranty; and give all 208 | recipients a copy of this License along with the Program. 209 | 210 | You may charge any price or no price for each copy that you convey, 211 | and you may offer support or warranty protection for a fee. 212 | 213 | #### 5. Conveying Modified Source Versions. 214 | 215 | You may convey a work based on the Program, or the modifications to 216 | produce it from the Program, in the form of source code under the 217 | terms of section 4, provided that you also meet all of these 218 | conditions: 219 | 220 | - a) The work must carry prominent notices stating that you modified 221 | it, and giving a relevant date. 222 | - b) The work must carry prominent notices stating that it is 223 | released under this License and any conditions added under 224 | section 7. This requirement modifies the requirement in section 4 225 | to "keep intact all notices". 226 | - c) You must license the entire work, as a whole, under this 227 | License to anyone who comes into possession of a copy. This 228 | License will therefore apply, along with any applicable section 7 229 | additional terms, to the whole of the work, and all its parts, 230 | regardless of how they are packaged. This License gives no 231 | permission to license the work in any other way, but it does not 232 | invalidate such permission if you have separately received it. 233 | - d) If the work has interactive user interfaces, each must display 234 | Appropriate Legal Notices; however, if the Program has interactive 235 | interfaces that do not display Appropriate Legal Notices, your 236 | work need not make them do so. 237 | 238 | A compilation of a covered work with other separate and independent 239 | works, which are not by their nature extensions of the covered work, 240 | and which are not combined with it such as to form a larger program, 241 | in or on a volume of a storage or distribution medium, is called an 242 | "aggregate" if the compilation and its resulting copyright are not 243 | used to limit the access or legal rights of the compilation's users 244 | beyond what the individual works permit. Inclusion of a covered work 245 | in an aggregate does not cause this License to apply to the other 246 | parts of the aggregate. 247 | 248 | #### 6. Conveying Non-Source Forms. 249 | 250 | You may convey a covered work in object code form under the terms of 251 | sections 4 and 5, provided that you also convey the machine-readable 252 | Corresponding Source under the terms of this License, in one of these 253 | ways: 254 | 255 | - a) Convey the object code in, or embodied in, a physical product 256 | (including a physical distribution medium), accompanied by the 257 | Corresponding Source fixed on a durable physical medium 258 | customarily used for software interchange. 259 | - b) Convey the object code in, or embodied in, a physical product 260 | (including a physical distribution medium), accompanied by a 261 | written offer, valid for at least three years and valid for as 262 | long as you offer spare parts or customer support for that product 263 | model, to give anyone who possesses the object code either (1) a 264 | copy of the Corresponding Source for all the software in the 265 | product that is covered by this License, on a durable physical 266 | medium customarily used for software interchange, for a price no 267 | more than your reasonable cost of physically performing this 268 | conveying of source, or (2) access to copy the Corresponding 269 | Source from a network server at no charge. 270 | - c) Convey individual copies of the object code with a copy of the 271 | written offer to provide the Corresponding Source. This 272 | alternative is allowed only occasionally and noncommercially, and 273 | only if you received the object code with such an offer, in accord 274 | with subsection 6b. 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 | - e) Convey the object code using peer-to-peer transmission, 288 | provided you inform other peers where the object code and 289 | Corresponding Source of the work are being offered to the general 290 | public at no charge under subsection 6d. 291 | 292 | A separable portion of the object code, whose source code is excluded 293 | from the Corresponding Source as a System Library, need not be 294 | included in conveying the object code work. 295 | 296 | A "User Product" is either (1) a "consumer product", which means any 297 | tangible personal property which is normally used for personal, 298 | family, or household purposes, or (2) anything designed or sold for 299 | incorporation into a dwelling. In determining whether a product is a 300 | consumer product, doubtful cases shall be resolved in favor of 301 | coverage. For a particular product received by a particular user, 302 | "normally used" refers to a typical or common use of that class of 303 | product, regardless of the status of the particular user or of the way 304 | in which the particular user actually uses, or expects or is expected 305 | to use, the product. A product is a consumer product regardless of 306 | whether the product has substantial commercial, industrial or 307 | non-consumer uses, unless such uses represent the only significant 308 | 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 312 | install and execute modified versions of a covered work in that User 313 | Product from a modified version of its Corresponding Source. The 314 | information must suffice to ensure that the continued functioning of 315 | the modified object code is in no case prevented or interfered with 316 | solely because 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 331 | updates for a work that has been modified or installed by the 332 | recipient, or for the User Product in which it has been modified or 333 | installed. Access to a network may be denied when the modification 334 | itself materially and adversely affects the operation of the network 335 | or violates the rules and protocols for communication across the 336 | network. 337 | 338 | Corresponding Source conveyed, and Installation Information provided, 339 | in accord with this section must be in a format that is publicly 340 | documented (and with an implementation available to the public in 341 | source code form), and must require no special password or key for 342 | unpacking, reading or copying. 343 | 344 | #### 7. Additional Terms. 345 | 346 | "Additional permissions" are terms that supplement the terms of this 347 | License by making exceptions from one or more of its conditions. 348 | Additional permissions that are applicable to the entire Program shall 349 | be treated as though they were included in this License, to the extent 350 | that they are valid under applicable law. If additional permissions 351 | apply only to part of the Program, that part may be used separately 352 | under those permissions, but the entire Program remains governed by 353 | this License without regard to the additional permissions. 354 | 355 | When you convey a copy of a covered work, you may at your option 356 | remove any additional permissions from that copy, or from any part of 357 | it. (Additional permissions may be written to require their own 358 | removal in certain cases when you modify the work.) You may place 359 | additional permissions on material, added by you to a covered work, 360 | for which you have or can give appropriate copyright permission. 361 | 362 | Notwithstanding any other provision of this License, for material you 363 | add to a covered work, you may (if authorized by the copyright holders 364 | of that material) supplement the terms of this License with terms: 365 | 366 | - a) Disclaiming warranty or limiting liability differently from the 367 | terms of sections 15 and 16 of this License; or 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 | - c) Prohibiting misrepresentation of the origin of that material, 372 | or requiring that modified versions of such material be marked in 373 | reasonable ways as different from the original version; or 374 | - d) Limiting the use for publicity purposes of names of licensors 375 | or authors of the material; or 376 | - e) Declining to grant rights under trademark law for use of some 377 | trade names, trademarks, or service marks; or 378 | - f) Requiring indemnification of licensors and authors of that 379 | material by anyone who conveys the material (or modified versions 380 | of it) with contractual assumptions of liability to the recipient, 381 | for any liability that these contractual assumptions directly 382 | impose on those licensors and authors. 383 | 384 | All other non-permissive additional terms are considered "further 385 | restrictions" within the meaning of section 10. If the Program as you 386 | received it, or any part of it, contains a notice stating that it is 387 | governed by this License along with a term that is a further 388 | restriction, you may remove that term. If a license document contains 389 | a further restriction but permits relicensing or conveying under this 390 | License, you may add to a covered work material governed by the terms 391 | of that license document, provided that the further restriction does 392 | not survive such relicensing or conveying. 393 | 394 | If you add terms to a covered work in accord with this section, you 395 | must place, in the relevant source files, a statement of the 396 | additional terms that apply to those files, or a notice indicating 397 | where to find the applicable terms. 398 | 399 | Additional terms, permissive or non-permissive, may be stated in the 400 | form of a separately written license, or stated as exceptions; the 401 | above requirements apply either way. 402 | 403 | #### 8. Termination. 404 | 405 | You may not propagate or modify a covered work except as expressly 406 | provided under this License. Any attempt otherwise to propagate or 407 | modify it is void, and will automatically terminate your rights under 408 | this License (including any patent licenses granted under the third 409 | paragraph of section 11). 410 | 411 | However, if you cease all violation of this License, then your license 412 | from a particular copyright holder is reinstated (a) provisionally, 413 | unless and until the copyright holder explicitly and finally 414 | terminates your license, and (b) permanently, if the copyright holder 415 | fails to notify you of the violation by some reasonable means prior to 416 | 60 days after the cessation. 417 | 418 | Moreover, your license from a particular copyright holder is 419 | reinstated permanently if the copyright holder notifies you of the 420 | violation by some reasonable means, this is the first time you have 421 | received notice of violation of this License (for any work) from that 422 | copyright holder, and you cure the violation prior to 30 days after 423 | your receipt of the notice. 424 | 425 | Termination of your rights under this section does not terminate the 426 | licenses of parties who have received copies or rights from you under 427 | this License. If your rights have been terminated and not permanently 428 | reinstated, you do not qualify to receive new licenses for the same 429 | material under section 10. 430 | 431 | #### 9. Acceptance Not Required for Having Copies. 432 | 433 | You are not required to accept this License in order to receive or run 434 | a copy of the Program. Ancillary propagation of a covered work 435 | occurring solely as a consequence of using peer-to-peer transmission 436 | to receive a copy likewise does not require acceptance. However, 437 | nothing other than this License grants you permission to propagate or 438 | modify any covered work. These actions infringe copyright if you do 439 | not accept this License. Therefore, by modifying or propagating a 440 | covered work, you indicate your acceptance of this License to do so. 441 | 442 | #### 10. Automatic Licensing of Downstream Recipients. 443 | 444 | Each time you convey a covered work, the recipient automatically 445 | receives a license from the original licensors, to run, modify and 446 | propagate that work, subject to this License. You are not responsible 447 | for enforcing compliance by third parties with this License. 448 | 449 | An "entity transaction" is a transaction transferring control of an 450 | organization, or substantially all assets of one, or subdividing an 451 | organization, or merging organizations. If propagation of a covered 452 | work results from an entity transaction, each party to that 453 | transaction who receives a copy of the work also receives whatever 454 | licenses to the work the party's predecessor in interest had or could 455 | give under the previous paragraph, plus a right to possession of the 456 | Corresponding Source of the work from the predecessor in interest, if 457 | the predecessor has it or can get it with reasonable efforts. 458 | 459 | You may not impose any further restrictions on the exercise of the 460 | rights granted or affirmed under this License. For example, you may 461 | not impose a license fee, royalty, or other charge for exercise of 462 | rights granted under this License, and you may not initiate litigation 463 | (including a cross-claim or counterclaim in a lawsuit) alleging that 464 | any patent claim is infringed by making, using, selling, offering for 465 | sale, or importing the Program or any portion of it. 466 | 467 | #### 11. Patents. 468 | 469 | A "contributor" is a copyright holder who authorizes use under this 470 | License of the Program or a work on which the Program is based. The 471 | work thus licensed is called the contributor's "contributor version". 472 | 473 | A contributor's "essential patent claims" are all patent claims owned 474 | or controlled by the contributor, whether already acquired or 475 | hereafter acquired, that would be infringed by some manner, permitted 476 | by this License, of making, using, or selling its contributor version, 477 | but do not include claims that would be infringed only as a 478 | consequence of further modification of the contributor version. For 479 | purposes of this definition, "control" includes the right to grant 480 | patent sublicenses in a manner consistent with the requirements of 481 | this License. 482 | 483 | Each contributor grants you a non-exclusive, worldwide, royalty-free 484 | patent license under the contributor's essential patent claims, to 485 | make, use, sell, offer for sale, import and otherwise run, modify and 486 | propagate the contents of its contributor version. 487 | 488 | In the following three paragraphs, a "patent license" is any express 489 | agreement or commitment, however denominated, not to enforce a patent 490 | (such as an express permission to practice a patent or covenant not to 491 | sue for patent infringement). To "grant" such a patent license to a 492 | party means to make such an agreement or commitment not to enforce a 493 | patent against the party. 494 | 495 | If you convey a covered work, knowingly relying on a patent license, 496 | and the Corresponding Source of the work is not available for anyone 497 | to copy, free of charge and under the terms of this License, through a 498 | publicly available network server or other readily accessible means, 499 | then you must either (1) cause the Corresponding Source to be so 500 | available, or (2) arrange to deprive yourself of the benefit of the 501 | patent license for this particular work, or (3) arrange, in a manner 502 | consistent with the requirements of this License, to extend the patent 503 | license to downstream recipients. "Knowingly relying" means you have 504 | actual knowledge that, but for the patent license, your conveying the 505 | covered work in a country, or your recipient's use of the covered work 506 | in a country, would infringe one or more identifiable patents in that 507 | country that you have reason to believe are valid. 508 | 509 | If, pursuant to or in connection with a single transaction or 510 | arrangement, you convey, or propagate by procuring conveyance of, a 511 | covered work, and grant a patent license to some of the parties 512 | receiving the covered work authorizing them to use, propagate, modify 513 | or convey a specific copy of the covered work, then the patent license 514 | you grant is automatically extended to all recipients of the covered 515 | work and works based on it. 516 | 517 | A patent license is "discriminatory" if it does not include within the 518 | scope of its coverage, prohibits the exercise of, or is conditioned on 519 | the non-exercise of one or more of the rights that are specifically 520 | granted under this License. You may not convey a covered work if you 521 | are a party to an arrangement with a third party that is in the 522 | business of distributing software, under which you make payment to the 523 | third party based on the extent of your activity of conveying the 524 | work, and under which the third party grants, to any of the parties 525 | who would receive the covered work from you, a discriminatory patent 526 | license (a) in connection with copies of the covered work conveyed by 527 | you (or copies made from those copies), or (b) primarily for and in 528 | connection with specific products or compilations that contain the 529 | covered work, unless you entered into that arrangement, or that patent 530 | license was granted, prior to 28 March 2007. 531 | 532 | Nothing in this License shall be construed as excluding or limiting 533 | any implied license or other defenses to infringement that may 534 | otherwise be available to you under applicable patent law. 535 | 536 | #### 12. No Surrender of Others' Freedom. 537 | 538 | If conditions are imposed on you (whether by court order, agreement or 539 | otherwise) that contradict the conditions of this License, they do not 540 | excuse you from the conditions of this License. If you cannot convey a 541 | covered work so as to satisfy simultaneously your obligations under 542 | this License and any other pertinent obligations, then as a 543 | consequence you may not convey it at all. For example, if you agree to 544 | terms that obligate you to collect a royalty for further conveying 545 | from those to whom you convey the Program, the only way you could 546 | satisfy both those terms and this License would be to refrain entirely 547 | from conveying the Program. 548 | 549 | #### 13. Use with the GNU Affero General Public License. 550 | 551 | Notwithstanding any other provision of this License, you have 552 | permission to link or combine any covered work with a work licensed 553 | under version 3 of the GNU Affero General Public License into a single 554 | combined work, and to convey the resulting work. The terms of this 555 | License will continue to apply to the part which is the covered work, 556 | but the special requirements of the GNU Affero General Public License, 557 | section 13, concerning interaction through a network will apply to the 558 | combination as such. 559 | 560 | #### 14. Revised Versions of this License. 561 | 562 | The Free Software Foundation may publish revised and/or new versions 563 | of the GNU General Public License from time to time. Such new versions 564 | will be similar in spirit to the present version, but may differ in 565 | detail to address new problems or concerns. 566 | 567 | Each version is given a distinguishing version number. If the Program 568 | specifies that a certain numbered version of the GNU General Public 569 | License "or any later version" applies to it, you have the option of 570 | following the terms and conditions either of that numbered version or 571 | of any later version published by the Free Software Foundation. If the 572 | Program does not specify a version number of the GNU General Public 573 | License, you may choose any version ever published by the Free 574 | Software Foundation. 575 | 576 | If the Program specifies that a proxy can decide which future versions 577 | of the GNU General Public License can be used, that proxy's public 578 | statement of acceptance of a version permanently authorizes you to 579 | choose that version for the Program. 580 | 581 | Later license versions may give you additional or different 582 | permissions. However, no additional obligations are imposed on any 583 | author or copyright holder as a result of your choosing to follow a 584 | later version. 585 | 586 | #### 15. Disclaimer of Warranty. 587 | 588 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 589 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 590 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT 591 | WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT 592 | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 593 | A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND 594 | PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE 595 | DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR 596 | CORRECTION. 597 | 598 | #### 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR 602 | CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 603 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES 604 | ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT 605 | NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR 606 | LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM 607 | TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER 608 | PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 609 | 610 | #### 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | ### How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these 626 | terms. 627 | 628 | To do so, attach the following notices to the program. It is safest to 629 | attach them to the start of each source file to most effectively state 630 | the exclusion of warranty; and each file should have at least the 631 | "copyright" line and a pointer to where the full notice is found. 632 | 633 | 634 | Copyright (C) 635 | 636 | This program is free software: you can redistribute it and/or modify 637 | it under the terms of the GNU General Public License as published by 638 | the Free Software Foundation, either version 3 of the License, or 639 | (at your option) any later version. 640 | 641 | This program is distributed in the hope that it will be useful, 642 | but WITHOUT ANY WARRANTY; without even the implied warranty of 643 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 644 | GNU General Public License for more details. 645 | 646 | You should have received a copy of the GNU General Public License 647 | along with this program. If not, see . 648 | 649 | Also add information on how to contact you by electronic and paper 650 | 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 661 | appropriate parts of the General Public License. Of course, your 662 | program's commands might be different; for a GUI interface, you would 663 | use an "about box". 664 | 665 | You should also get your employer (if you work as a programmer) or 666 | school, if any, to sign a "copyright disclaimer" for the program, if 667 | necessary. For more information on this, and how to apply and follow 668 | the GNU GPL, see . 669 | 670 | The GNU General Public License does not permit incorporating your 671 | program into proprietary programs. If your program is a subroutine 672 | library, you may consider it more useful to permit linking proprietary 673 | applications with the library. If this is what you want to do, use the 674 | GNU Lesser General Public License instead of this License. But first, 675 | please read . 676 | --------------------------------------------------------------------------------