riffpi 0.2.4__tar.gz

riffpi-0.2.4/.github/FUNDING.yml

@@ -0,0 +1,15 @@
+# These are supported funding model platforms
+
+github: kleag# Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+polar: # Replace with a single Polar username
+buy_me_a_coffee: kleag# Replace with a single Buy Me a Coffee username
+thanks_dev: # Replace with a single thanks.dev username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

riffpi-0.2.4/.github/workflows/docs.yml

@@ -0,0 +1,32 @@
+name: docs
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+      - "README.md"
+      - ".github/workflows/docs.yml"
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force

riffpi-0.2.4/.github/workflows/lint-and-build.yml

@@ -0,0 +1,33 @@
+name: lint-and-build
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  lint-and-build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dev tooling
+        run: pip install ruff build twine
+
+      # Note: the package's runtime dependencies (Adafruit Blinka, gpiozero, ...) actively
+      # probe for real Raspberry Pi hardware on import, so they cannot be installed/imported
+      # on a generic GitHub-hosted runner. This job only lints and validates packaging, it
+      # does not import riffpi itself.
+      - name: Lint
+        run: ruff check src/
+
+      - name: Build sdist and wheel
+        run: python -m build
+
+      - name: Check package metadata
+        run: twine check dist/*

riffpi-0.2.4/.github/workflows/release.yml

@@ -0,0 +1,50 @@
+name: release
+
+on:
+  # Not `release: published`: tag-release.yml creates that release using the default
+  # GITHUB_TOKEN, and GitHub's anti-recursion rule means events created via GITHUB_TOKEN
+  # don't trigger other workflows. workflow_run isn't subject to that restriction, so we
+  # chain off tag-release.yml's completion instead.
+  workflow_run:
+    workflows: ["tag-release"]
+    types: [completed]
+
+jobs:
+  build:
+    if: github.event.workflow_run.conclusion == 'success'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.workflow_run.head_sha }}
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install build tooling
+        run: pip install build
+
+      - name: Build sdist and wheel
+        run: python -m build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      # Required for PyPI Trusted Publishing (OIDC) - no API token stored in this repo.
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

riffpi-0.2.4/.github/workflows/tag-release.yml

@@ -0,0 +1,19 @@
+name: tag-release
+
+on:
+  push:
+    tags:
+      - "*.*.*"
+
+jobs:
+  create-release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Create GitHub Release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: gh release create "${{ github.ref_name }}" --title "${{ github.ref_name }}" --generate-notes

riffpi-0.2.4/.gitignore

@@ -0,0 +1,14 @@
+__pycache__
+*.swp
+*.s
+.theia
+*.kdev4
+*.rpt
+fp-info-cache
+*.gbr*
+multieff.dsn
+multieff.ses
+*-backups
+site/
+dist/
+*.egg-info/

riffpi-0.2.4/.python-version

@@ -0,0 +1 @@
+3.11

riffpi-0.2.4/CLAUDE.md

@@ -0,0 +1,156 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project overview
+
+RiffPi (PyPI/import name `riffpi`; the GitHub repo is `kleag/riffpi`, formerly `kleag/kleagmfx`)
+is a DIY guitar
+multi-effect foot controller built around a Raspberry Pi 5 + Pisound sound card, running Guitarix
+as the effects engine. This repo holds:
+
+- `src/riffpi/`: the installable Python package — the control daemon that reads the physical
+  controls (foot switches, rotary encoders, keypad, joystick, expression pedal) and drives
+  Guitarix over a virtual MIDI port.
+- Root-level `*_test.py` / `*_int.py` files: standalone manual/legacy hardware scripts, **not**
+  part of the installed package (see Testing and Architecture below).
+- KiCad hardware design files for the controller PCB (`kicad_board/`).
+- MkDocs documentation source (`docs/`), published to GitHub Pages.
+
+The hardware talks to the Pi over I2C: two MCP23017 GPIO expanders (`0x20`, `0x21`) for buttons/
+LEDs/encoders/keypad, and an ADS1115 ADC for the analog joystick and expression pedal. Full
+wiring/pin maps live in `docs/architecture.md`; Raspberry Pi OS setup (I2C enablement, `uinput`
+permissions, systemd service, etc.) is in `docs/installation.md`.
+
+## Environment & running
+
+- Python >=3.11, packaged with `hatchling` (`[build-system]` in `pyproject.toml`). Build with
+  `python -m build` or `uv build`; install locally with `pip install -e .`.
+- Hardware-dependent libraries (`board`, `busio`, `digitalio`, `adafruit_*`, `gpiozero`, `uinput`,
+  ...) only work on an actual Raspberry Pi with I2C enabled and the user in the `input` group.
+  **None of this code can be run or imported on a non-Pi dev machine** — Blinka (`board`/`busio`)
+  actively probes for real hardware on import and raises if it doesn't find a supported board.
+  Reason about the package by reading; verify changes with `python -m py_compile` and `ruff
+  check src/`, not by importing/running it.
+- Entry point: the `riffpi` console script (`riffpi.cli:main`, installed via
+  `[project.scripts]`), an argparse dispatcher over three subcommands — `run` (default when no
+  subcommand is given), `install-service`, `uninstall-service`. `riffpi run` calls
+  `riffpi.daemon.run()`, which opens a virtual ALSA/JACK MIDI port named `KleagMFX` via `mido`,
+  links it to Guitarix (`gx_head_amp`) through PipeWire (`pw-link`), then spawns one thread per
+  input device (buttons, joystick, keypad, expression pedal, each rotary encoder) plus a
+  MIDI-input listener thread that keeps LED/encoder state in sync when Guitarix itself changes a
+  CC value.
+- `riffpi install-service` / `riffpi uninstall-service` (implemented in `riffpi/service.py`)
+  write/remove `~/.config/systemd/user/riffpi.service` and enable/disable it via `systemctl
+  --user`. `pip install` never does this on its own — it's a deliberate, separate opt-in step;
+  don't wire service installation into packaging/install hooks. See `docs/installation.md` for
+  the full flow and PipeWire/udev/wifi power-management setup.
+
+## Testing
+
+There is no pytest/unittest suite. Root-level files named `*_test.py` (and `test_int.py`) are
+standalone manual exercise scripts for a single piece of hardware — run directly on the Pi
+(`python3 rotary_encoder_test.py`) with real hardware attached, and verified by watching printed
+output / physical LEDs, not by assertions. They are **not** part of the `src/riffpi` package and
+aren't shipped in the wheel/sdist. When changing a driver module, prefer updating or running its
+matching `*_test.py` script over trying to add automated tests.
+
+CI (`.github/workflows/lint-and-build.yml`) runs `ruff check src/` plus `python -m build` +
+`twine check dist/*` on every push/PR — lint and packaging validation only. It cannot actually
+import or run `riffpi` (see the Blinka caveat above), so this is the practical ceiling for
+automated verification without a self-hosted Pi runner.
+
+## Docs site & release
+
+- `docs/` is an MkDocs (Material theme) site, configured by `mkdocs.yml`.
+  `.github/workflows/docs.yml` runs `mkdocs gh-deploy --force`, but only on pushes to `main` that
+  touch `docs/`, `mkdocs.yml`, or `README.md`.
+- `.github/workflows/release.yml` builds and publishes to PyPI via Trusted Publishing (OIDC) —
+  no stored token. Requires the `riffpi` PyPI project to have this repo registered as a trusted
+  publisher (a one-time manual step on pypi.org, done as a "pending publisher" before the
+  project existed — PyPI creates the project on the first successful publish).
+- Version bumps use `bumpver` (`[tool.bumpver]` in `pyproject.toml`), which commits, tags
+  (bare `MAJOR.MINOR.PATCH`, no `v` prefix), and pushes — it does **not** create a GitHub
+  Release itself. `.github/workflows/tag-release.yml` watches for those tag pushes and runs
+  `gh release create` (using the default `GITHUB_TOKEN`) to publish a GitHub Release from the
+  tag. `release.yml` is triggered off `workflow_run: tag-release` completing, **not**
+  `release: published` — a release created via `GITHUB_TOKEN` doesn't fire other event
+  triggers (GitHub's anti-recursion rule), so chaining on `release: published` silently never
+  ran. `release.yml`'s `build` job checks out `github.event.workflow_run.head_sha` to build the
+  tagged commit. Full chain: `bumpver update` → tag pushed → `tag-release.yml` creates the
+  GitHub Release → its completion triggers `release.yml` → builds and publishes to PyPI.
+
+## Code architecture
+
+### Two parallel implementations per device: package vs. root-level register-level scripts
+
+Most physical inputs have **two independent implementations**:
+
+- The production version, in `src/riffpi/` (imported by `riffpi.daemon`), built on the Adafruit
+  CircuitPython stack (`adafruit_mcp230xx`, `digitalio.Direction`/`Pull`, `busio.I2C`) —
+  `rotary_encoder.py`, `keypad.py`, `joystick.py`, `expression_pedal.py`, `mcp_button.py`,
+  `mcp_led.py`.
+- Root-level `*_int.py` scripts (e.g. `rotary_encoder_int.py`, `multieffect_int.py`,
+  `test_int.py`) that talk to the MCP23017 directly over `smbus2`/`lgpio` register writes and use
+  hardware interrupts (`GPINTEN`, `lgpio.callback` on falling edges) instead of polling. These are
+  an alternate/experimental lower-latency approach, not wired into the main daemon and not part
+  of the installed package.
+
+When asked to fix or extend a device driver, check whether the change belongs in the
+`src/riffpi/` version, the root-level `_int` register-level version, or both — they duplicate
+logic independently and are **not** kept in sync automatically.
+
+### Control flow in `riffpi/daemon.py`
+
+- `main()` does all hardware/MIDI init (previously module-level code in the pre-packaging
+  `multieffect.py`) then spawns the worker threads; module-level functions (`handle_effect_toggle`,
+  `midi_input_thread`, `buttons_thread`, `main_thread_loop`, `send_cc`, ...) reach the objects
+  `main()` creates (`midi_out`, `midi_in`, `buttons`, `leds`, `encoders`, `task_queue`,
+  `PRESET_ENCODER_INDEX`) via `global`, matching the module's original flat-script style rather
+  than passing them around explicitly — keep that pattern if you touch this file rather than
+  introducing a class/config-object refactor.
+- Global state: `effect_states` (bool per foot switch + one slot per encoder's button) and
+  `current_preset_bank` are shared across threads with no lock beyond the implicit GIL for simple
+  list/int mutation; the one place true cross-thread coordination happens is `task_queue`
+  (a `queue.Queue` drained by `main_thread_loop`, currently only used for the `"reset"` action
+  queued from `keypad.py`).
+- `i2c_lock` (a `threading.Lock`) guards ADS1115 reads shared between `Joystick` and
+  `ExpressionPedal`, since both poll the same `ads` instance from different threads.
+- Foot switch buttons and each `RotaryEncoder`'s built-in push button all route through the same
+  `handle_effect_toggle(idx)` callback, where `idx` is the position in the `buttons` list
+  (`[4 foot switches] + [4 encoder buttons]`, in that order). `PRESET_ENCODER_INDEX` is computed
+  in `main()` as the buttons-list position of the **last encoder's** button (not a hardcoded
+  literal — it was hardcoded to `3` at one point, which actually pointed at the 4th foot switch
+  instead; don't reintroduce that). That button is special-cased to cycle Guitarix preset banks
+  A-D instead of toggling an effect.
+- MIDI CC numbers are the integration contract with Guitarix: `SWITCH_CC=64` (+idx per foot
+  switch), `ENCODER_CC_NUMBERS=[20,21,22,23]`, `PRESET_BANK_CC=32`, `PRESET_CHANGE_CC=0`,
+  expression pedal `MIDI_CC_NUMBER=24`. The `midi_input_thread` listens on the same virtual port
+  for CC echoes from Guitarix and updates local LED/encoder state to stay in sync when a preset
+  change alters effect state externally. Full mapping table: `docs/usage.md`.
+- Physical pin maps for buttons/LEDs/encoders are hardcoded per-MCP as `(mcp_number, pin)` tuples
+  at the top of `daemon.py` — cross-reference against the pinout comments above
+  `encoder_configs` (which board is "1st/2nd/3rd/4th from left to right") and the tables in
+  `docs/architecture.md` before changing wiring.
+
+### Device driver modules (`src/riffpi/`)
+
+Each driver is a small class taking its shared hardware handles (`mcp`, `ads`, `i2c_lock`,
+`midi_out`) in its constructor and exposing a blocking `poll()`/`poll_thread()`/`*_thread()`
+method meant to be run in its own daemon thread; each also has an `if __name__ == "__main__"`
+block for standalone hardware testing of just that module (only usable when run from a checkout,
+not through the installed console script).
+
+- `rotary_encoder.py`: quadrature decoding via a transition lookup table (`CW_transitions`/
+  `CCW_transitions` — 4-bit keys of `(last_state<<2)|current_state`), sends relative MIDI CC deltas.
+- `keypad.py`: 4x4 matrix scan; digits accumulate into a preset number with a
+  `DIGIT_SEQUENCE_TIMEOUT` debounce window, `A`-`D` select preset banks, `*`/`#` emit virtual
+  mouse left/right clicks via `uinput`.
+- `joystick.py`: reads the ADS1115 (`AnalogIn`), median-smooths raw voltage per axis
+  (`SMOOTHING_WINDOW`), auto-calibrates center voltage at startup (`calibrate_center()`), and
+  shapes deflection into relative `uinput` mouse motion via a dead zone (`DEAD_ZONE`) + power
+  curve (`POWER_CURVE`, must stay `>1` — a curve `<1` has infinite slope at zero and produces a
+  "dead then jumpy" feel; see the comments on the class constants).
+- `expression_pedal.py`: reads the ADS1115, median-smooths readings, sends MIDI CC.
+- `mcp_button.py` / `mcp_led.py`: thin per-pin wrappers around an MCP23017 pin for debounced
+  button state (`when_pressed` callback) and LED output.

riffpi-0.2.4/LICENSE.md

@@ -0,0 +1,313 @@
+CERN Open Hardware Licence Version 2 - Weakly Reciprocal
+
+
+Preamble
+
+CERN has developed this licence to promote collaboration among
+hardware designers and to provide a legal tool which supports the
+freedom to use, study, modify, share and distribute hardware designs
+and products based on those designs. Version 2 of the CERN Open
+Hardware Licence comes in three variants: CERN-OHL-P (permissive); and
+two reciprocal licences: this licence, CERN-OHL-W (weakly reciprocal)
+and CERN-OHL-S (strongly reciprocal).
+
+The CERN-OHL-W is copyright CERN 2020. Anyone is welcome to use it, in
+unmodified form only.
+
+Use of this Licence does not imply any endorsement by CERN of any
+Licensor or their designs nor does it imply any involvement by CERN in
+their development.
+
+
+1 Definitions
+
+  1.1 'Licence' means this CERN-OHL-W.
+
+  1.2 'Compatible Licence' means
+
+       a) any earlier version of the CERN Open Hardware licence, or
+
+       b) any version of the CERN-OHL-S or the CERN-OHL-W, or
+
+       c) any licence which permits You to treat the Source to which
+          it applies as licensed under CERN-OHL-S or CERN-OHL-W
+          provided that on Conveyance of any such Source, or any
+          associated Product You treat the Source in question as being
+          licensed under CERN-OHL-S or CERN-OHL-W as appropriate.
+
+  1.3 'Source' means information such as design materials or digital
+      code which can be applied to Make or test a Product or to
+      prepare a Product for use, Conveyance or sale, regardless of its
+      medium or how it is expressed. It may include Notices.
+
+  1.4 'Covered Source' means Source that is explicitly made available
+      under this Licence.
+
+  1.5 'Product' means any device, component, work or physical object,
+      whether in finished or intermediate form, arising from the use,
+      application or processing of Covered Source.
+
+  1.6 'Make' means to create or configure something, whether by
+      manufacture, assembly, compiling, loading or applying Covered
+      Source or another Product or otherwise.
+
+  1.7 'Available Component' means any part, sub-assembly, library or
+      code which:
+
+       a) is licensed to You as Complete Source under a Compatible
+          Licence; or
+
+       b) is available, at the time a Product or the Source containing
+          it is first Conveyed, to You and any other prospective
+          licensees
+
+           i) with sufficient rights and information (including any
+              configuration and programming files and information
+              about its characteristics and interfaces) to enable it
+              either to be Made itself, or to be sourced and used to
+              Make the Product; or
+          ii) as part of the normal distribution of a tool used to
+              design or Make the Product.
+
+  1.8 'External Material' means anything (including Source) which:
+
+       a) is only combined with Covered Source in such a way that it
+          interfaces with the Covered Source using a documented
+          interface which is described in the Covered Source; and
+
+       b) is not a derivative of or contains Covered Source, or, if it
+          is, it is solely to the extent necessary to facilitate such
+          interfacing.
+
+  1.9 'Complete Source' means the set of all Source necessary to Make
+      a Product, in the preferred form for making modifications,
+      including necessary installation and interfacing information
+      both for the Product, and for any included Available Components.
+      If the format is proprietary, it must also be made available in
+      a format (if the proprietary tool can create it) which is
+      viewable with a tool available to potential licensees and
+      licensed under a licence approved by the Free Software
+      Foundation or the Open Source Initiative. Complete Source need
+      not include the Source of any Available Component, provided that
+      You include in the Complete Source sufficient information to
+      enable a recipient to Make or source and use the Available
+      Component to Make the Product.
+
+ 1.10 'Source Location' means a location where a Licensor has placed
+      Covered Source, and which that Licensor reasonably believes will
+      remain easily accessible for at least three years for anyone to
+      obtain a digital copy.
+
+ 1.11 'Notice' means copyright, acknowledgement and trademark notices,
+      Source Location references, modification notices (subsection
+      3.3(b)) and all notices that refer to this Licence and to the
+      disclaimer of warranties that are included in the Covered
+      Source.
+
+ 1.12 'Licensee' or 'You' means any person exercising rights under
+      this Licence.
+
+ 1.13 'Licensor' means a natural or legal person who creates or
+      modifies Covered Source. A person may be a Licensee and a
+      Licensor at the same time.
+
+ 1.14 'Convey' means to communicate to the public or distribute.
+
+
+2 Applicability
+
+  2.1 This Licence governs the use, copying, modification, Conveying
+      of Covered Source and Products, and the Making of Products. By
+      exercising any right granted under this Licence, You irrevocably
+      accept these terms and conditions.
+
+  2.2 This Licence is granted by the Licensor directly to You, and
+      shall apply worldwide and without limitation in time.
+
+  2.3 You shall not attempt to restrict by contract or otherwise the
+      rights granted under this Licence to other Licensees.
+
+  2.4 This Licence is not intended to restrict fair use, fair dealing,
+      or any other similar right.
+
+
+3 Copying, Modifying and Conveying Covered Source
+
+  3.1 You may copy and Convey verbatim copies of Covered Source, in
+      any medium, provided You retain all Notices.
+
+  3.2 You may modify Covered Source, other than Notices, provided that
+      You irrevocably undertake to make that modified Covered Source
+      available from a Source Location should You Convey a Product in
+      circumstances where the recipient does not otherwise receive a
+      copy of the modified Covered Source. In each case subsection 3.3
+      shall apply.
+
+      You may only delete Notices if they are no longer applicable to
+      the corresponding Covered Source as modified by You and You may
+      add additional Notices applicable to Your modifications.
+
+  3.3 You may Convey modified Covered Source (with the effect that You
+      shall also become a Licensor) provided that You:
+
+       a) retain Notices as required in subsection 3.2;
+
+       b) add a Notice to the modified Covered Source stating that You
+          have modified it, with the date and brief description of how
+          You have modified it;
+
+       c) add a Source Location Notice for the modified Covered Source
+          if You Convey in circumstances where the recipient does not
+          otherwise receive a copy of the modified Covered Source; and
+
+       d) license the modified Covered Source under the terms and
+          conditions of this Licence (or, as set out in subsection
+          8.3, a later version, if permitted by the licence of the
+          original Covered Source). Such modified Covered Source must
+          be licensed as a whole, but excluding Available Components
+          contained in it or External Material to which it is
+          interfaced, which remain licensed under their own applicable
+          licences.
+
+
+4 Making and Conveying Products
+
+  4.1 You may Make Products, and/or Convey them, provided that You
+      either provide each recipient with a copy of the Complete Source
+      or ensure that each recipient is notified of the Source Location
+      of the Complete Source. That Complete Source includes Covered
+      Source and You must accordingly satisfy Your obligations set out
+      in subsection 3.3. If specified in a Notice, the Product must
+      visibly and securely display the Source Location on it or its
+      packaging or documentation in the manner specified in that
+      Notice.
+
+  4.2 Where You Convey a Product which incorporates External Material,
+      the Complete Source for that Product which You are required to
+      provide under subsection 4.1 need not include any Source for the
+      External Material.
+
+  4.3 You may license Products under terms of Your choice, provided
+      that such terms do not restrict or attempt to restrict any
+      recipients' rights under this Licence to the Covered Source.
+
+
+5 Research and Development
+
+You may Convey Covered Source, modified Covered Source or Products to
+a legal entity carrying out development, testing or quality assurance
+work on Your behalf provided that the work is performed on terms which
+prevent the entity from both using the Source or Products for its own
+internal purposes and Conveying the Source or Products or any
+modifications to them to any person other than You. Any modifications
+made by the entity shall be deemed to be made by You pursuant to
+subsection 3.2.
+
+
+6 DISCLAIMER AND LIABILITY
+
+  6.1 DISCLAIMER OF WARRANTY -- The Covered Source and any Products
+      are provided 'as is' and any express or implied warranties,
+      including, but not limited to, implied warranties of
+      merchantability, of satisfactory quality, non-infringement of
+      third party rights, and fitness for a particular purpose or use
+      are disclaimed in respect of any Source or Product to the
+      maximum extent permitted by law. The Licensor makes no
+      representation that any Source or Product does not or will not
+      infringe any patent, copyright, trade secret or other
+      proprietary right. The entire risk as to the use, quality, and
+      performance of any Source or Product shall be with You and not
+      the Licensor. This disclaimer of warranty is an essential part
+      of this Licence and a condition for the grant of any rights
+      granted under this Licence.
+
+  6.2 EXCLUSION AND LIMITATION OF LIABILITY -- The Licensor shall, to
+      the maximum extent permitted by law, have no liability for
+      direct, indirect, special, incidental, consequential, exemplary,
+      punitive or other damages of any character including, without
+      limitation, procurement of substitute goods or services, loss of
+      use, data or profits, or business interruption, however caused
+      and on any theory of contract, warranty, tort (including
+      negligence), product liability or otherwise, arising in any way
+      in relation to the Covered Source, modified Covered Source
+      and/or the Making or Conveyance of a Product, even if advised of
+      the possibility of such damages, and You shall hold the
+      Licensor(s) free and harmless from any liability, costs,
+      damages, fees and expenses, including claims by third parties,
+      in relation to such use.
+
+
+7 Patents
+
+  7.1 Subject to the terms and conditions of this Licence, each
+      Licensor hereby grants to You a perpetual, worldwide,
+      non-exclusive, no-charge, royalty-free, irrevocable (except as
+      stated in subsections 7.2 and 8.4) patent licence to Make, have
+      Made, use, offer to sell, sell, import, and otherwise transfer
+      the Covered Source and Products, where such licence applies only
+      to those patent claims licensable by such Licensor that are
+      necessarily infringed by exercising rights under the Covered
+      Source as Conveyed by that Licensor.
+
+  7.2 If You institute patent litigation against any entity (including
+      a cross-claim or counterclaim in a lawsuit) alleging that the
+      Covered Source or a Product constitutes direct or contributory
+      patent infringement, or You seek any declaration that a patent
+      licensed to You under this Licence is invalid or unenforceable
+      then any rights granted to You under this Licence shall
+      terminate as of the date such process is initiated.
+
+
+8 General
+
+  8.1 If any provisions of this Licence are or subsequently become
+      invalid or unenforceable for any reason, the remaining
+      provisions shall remain effective.
+
+  8.2 You shall not use any of the name (including acronyms and
+      abbreviations), image, or logo by which the Licensor or CERN is
+      known, except where needed to comply with section 3, or where
+      the use is otherwise allowed by law. Any such permitted use
+      shall be factual and shall not be made so as to suggest any kind
+      of endorsement or implication of involvement by the Licensor or
+      its personnel.
+
+  8.3 CERN may publish updated versions and variants of this Licence
+      which it considers to be in the spirit of this version, but may
+      differ in detail to address new problems or concerns. New
+      versions will be published with a unique version number and a
+      variant identifier specifying the variant. If the Licensor has
+      specified that a given variant applies to the Covered Source
+      without specifying a version, You may treat that Covered Source
+      as being released under any version of the CERN-OHL with that
+      variant. If no variant is specified, the Covered Source shall be
+      treated as being released under CERN-OHL-S. The Licensor may
+      also specify that the Covered Source is subject to a specific
+      version of the CERN-OHL or any later version in which case You
+      may apply this or any later version of CERN-OHL with the same
+      variant identifier published by CERN.
+
+      You may treat Covered Source licensed under CERN-OHL-W as
+      licensed under CERN-OHL-S if and only if all Available
+      Components referenced in the Covered Source comply with the
+      corresponding definition of Available Component for CERN-OHL-S.
+
+  8.4 This Licence shall terminate with immediate effect if You fail
+      to comply with any of its terms and conditions.
+
+  8.5 However, if You cease all breaches of this Licence, then Your
+      Licence from any Licensor is reinstated unless such Licensor has
+      terminated this Licence by giving You, while You remain in
+      breach, a notice specifying the breach and requiring You to cure
+      it within 30 days, and You have failed to come into compliance
+      in all material respects by the end of the 30 day period. Should
+      You repeat the breach after receipt of a cure notice and
+      subsequent reinstatement, this Licence will terminate
+      immediately and permanently. Section 6 shall continue to apply
+      after any termination.
+
+  8.6 This Licence shall not be enforceable except by a Licensor
+      acting as such, and third party beneficiary rights are
+      specifically excluded.
+
+