├── hidraw.pyx ├── docs ├── _static │ └── .gitkeep ├── requirements.txt ├── api.rst ├── index.rst ├── Makefile ├── make.bat ├── examples.rst └── conf.py ├── hid.pyxdep ├── requirements.txt ├── .gitmodules ├── LICENSE-orig.txt ├── pyproject.toml ├── tox.ini ├── tests.py ├── .gitignore ├── MANIFEST.in ├── LICENSE.txt ├── .readthedocs.yml ├── .github └── workflows │ ├── wheels.yml │ └── tox.yml ├── try.py ├── LICENSE-bsd.txt ├── chid.pxd ├── README.rst ├── setup.py ├── hid.pyx └── LICENSE-gpl3.txt /hidraw.pyx: -------------------------------------------------------------------------------- 1 | hid.pyx -------------------------------------------------------------------------------- /docs/_static/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /hid.pyxdep: -------------------------------------------------------------------------------- 1 | chid.pxd 2 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | Cython>=0.24 2 | -------------------------------------------------------------------------------- /docs/requirements.txt: -------------------------------------------------------------------------------- 1 | sphinx 2 | sphinx-rtd-theme -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "hidapi"] 2 | path = hidapi 3 | url = https://github.com/libusb/hidapi.git 4 | -------------------------------------------------------------------------------- /LICENSE-orig.txt: -------------------------------------------------------------------------------- 1 | You are free to use cython-hidapi code for any purpose. 2 | 3 | Copyright 2011, Gary Bishop 4 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | requires = ["setuptools", "Cython"] 3 | build-backend = "setuptools.build_meta" 4 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | envlist = 3 | py38, 4 | py39, 5 | py310, 6 | py311, 7 | py312, 8 | 9 | [testenv] 10 | deps = 11 | -rrequirements.txt 12 | commands = 13 | python tests.py 14 | -------------------------------------------------------------------------------- /docs/api.rst: -------------------------------------------------------------------------------- 1 | API 2 | === 3 | 4 | List devices 5 | ------------ 6 | 7 | .. autofunction:: hid.enumerate 8 | 9 | 10 | Device class 11 | ------------ 12 | 13 | .. autoclass:: hid.device 14 | :members: 15 | :undoc-members: 16 | -------------------------------------------------------------------------------- /tests.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | 3 | import hid 4 | 5 | 6 | class HIDTests(unittest.TestCase): 7 | def test_enumerate(self): 8 | self.assertTrue(len(hid.enumerate()) >= 0) 9 | 10 | 11 | if __name__ == "__main__": 12 | unittest.main() 13 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Build directories 2 | build/ 3 | dist/ 4 | MANIFEST 5 | hid.c 6 | hidraw.c 7 | .eggs/ 8 | hidapi.egg-info/ 9 | 10 | # Temp files 11 | hid.*.pyd 12 | 13 | # Testing 14 | .tox/ 15 | 16 | # IDE files 17 | .idea/ 18 | 19 | # Virtual environments 20 | venv/ 21 | 22 | # Doc output 23 | docs/_build 24 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include hidapi/hidapi/*.h 2 | include hidapi/libusb/*.c 3 | include hidapi/libusb/*.h 4 | include hidapi/linux/*.c 5 | include hidapi/linux/*.h 6 | include hidapi/mac/*.c 7 | include hidapi/mac/*.h 8 | include hidapi/windows/*.c 9 | include hidapi/windows/*.h 10 | include LICENSE*.txt 11 | include tests.py 12 | include try.py 13 | include chid.pxd 14 | include hid.c 15 | include hid.pyx 16 | include hidraw.pyx 17 | -------------------------------------------------------------------------------- /docs/index.rst: -------------------------------------------------------------------------------- 1 | .. HIDAPI documentation master file, created by 2 | sphinx-quickstart on Tue Feb 9 09:56:35 2021. 3 | You can adapt this file completely to your liking, but it should at least 4 | contain the root `toctree` directive. 5 | 6 | Welcome to HIDAPI's documentation! 7 | ================================== 8 | 9 | .. toctree:: 10 | :maxdepth: 2 11 | :caption: Contents: 12 | 13 | Home 14 | examples.rst 15 | api.rst 16 | 17 | 18 | Indices and tables 19 | ================== 20 | 21 | * :ref:`genindex` 22 | * :ref:`modindex` 23 | * :ref:`search` 24 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | cython-hidapi can be used under one of three licenses. 2 | 3 | 1. The GNU General Public License, version 3.0, in LICENSE-gpl3.txt 4 | 2. A BSD-Style License, in LICENSE-bsd.txt. 5 | 3. The more liberal original cython-hidapi license. LICENSE-orig.txt 6 | 7 | The license chosen is at the discretion of the user of cython-hidapi. For example: 8 | 1. An author of GPL software would likely use HIDAPI under the terms of the 9 | GPL. 10 | 11 | 2. An author of commercial closed-source software would likely use HIDAPI 12 | under the terms of the BSD-style license or the original cython-hidapi license. 13 | 14 | -------------------------------------------------------------------------------- /docs/Makefile: -------------------------------------------------------------------------------- 1 | # Minimal makefile for Sphinx documentation 2 | # 3 | 4 | # You can set these variables from the command line, and also 5 | # from the environment for the first two. 6 | SPHINXOPTS ?= 7 | SPHINXBUILD ?= sphinx-build 8 | SOURCEDIR = . 9 | BUILDDIR = _build 10 | 11 | # Put it first so that "make" without argument is like "make help". 12 | help: 13 | @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 14 | 15 | .PHONY: help Makefile 16 | 17 | # Catch-all target: route all unknown targets to Sphinx using the new 18 | # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). 19 | %: Makefile 20 | @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 21 | -------------------------------------------------------------------------------- /.readthedocs.yml: -------------------------------------------------------------------------------- 1 | # .readthedocs.yml 2 | # Read the Docs configuration file 3 | # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details 4 | 5 | # Required 6 | version: 2 7 | 8 | build: 9 | apt_packages: 10 | - libusb-1.0.0-dev 11 | - libudev-dev 12 | 13 | # Build documentation in the docs/ directory with Sphinx 14 | sphinx: 15 | configuration: docs/conf.py 16 | 17 | # Also checkout any submodules 18 | submodules: 19 | include: all 20 | 21 | # Optionally build your docs in additional formats such as PDF 22 | formats: 23 | - pdf 24 | 25 | # Optionally set the version of Python and requirements required to build your docs 26 | python: 27 | version: 3.10 28 | install: 29 | - requirements: docs/requirements.txt 30 | - method: setuptools 31 | path: . 32 | -------------------------------------------------------------------------------- /docs/make.bat: -------------------------------------------------------------------------------- 1 | @ECHO OFF 2 | 3 | pushd %~dp0 4 | 5 | REM Command file for Sphinx documentation 6 | 7 | if "%SPHINXBUILD%" == "" ( 8 | set SPHINXBUILD=sphinx-build 9 | ) 10 | set SOURCEDIR=. 11 | set BUILDDIR=_build 12 | 13 | if "%1" == "" goto help 14 | 15 | %SPHINXBUILD% >NUL 2>NUL 16 | if errorlevel 9009 ( 17 | echo. 18 | echo.The 'sphinx-build' command was not found. Make sure you have Sphinx 19 | echo.installed, then set the SPHINXBUILD environment variable to point 20 | echo.to the full path of the 'sphinx-build' executable. Alternatively you 21 | echo.may add the Sphinx directory to PATH. 22 | echo. 23 | echo.If you don't have Sphinx installed, grab it from 24 | echo.http://sphinx-doc.org/ 25 | exit /b 1 26 | ) 27 | 28 | %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% 29 | goto end 30 | 31 | :help 32 | %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% 33 | 34 | :end 35 | popd 36 | -------------------------------------------------------------------------------- /.github/workflows/wheels.yml: -------------------------------------------------------------------------------- 1 | name: Wheel builder 2 | 3 | on: workflow_dispatch 4 | 5 | jobs: 6 | build_wheels: 7 | name: ${{ matrix.os }}, ${{ matrix.arch }} 8 | runs-on: ${{ matrix.os }} 9 | strategy: 10 | matrix: 11 | os: [ubuntu-latest, windows-latest, macos-latest] 12 | 13 | steps: 14 | - name: Checkout source 15 | uses: actions/checkout@v5 16 | with: 17 | submodules: true 18 | 19 | - name: Setup Python 20 | uses: actions/setup-python@v5 21 | with: 22 | python-version: "3.14" 23 | 24 | - name: Setup QEMU 25 | if: ${{ runner.os == 'Linux' }} 26 | uses: docker/setup-qemu-action@v3 27 | 28 | - name: Build wheels 29 | uses: pypa/cibuildwheel@v3.3.0 30 | env: 31 | CIBW_BUILD: "cp3*-*" 32 | CIBW_ARCHS_WINDOWS: "auto" 33 | CIBW_ARCHS_MACOS: "x86_64 arm64" 34 | CIBW_ARCHS_LINUX: "x86_64 i686 aarch64" 35 | CIBW_MANYLINUX_X86_64_IMAGE: manylinux2014 36 | CIBW_BEFORE_ALL_LINUX: yum install -y libusb1-devel libudev-devel || apk add --upgrade libusb-dev eudev-dev 37 | 38 | - name: Store artifacts 39 | uses: actions/upload-artifact@v5 40 | with: 41 | name: cibw-wheels-${{ matrix.os }}-${{ strategy.job-index }} 42 | path: wheelhouse/*.whl 43 | -------------------------------------------------------------------------------- /try.py: -------------------------------------------------------------------------------- 1 | from __future__ import print_function 2 | 3 | import hid 4 | import time 5 | 6 | # enumerate USB devices 7 | 8 | for d in hid.enumerate(): 9 | keys = list(d.keys()) 10 | keys.sort() 11 | for key in keys: 12 | print("%s : %s" % (key, d[key])) 13 | print() 14 | 15 | # try opening a device, then perform write and read 16 | h = hid.device() 17 | try: 18 | print("Opening the device") 19 | h.open(0x534C, 0x0001) # TREZOR VendorID/ProductID 20 | 21 | print("Manufacturer: %s" % h.get_manufacturer_string()) 22 | print("Product: %s" % h.get_product_string()) 23 | print("Serial No: %s" % h.get_serial_number_string()) 24 | print("Report descriptor: %s" % h.get_report_descriptor()) 25 | 26 | # enable non-blocking mode 27 | h.set_nonblocking(1) 28 | 29 | # write some data to the device 30 | print("Write the data") 31 | h.write([0, 63, 35, 35] + [0] * 61) 32 | 33 | # wait 34 | time.sleep(0.05) 35 | 36 | # read back the answer 37 | print("Read the data") 38 | while True: 39 | d = h.read(64) 40 | if d: 41 | print(d) 42 | else: 43 | break 44 | 45 | print("Closing the device") 46 | h.close() 47 | 48 | except IOError as ex: 49 | print(ex) 50 | print("hid error:") 51 | print(h.error()) 52 | print("") 53 | print("You probably don't have the hard-coded device.") 54 | print("Update the h.open() line in this script with the one") 55 | print("from the enumeration list output above and try again.") 56 | 57 | print("Done") 58 | -------------------------------------------------------------------------------- /LICENSE-bsd.txt: -------------------------------------------------------------------------------- 1 | Copyright (c) 2011, Gary Bishop 2 | All rights reserved. 3 | 4 | Redistribution and use in source and binary forms, with or without 5 | modification, are permitted provided that the following conditions are met: 6 | 7 | * Redistributions of source code must retain the above copyright notice, 8 | this list of conditions and the following disclaimer. 9 | * Redistributions in binary form must reproduce the above copyright 10 | notice, this list of conditions and the following disclaimer in the 11 | documentation and/or other materials provided with the distribution. 12 | * Neither the name of Signal 11 Software nor the names of its 13 | contributors may be used to endorse or promote products derived from 14 | this software without specific prior written permission. 15 | 16 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 17 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 | ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 20 | LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 | CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 | SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23 | INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24 | CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25 | ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 | POSSIBILITY OF SUCH DAMAGE. 27 | -------------------------------------------------------------------------------- /docs/examples.rst: -------------------------------------------------------------------------------- 1 | Examples 2 | ======== 3 | 4 | Finding devices 5 | --------------- 6 | 7 | List all info of all devices with: 8 | 9 | .. code-block:: python 10 | 11 | import hid 12 | 13 | for device_dict in hid.enumerate(): 14 | keys = list(device_dict.keys()) 15 | keys.sort() 16 | for key in keys: 17 | print("%s : %s" % (key, device_dict[key])) 18 | print() 19 | 20 | 21 | Connecting, reading and writing 22 | ------------------------------- 23 | 24 | .. code-block:: python 25 | 26 | try: 27 | print("Opening the device") 28 | 29 | h = hid.device() 30 | h.open(0x534C, 0x0001) # TREZOR VendorID/ProductID 31 | 32 | print("Manufacturer: %s" % h.get_manufacturer_string()) 33 | print("Product: %s" % h.get_product_string()) 34 | print("Serial No: %s" % h.get_serial_number_string()) 35 | 36 | # enable non-blocking mode 37 | h.set_nonblocking(1) 38 | 39 | # write some data to the device 40 | print("Write the data") 41 | h.write([0, 63, 35, 35] + [0] * 61) 42 | 43 | # wait 44 | time.sleep(0.05) 45 | 46 | # read back the answer 47 | print("Read the data") 48 | while True: 49 | d = h.read(64) 50 | if d: 51 | print(d) 52 | else: 53 | break 54 | 55 | print("Closing the device") 56 | h.close() 57 | 58 | except IOError as ex: 59 | print(ex) 60 | print("You probably don't have the hard-coded device.") 61 | print("Update the h.open() line in this script with the one") 62 | print("from the enumeration list output above and try again.") 63 | 64 | print("Done") 65 | -------------------------------------------------------------------------------- /docs/conf.py: -------------------------------------------------------------------------------- 1 | # Configuration file for the Sphinx documentation builder. 2 | # 3 | # This file only contains a selection of the most common options. For a full 4 | # list see the documentation: 5 | # https://www.sphinx-doc.org/en/master/usage/configuration.html 6 | 7 | # -- Path setup -------------------------------------------------------------- 8 | 9 | # If extensions (or modules to document with autodoc) are in another directory, 10 | # add these directories to sys.path here. If the directory is relative to the 11 | # documentation root, use os.path.abspath to make it absolute, like shown here. 12 | # 13 | import os 14 | import sys 15 | 16 | sys.path.insert(0, os.path.abspath("../")) # Add root directory to path 17 | 18 | 19 | # -- Project information ----------------------------------------------------- 20 | 21 | project = "HIDAPI" 22 | copyright = "2011-2024, SatoshiLabs & contributors" 23 | author = "SatoshiLabs" 24 | 25 | 26 | # -- General configuration --------------------------------------------------- 27 | 28 | # Add any Sphinx extension module names here, as strings. They can be 29 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 30 | # ones. 31 | extensions = [ 32 | "sphinx.ext.autodoc", 33 | ] 34 | 35 | # Add any paths that contain templates here, relative to this directory. 36 | templates_path = ["_templates"] 37 | 38 | source_suffix = { 39 | ".rst": "restructuredtext", 40 | } 41 | 42 | # List of patterns, relative to source directory, that match files and 43 | # directories to ignore when looking for source files. 44 | # This pattern also affects html_static_path and html_extra_path. 45 | exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] 46 | 47 | 48 | # -- Options for HTML output ------------------------------------------------- 49 | 50 | # The theme to use for HTML and HTML Help pages. See the documentation for 51 | # a list of builtin themes. 52 | # 53 | html_theme = "sphinx_rtd_theme" 54 | 55 | # Add any paths that contain custom static files (such as style sheets) here, 56 | # relative to this directory. They are copied after the builtin static files, 57 | # so a file named "default.css" will overwrite the builtin "default.css". 58 | html_static_path = ["_static"] 59 | -------------------------------------------------------------------------------- /chid.pxd: -------------------------------------------------------------------------------- 1 | from libc.stddef cimport wchar_t, size_t 2 | 3 | cdef extern from "": 4 | const int HID_API_MAX_REPORT_DESCRIPTOR_SIZE 5 | 6 | ctypedef struct hid_device: 7 | pass 8 | 9 | ctypedef enum hid_bus_type: 10 | HID_API_BUS_UNKNOWN = 0x00, 11 | HID_API_BUS_USB = 0x01, 12 | HID_API_BUS_BLUETOOTH = 0x02, 13 | HID_API_BUS_I2C = 0x03, 14 | HID_API_BUS_SPI = 0x04 15 | 16 | cdef struct hid_device_info: 17 | char *path 18 | unsigned short vendor_id 19 | unsigned short product_id 20 | wchar_t *serial_number 21 | unsigned short release_number 22 | wchar_t *manufacturer_string 23 | wchar_t *product_string 24 | unsigned short usage_page 25 | unsigned short usage 26 | int interface_number 27 | hid_device_info *next 28 | hid_bus_type bus_type 29 | 30 | hid_device_info* hid_enumerate(unsigned short, unsigned short) nogil 31 | void hid_free_enumeration(hid_device_info*) 32 | 33 | hid_device* hid_open(unsigned short, unsigned short, const wchar_t*) 34 | hid_device* hid_open_path(char *path) 35 | void hid_close(hid_device *) 36 | int hid_init() 37 | int hid_exit() 38 | int hid_write(hid_device* device, unsigned char *data, int length) nogil 39 | int hid_read(hid_device* device, unsigned char* data, int max_length) nogil 40 | int hid_read_timeout(hid_device* device, unsigned char* data, int max_length, int milliseconds) nogil 41 | int hid_set_nonblocking(hid_device* device, int value) 42 | int hid_get_report_descriptor(hid_device* device, unsigned char *data, int length) nogil 43 | int hid_send_feature_report(hid_device* device, unsigned char *data, int length) nogil 44 | int hid_get_feature_report(hid_device* device, unsigned char *data, int length) nogil 45 | int hid_get_input_report(hid_device* device, unsigned char *data, int length) nogil 46 | 47 | int hid_get_manufacturer_string(hid_device*, wchar_t *, size_t) 48 | int hid_get_product_string(hid_device*, wchar_t *, size_t) 49 | int hid_get_serial_number_string(hid_device*, wchar_t *, size_t) 50 | int hid_get_indexed_string(hid_device*, int, wchar_t *, size_t) 51 | wchar_t *hid_error(hid_device *) 52 | char* hid_version_str() 53 | -------------------------------------------------------------------------------- /.github/workflows/tox.yml: -------------------------------------------------------------------------------- 1 | name: Python package 2 | 3 | on: 4 | - push 5 | - pull_request 6 | 7 | jobs: 8 | build: 9 | strategy: 10 | fail-fast: false 11 | matrix: 12 | platform: [ubuntu-latest, macos-latest, windows-latest] 13 | python-version: ["3.10", "3.14"] 14 | system-hidapi: ["", "--with-system-hidapi"] 15 | libusb-backend: ["", "--with-libusb"] 16 | exclude: 17 | # TODO: it is non-trivial to install pkg-config and HIDAPI, 18 | # and configure it run work in runtime 19 | - platform: windows-latest 20 | system-hidapi: "--with-system-hidapi" 21 | # libusb backend is not present on Windows/macOS 22 | - platform: macos-latest 23 | libusb-backend: "--with-libusb" 24 | - platform: windows-latest 25 | libusb-backend: "--with-libusb" 26 | 27 | runs-on: ${{ matrix.platform }} 28 | 29 | steps: 30 | - uses: actions/checkout@v4 31 | with: 32 | submodules: true 33 | 34 | - name: Install Ubuntu dependencies 35 | if: matrix.platform == 'ubuntu-latest' 36 | run: sudo apt install libudev-dev libusb-1.0-0-dev 37 | 38 | - name: Install Ubuntu HIDAPI 39 | if: ${{ (matrix.platform == 'ubuntu-latest') && (matrix.system-hidapi == '--with-system-hidapi') }} 40 | # the default apt version of libhidapi-dev is too old, need to build the one we know would work 41 | run: | 42 | sudo apt install cmake 43 | mkdir hidapi_build && cd hidapi_build 44 | cmake -B . -S ../hidapi -DCMAKE_INSTALL_PREFIX=/usr 45 | make 46 | sudo make install 47 | 48 | - name: Install macOS HIDAPI 49 | if: ${{ (matrix.platform == 'macos-latest') && (matrix.system-hidapi == '--with-system-hidapi') }} 50 | run: brew install hidapi 51 | 52 | - name: Set up Python ${{ matrix.python-version }} 53 | uses: actions/setup-python@v4 54 | with: 55 | python-version: ${{ matrix.python-version }} 56 | 57 | - name: Install Python dependencies 58 | run: | 59 | python -m pip install --upgrade pip 60 | python -m pip install setuptools tox tox-gh-actions 61 | pip install -r requirements.txt --upgrade 62 | 63 | - name: Test with tox 64 | env: 65 | HIDAPI_SYSTEM_HIDAPI: ${{ matrix.system-hidapi == '--with-system-hidapi' && '1' || '0' }} 66 | HIDAPI_WITH_LIBUSB: ${{ matrix.libusb-backend == '--with-libusb' && '1' || '0' }} 67 | run: | 68 | pip install . 69 | tox 70 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | cython-hidapi 2 | ============= 3 | 4 | .. contents:: 5 | 6 | Description 7 | ----------- 8 | 9 | A Cython interface to `HIDAPI `_ library. 10 | 11 | This has been tested with: 12 | 13 | * `TREZOR `_ Hardware Wallet 14 | * the PIC18F4550 on the development board from CCS with their example program 15 | * the Fine Offset WH3081 Weather Station 16 | 17 | It works on Linux, Windows and macOS. 18 | 19 | Software Dependencies 20 | --------------------- 21 | 22 | * `Python `_ 23 | * `Cython `_ 24 | * hidraw or libusb+libudev on Linux 25 | 26 | License 27 | ------- 28 | 29 | cython-hidapi may be used by one of three licenses as outlined in LICENSE.txt 30 | 31 | Install 32 | ------- 33 | 34 | :: 35 | 36 | $ sudo apt-get install python-dev libusb-1.0-0-dev libudev-dev 37 | $ sudo pip install --upgrade setuptools 38 | $ sudo pip install hidapi 39 | 40 | For other download options visit the `PyPi page `_. 41 | 42 | Build from source 43 | ----------------- 44 | 45 | 1. Download cython-hidapi archive:: 46 | 47 | $ git clone --recursive https://github.com/trezor/cython-hidapi.git 48 | $ cd cython-hidapi 49 | 50 | 2. Build cython-hidapi extension module:: 51 | 52 | $ python setup.py build 53 | 54 | On Linux, the hidraw API is now used by default, and the libusb API is not 55 | included. That is, --without-libusb is now the default behavior. 56 | To force the use of the libusb API instead, use the --with-libusb option:: 57 | 58 | $ python setup.py build --with-libusb 59 | 60 | Or you can also use the environment variable:: 61 | 62 | $ export HIDAPI_WITH_LIBUSB=1 63 | $ python setup.py build 64 | 65 | 3. Install cython-hidapi module into your Python distribution:: 66 | 67 | $ sudo python setup.py install 68 | 69 | **Alternatively**, you can run pip directly, which will call the necessary build and install commands:: 70 | 71 | $ pip install -e . 72 | 73 | 4. Test install:: 74 | 75 | $ python 76 | >>> import hid 77 | >>> 78 | 79 | 5. Try example script:: 80 | 81 | $ python try.py 82 | 83 | Udev rules 84 | ---------- 85 | 86 | For correct functionality under Linux, you need to create a rule file similar 87 | to `this one `_ 88 | in your udev rules directory. 89 | 90 | Also you might need to call ``udevadm control --reload-rules`` to reload the rules. 91 | 92 | Documentation 93 | ------------- 94 | 95 | Documentation can be built using Sphinx:: 96 | 97 | $ cd docs && make html 98 | 99 | The HTML output will be in ``docs/_build/html``. 100 | 101 | The documentation is extracted from the code using ``autodoc``. 102 | 103 | Note that the build output is used. So rebuilt the package before generating documentation. 104 | 105 | Built documentation is also deployed to: `https://trezor.github.io/cython-hidapi/ `_. 106 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | from Cython.Build import cythonize 3 | from setuptools import setup, Extension, Distribution 4 | from subprocess import call, PIPE, Popen 5 | import os 6 | import re 7 | import shlex 8 | import subprocess 9 | import sys 10 | 11 | min_required_hidapi_version = "0.14" 12 | 13 | libusb_pkgconfig = "libusb-1.0 >= 1.0.9" 14 | hidapi_libusb_pkgconfig = "hidapi-libusb >= " + min_required_hidapi_version 15 | hidapi_hidraw_pkgconfig = "hidapi-hidraw >= " + min_required_hidapi_version 16 | hidapi_pkgconfig = "hidapi >= " + min_required_hidapi_version 17 | 18 | tld = os.path.abspath(os.path.dirname(__file__)) 19 | embedded_hidapi_topdir = os.path.join(tld, "hidapi") 20 | embedded_hidapi_include = os.path.join(embedded_hidapi_topdir, "hidapi") 21 | 22 | 23 | def to_bool(bool_str): 24 | if str(bool_str).lower() in ["true", "t", "1", "on", "yes", "y"]: 25 | return True 26 | return False 27 | 28 | 29 | def get_extension_compiler_type(): 30 | """ 31 | Returns a compiler to be used by setuptools to build Extensions 32 | Taken from https://github.com/pypa/setuptools/issues/2806#issuecomment-961805789 33 | """ 34 | d = Distribution() 35 | build_ext = Distribution().get_command_obj("build_ext") 36 | build_ext.finalize_options() 37 | # register an extension to ensure a compiler is created 38 | build_ext.extensions = [Extension("ignored", ["ignored.c"])] 39 | # disable building fake extensions 40 | build_ext.build_extensions = lambda: None 41 | # run to populate self.compiler 42 | build_ext.run() 43 | return build_ext.compiler.compiler_type 44 | 45 | 46 | # this could have been just pkgconfig.configure_extension(), but: https://github.com/matze/pkgconfig/issues/65 47 | # additionally contains a few small improvements 48 | def pkgconfig_configure_extension(ext, package): 49 | pkg_config_exe = os.environ.get("PKG_CONFIG", None) or "pkg-config" 50 | 51 | def exists(package): 52 | cmd = f"{pkg_config_exe} --exists '{package}'" 53 | return call(shlex.split(cmd)) == 0 54 | 55 | if not exists(package): 56 | raise Exception(f"pkg-config package '{package}' not found") 57 | 58 | def query_pkg_config(package, *options): 59 | cmd = f"{pkg_config_exe} {' '.join(options)} '{package}'" 60 | proc = Popen(shlex.split(cmd), stdout=PIPE, stderr=PIPE) 61 | out, err = proc.communicate() 62 | 63 | return out.rstrip().decode("utf-8") 64 | 65 | def query_and_extend(option, target): 66 | os_opts = ["--msvc-syntax"] if get_extension_compiler_type() == "msvc" else [] 67 | flags = query_pkg_config(package, *os_opts, option) 68 | flags = flags.replace('\\"', "") 69 | if flags: 70 | target.extend(re.split(r"(?=19.0"], 273 | ) 274 | -------------------------------------------------------------------------------- /hid.pyx: -------------------------------------------------------------------------------- 1 | import sys 2 | import weakref 3 | 4 | from chid cimport * 5 | from libc.stddef cimport wchar_t, size_t 6 | 7 | 8 | __version__ = "0.15.0" 9 | 10 | 11 | hid_init() 12 | 13 | 14 | cdef extern from "": 15 | int wcslen(wchar_t*) 16 | 17 | cdef extern from "": 18 | void free(void* ptr) 19 | void* malloc(size_t size) 20 | 21 | cdef extern from *: 22 | object PyUnicode_FromWideChar(const wchar_t *w, Py_ssize_t size) 23 | Py_ssize_t PyUnicode_AsWideChar(object unicode, wchar_t *w, Py_ssize_t size) 24 | 25 | cdef object U(wchar_t *wcs): 26 | if wcs == NULL: 27 | return '' 28 | cdef int n = wcslen(wcs) 29 | return PyUnicode_FromWideChar(wcs, n) 30 | 31 | def enumerate(int vendor_id=0, int product_id=0): 32 | """Return a list of discovered HID devices. 33 | 34 | The fields of dict are: 35 | 36 | - 'path' 37 | - 'vendor_id' 38 | - 'product_id' 39 | - 'serial_number' 40 | - 'release_number' 41 | - 'manufacturer_string' 42 | - 'product_string' 43 | - 'usage_page' 44 | - 'usage' 45 | - 'interface_number' 46 | 47 | :param vendor_id: Vendor id to look for, default = 0 48 | :type vendor_id: int, optional 49 | :param product_id: Product id to look for, default = 0 50 | :type product_id: int, optional 51 | :return: List of device dictionaries 52 | :rtype: List[Dict] 53 | """ 54 | cdef hid_device_info* info 55 | with nogil: 56 | info = hid_enumerate(vendor_id, product_id) 57 | cdef hid_device_info* c = info 58 | res = [] 59 | while c: 60 | res.append({ 61 | 'path': c.path, 62 | 'vendor_id': c.vendor_id, 63 | 'product_id': c.product_id, 64 | 'serial_number': U(c.serial_number), 65 | 'release_number': c.release_number, 66 | 'manufacturer_string': U(c.manufacturer_string), 67 | 'product_string': U(c.product_string), 68 | 'usage_page': c.usage_page, 69 | 'usage': c.usage, 70 | 'interface_number': c.interface_number, 71 | 'bus_type': c.bus_type, 72 | }) 73 | c = c.next 74 | hid_free_enumeration(info) 75 | return res 76 | 77 | def version_str(): 78 | """Return a runtime version string of the hidapi C library. 79 | 80 | :return: version string of library 81 | :rtype: str 82 | """ 83 | return (hid_version_str()).decode('ascii') 84 | 85 | cdef class _closer: 86 | """Wrap a hid_device *ptr and a provide a way to call hid_close() on it. 87 | 88 | Used internally for weakref.finalize, which only accepts Python objects. 89 | """ 90 | 91 | cdef hid_device *_ptr 92 | 93 | @staticmethod 94 | cdef wrap(hid_device *ptr): 95 | cdef _closer closer = _closer() 96 | closer._ptr = ptr 97 | return closer 98 | 99 | def close(self): 100 | hid_close(self._ptr) 101 | 102 | cdef class device: 103 | """Device class. 104 | 105 | A device instance can be used to read from and write to a HID device. 106 | """ 107 | 108 | cdef hid_device *_c_hid 109 | cdef object __weakref__ # enable weak-reference support 110 | cdef object _close 111 | 112 | def open(self, int vendor_id=0, int product_id=0, unicode serial_number=None): 113 | """Open the connection. 114 | 115 | :param vendor_id: Vendor id to connect to, default = 0 116 | :type vendor_id: int, optional 117 | :param product_id: Product id to connect to, default = 0 118 | :type product_id: int, optional 119 | :param serial_number: 120 | :type serial_number: unicode, optional 121 | :raises IOError: 122 | """ 123 | cdef wchar_t * cserial_number = NULL 124 | cdef int serial_len 125 | cdef Py_ssize_t result 126 | if self._c_hid != NULL: 127 | raise RuntimeError('already open') 128 | try: 129 | if serial_number is not None: 130 | serial_len = len(serial_number) 131 | cserial_number = malloc(sizeof(wchar_t) * (serial_len+1)) 132 | if cserial_number == NULL: 133 | raise MemoryError() 134 | result = PyUnicode_AsWideChar(serial_number, cserial_number, serial_len) 135 | if result == -1: 136 | raise ValueError("invalid serial number string") 137 | cserial_number[serial_len] = 0 # Must explicitly null-terminate 138 | self._c_hid = hid_open(vendor_id, product_id, cserial_number) 139 | finally: 140 | if cserial_number != NULL: 141 | free(cserial_number) 142 | if self._c_hid == NULL: 143 | raise IOError('open failed') 144 | self._close = weakref.finalize(self, _closer.wrap(self._c_hid).close) 145 | 146 | def open_path(self, bytes path): 147 | """Open connection by path. 148 | 149 | :param path: Path to device 150 | :type path: bytes 151 | :raises IOError: 152 | """ 153 | cdef char* cbuff = path 154 | if self._c_hid != NULL: 155 | raise RuntimeError('already open') 156 | self._c_hid = hid_open_path(cbuff) 157 | if self._c_hid == NULL: 158 | raise IOError('open failed') 159 | self._close = weakref.finalize(self, _closer.wrap(self._c_hid).close) 160 | 161 | def close(self): 162 | """Close connection. 163 | 164 | This should always be called after opening a connection. 165 | """ 166 | if self._c_hid != NULL: 167 | self._close() 168 | self._close.detach() 169 | self._c_hid = NULL 170 | 171 | def write(self, buff): 172 | """Accept a list of integers (0-255) and send them to the device. 173 | 174 | :param buff: Data to write (must be convertible to `bytes`) 175 | :type buff: Any 176 | :return: Write result 177 | :rtype: int 178 | """ 179 | if self._c_hid == NULL: 180 | raise ValueError('not open') 181 | # convert to bytes 182 | if sys.version_info < (3, 0): 183 | buff = ''.join(map(chr, buff)) 184 | else: 185 | buff = bytes(buff) 186 | cdef hid_device * c_hid = self._c_hid 187 | cdef unsigned char* cbuff = buff # covert to c string 188 | cdef size_t c_buff_len = len(buff) 189 | cdef int result 190 | with nogil: 191 | result = hid_write(c_hid, cbuff, c_buff_len) 192 | return result 193 | 194 | def set_nonblocking(self, int v): 195 | """Set the nonblocking flag. 196 | 197 | :param v: Flag value (1 or 0, True or False) 198 | :type v: int, bool 199 | :return: Flag result 200 | :rtype: int 201 | """ 202 | if self._c_hid == NULL: 203 | raise ValueError('not open') 204 | return hid_set_nonblocking(self._c_hid, v) 205 | 206 | def read(self, int max_length, int timeout_ms=0): 207 | """Return a list of integers (0-255) from the device up to max_length bytes. 208 | 209 | :param max_length: Maximum number of bytes to read 210 | :type max_length: int 211 | :param timeout_ms: Number of milliseconds until timeout (default: no timeout) 212 | :type timeout_ms: int, optional 213 | :return: Read bytes 214 | :rtype: List[int] 215 | """ 216 | if self._c_hid == NULL: 217 | raise ValueError('not open') 218 | cdef unsigned char lbuff[16] 219 | cdef unsigned char* cbuff 220 | cdef size_t c_max_length = max_length 221 | cdef int c_timeout_ms = timeout_ms 222 | cdef hid_device * c_hid = self._c_hid 223 | try: 224 | if max_length <= 16: 225 | cbuff = lbuff 226 | else: 227 | cbuff = malloc(max_length) 228 | if timeout_ms > 0: 229 | with nogil: 230 | n = hid_read_timeout(c_hid, cbuff, c_max_length, c_timeout_ms) 231 | else: 232 | with nogil: 233 | n = hid_read(c_hid, cbuff, c_max_length) 234 | if n == -1: 235 | raise IOError('read error') 236 | res = list(cbuff[:n]) 237 | finally: 238 | if max_length > 16: 239 | free(cbuff) 240 | return res 241 | 242 | def get_manufacturer_string(self): 243 | """Return manufacturer string (e.g. vendor name). 244 | 245 | :return: 246 | :rtype: str 247 | :raises ValueError: If connection is not opened. 248 | :raises IOError: 249 | """ 250 | if self._c_hid == NULL: 251 | raise ValueError('not open') 252 | cdef wchar_t buff[255] 253 | cdef int r = hid_get_manufacturer_string(self._c_hid, buff, 255) 254 | if r < 0: 255 | raise IOError('get manufacturer string error') 256 | return U(buff) 257 | 258 | 259 | def get_product_string(self): 260 | """Return product string (e.g. device description). 261 | 262 | :return: 263 | :rtype: str 264 | :raises ValueError: If connection is not opened. 265 | :raises IOError: 266 | """ 267 | if self._c_hid == NULL: 268 | raise ValueError('not open') 269 | cdef wchar_t buff[255] 270 | cdef int r = hid_get_product_string(self._c_hid, buff, 255) 271 | if r < 0: 272 | raise IOError('get product string error') 273 | return U(buff) 274 | 275 | def get_serial_number_string(self): 276 | """Return serial number. 277 | 278 | :return: 279 | :rtype: str 280 | :raises ValueError: If connection is not opened. 281 | :raises IOError: 282 | """ 283 | if self._c_hid == NULL: 284 | raise ValueError('not open') 285 | cdef wchar_t buff[255] 286 | cdef int r = hid_get_serial_number_string(self._c_hid, buff, 255) 287 | if r < 0: 288 | raise IOError('get serial number string error') 289 | return U(buff) 290 | 291 | def get_indexed_string(self, index): 292 | """Return indexed string. 293 | 294 | :return: 295 | :rtype: str 296 | :raises ValueError: If connection is not opened. 297 | :raises IOError: 298 | """ 299 | if self._c_hid == NULL: 300 | raise ValueError('not open') 301 | cdef wchar_t buff[255] 302 | cdef unsigned char c_index = index 303 | cdef int r = hid_get_indexed_string(self._c_hid, c_index, buff, 255) 304 | if r < 0: 305 | raise IOError('get indexed string error') 306 | return U(buff) 307 | 308 | def send_feature_report(self, buff): 309 | """Accept a list of integers (0-255) and send them to the device. 310 | 311 | :param buff: Data to send (must be convertible into bytes) 312 | :type buff: any 313 | :return: Send result 314 | :rtype: int 315 | """ 316 | if self._c_hid == NULL: 317 | raise ValueError('not open') 318 | # convert to bytes 319 | if sys.version_info < (3, 0): 320 | buff = ''.join(map(chr, buff)) 321 | else: 322 | buff = bytes(buff) 323 | cdef hid_device * c_hid = self._c_hid 324 | cdef unsigned char* cbuff = buff # covert to c string 325 | cdef size_t c_buff_len = len(buff) 326 | cdef int result 327 | with nogil: 328 | result = hid_send_feature_report(c_hid, cbuff, c_buff_len) 329 | return result 330 | 331 | def get_report_descriptor(self): 332 | """Return the HID Report Descriptor for this device. 333 | 334 | :return: 335 | :rtype: List[int] 336 | :raises ValueError: If connection is not opened. 337 | :raises IOError: If read error 338 | """ 339 | if self._c_hid == NULL: 340 | raise ValueError('not open') 341 | 342 | cdef unsigned char cbuff[HID_API_MAX_REPORT_DESCRIPTOR_SIZE] 343 | cdef hid_device * c_hid = self._c_hid 344 | cdef int n 345 | with nogil: 346 | n = hid_get_report_descriptor(c_hid, cbuff, sizeof(cbuff)) 347 | if n < 0: 348 | raise IOError('read error') 349 | return list(cbuff[:n]) 350 | 351 | def get_feature_report(self, int report_num, int max_length): 352 | """Receive feature report. 353 | 354 | :param report_num: 355 | :type report_num: int 356 | :param max_length: 357 | :type max_length: int 358 | :return: Incoming feature report 359 | :rtype: List[int] 360 | :raises ValueError: If connection is not opened. 361 | :raises IOError: 362 | """ 363 | if self._c_hid == NULL: 364 | raise ValueError('not open') 365 | cdef hid_device * c_hid = self._c_hid 366 | cdef unsigned char lbuff[16] 367 | cdef unsigned char* cbuff 368 | cdef size_t c_max_length = max_length 369 | cdef int n 370 | try: 371 | if max_length <= 16: 372 | cbuff = lbuff 373 | else: 374 | cbuff = malloc(max_length) 375 | cbuff[0] = report_num 376 | with nogil: 377 | n = hid_get_feature_report(c_hid, cbuff, c_max_length) 378 | if n < 0: 379 | raise IOError('read error') 380 | res = list(cbuff[:n]) 381 | finally: 382 | if max_length > 16: 383 | free(cbuff) 384 | return res 385 | 386 | def get_input_report(self, int report_num, int max_length): 387 | """Get input report 388 | 389 | :param report_num: 390 | :type report_num: int 391 | :param max_length: 392 | :type max_length: int 393 | :return: 394 | :rtype: List[int] 395 | :raises ValueError: If connection is not opened. 396 | :raises IOError: 397 | """ 398 | if self._c_hid == NULL: 399 | raise ValueError('not open') 400 | cdef hid_device * c_hid = self._c_hid 401 | cdef unsigned char lbuff[16] 402 | cdef unsigned char* cbuff 403 | cdef size_t c_max_length = max_length 404 | cdef int n 405 | try: 406 | if max_length <= 16: 407 | cbuff = lbuff 408 | else: 409 | cbuff = malloc(max_length) 410 | cbuff[0] = report_num 411 | with nogil: 412 | n = hid_get_input_report(c_hid, cbuff, c_max_length) 413 | if n < 0: 414 | raise IOError('read error') 415 | res = list(cbuff[:n]) 416 | finally: 417 | if max_length > 16: 418 | free(cbuff) 419 | return res 420 | 421 | def error(self): 422 | """Get error from device, or global error if no device is opened. 423 | 424 | :return: 425 | :rtype: str 426 | :raises IOError: 427 | """ 428 | return U(hid_error(self._c_hid)) 429 | 430 | 431 | # Finalize the HIDAPI library *only* once there are no more references to this 432 | # module, and it is being garbage collected. 433 | weakref.finalize(sys.modules[__name__], hid_exit) 434 | -------------------------------------------------------------------------------- /LICENSE-gpl3.txt: -------------------------------------------------------------------------------- 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 | --------------------------------------------------------------------------------