{"id":21689214,"url":"https://github.com/spotlightkid/ewi-usb-config-cli","last_synced_at":"2025-04-12T09:25:31.603Z","repository":{"id":231708596,"uuid":"782504763","full_name":"SpotlightKid/ewi-usb-config-cli","owner":"SpotlightKid","description":"Configure an Akai EWI USB MIDI wind controller via MIDI from the command line","archived":false,"fork":false,"pushed_at":"2024-04-06T13:46:47.000Z","size":29,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-26T04:23:16.829Z","etag":null,"topics":["akai","command-line-tool","ewi","ewi-usb","midi","sysex","wind-controller"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SpotlightKid.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-05T12:29:53.000Z","updated_at":"2025-03-18T21:39:16.000Z","dependencies_parsed_at":"2024-11-25T17:34:31.634Z","dependency_job_id":null,"html_url":"https://github.com/SpotlightKid/ewi-usb-config-cli","commit_stats":null,"previous_names":["spotlightkid/ewi-usb-config-cli"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpotlightKid%2Fewi-usb-config-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpotlightKid%2Fewi-usb-config-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpotlightKid%2Fewi-usb-config-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpotlightKid%2Fewi-usb-config-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SpotlightKid","download_url":"https://codeload.github.com/SpotlightKid/ewi-usb-config-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248545188,"owners_count":21122096,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["akai","command-line-tool","ewi","ewi-usb","midi","sysex","wind-controller"],"created_at":"2024-11-25T17:21:57.487Z","updated_at":"2025-04-12T09:25:31.572Z","avatar_url":"https://github.com/SpotlightKid.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ewi-usb-config-cli\n\nConfigure an Akai EWI USB MIDI wind controller via MIDI from the command line\non Linux, macOS or Windows.\n\n\n### Installation\n\nVia [pip](https://github.com/pypa/pip):\n\n```con\npip install ewi-usb-config-cli\n```\n\nVia [pipx](https://github.com/pypa/pipx):\n\n```con\npipx install ewi-usb-config-cli\n```\n\n\n## Usage\n\n```\nusage: ewi-usb-config [-h] [-d DEVICE_ID] [-a] [-f] [-r PATH] [--all-banks]\n                      [-s PATH] [-p PORT] [-t TIMEOUT] [-v] [--version]\n                      [setting ...]\n\nConfigure an Akai EWI USB MIDI wind controller via MIDI.\n\npositional arguments:\n  setting               Setting to send to EWI in the form name=value (can be\n                        given more than once)\n\noptions:\n  -h, --help            show this help message and exit\n  -d DEVICE_ID, --device-id DEVICE_ID\n                        SysEx Device ID (default: 0x7F)\n  -a, --ascii           Set SysEx dump output format to ASCII hexadecimal\n                        values\n  -f, --force           Allow overwriting existing file when writing received\n                        SysEx dump\n  -r PATH, --receive PATH\n                        Receive SysEx dump from EWI and save in file PATH (use\n                        '-' to write to standard output)\n  --all-banks           Request all settings banks (0-3) (the purpose of banks\n                        1 and 3 is unclear)\n  -s PATH, --send PATH  Send SysEx dump file PATH to EWI (use '-' to read from\n                        standard input)\n  -p PORT, --port PORT  Number or (part of) name of MIDI input/output port to\n                        open (default: 'EWI-USB')\n  -t TIMEOUT, --timeout TIMEOUT\n                        SysEx dump reception timeout (default: 5)\n  -v, --verbose         Output verbose messages of program operation to stderr\n  --version             show program's version number and exit\n\nSettings:\n   breath-gain, bite-gain, bite-ac-gain, pb-gain, key-delay, unknown-1,\n   midi-channel, fingering, transposition, velocity, breath-cc-1, breath-cc-2,\n   unknown-2, bite-cc-1, bite-cc-2, pb-up-cc, pb-down-cc\n```\n\n\n## Examples\n\nConnect your Akai EWI USB wind controller via USB and use your system's MIDI\ntools to check that it shows up as MIDI input and output ports having names\nwith \"EWI-USB\" in them.\n\nThen use the terminal to send commands to your EWI using the `ewi-usb-config`\nprogram.\n\nFor example, to set the key delay to 10 (the factory default value is 7):\n\n```con\newi-usb-config key-delay=10\n```\n\nConfigure the MIDI control change type, which is sent when biting on the rubber\nmouth piece to only send *Modulation* (CC #1) and disable sending *Pitch Bend*\nas well. Also set the bite gain to value 20 (the factory default value is 64):\n\n```con\newi-usb-config bite-cc-1=0 bite-cc-2=1 bite-gain=20\n```\n\nConfigure the MIDI messages types, which are sent in response to breath input,\nto *Breath Controller* (CC #2) and *Channel Aftertouch*, which is the factory\ndefault behaviour:\n\n```con\newi-usb-config breath-cc-1=2 breath-cc-2=127\n```\n\nRetrieve all current settings from the device as a MIDI System Exclusive (SysEx)\ndump and write it to the file `ewi-usb.syx` using the `-r|--receive` option:\n\n```con\newi-usb-config -r ewi-usb.syx\n```\n\nSend a SysEx dump to the device to restore all settings saved in the dump using\nthe `-s|--send` option:\n\n```con\newi-usb-config -s ewi-usb.syx\n```\n\nRetrieve a settings dump but output the SysEx data as hexadecimal numbers in\nASCII to the standard output by adding the `-a|--ascii` option and using `-` as\nthe output filename to indicate standard output:\n\n```con\newi-usb-config -ar -\n```\n\nThis produces output like this:\n\n```\nF0 47 7F 6D 00 00 06 40 40 40 40 07 7F F7\nF0 47 7F 6D 02 00 0B 00 00 40 78 02 7F 00 7F 00 7F 7F F7\n```\n\nNote that this format can not be loaded back into the EWI USB. It is meant\nmainly as a debugging tool for developers.\n\n\n## Settings Values\n\nAll settings take values from 0 to 127, unless noted otherwise here.\n\n* For the controller settings, some values in that range have no effect.\n  See the table in the next section below for details.\n* The `fingering` setting supports the following values:\n\n    | Value | Fingering System                    |\n    | -     | ----------------------------------- |\n    | 0     | Standard EWI fingering              |\n    | 1     | Saxophone                           |\n    | 2     | Flute                               |\n    | 3     | Oboe                                |\n    | 4     | EVI Valve 1                         |\n    | 5     | EVI Valve 2 (reversed pitch plates) |\n* The `midi-channel` settings takes a value from 0 (channel 1) to 15\n  (channel 16).\n* The `transposition` setting takes a value of 52 - 76, with 64 being no\n  transposition and 56 = -12 semitones and 76 = +12 semitones.\n* For the the `velocity` setting, a value of zero (0) means that the EWI will\n  use dynamic velocity values for note-on messages, according to the breath\n  strength, whereas values 1 - 127 will cause note-on messages to have a fixed\n  velocity of the set value.\n\n\n### Controllers\n\n| Value | Breath CC 1   | Breath CC 2   | Bite CC 1         | Bite CC 2     | Pitch Plate Up | Pitch Plate Down |\n| ----- | ------------- | ------------- | ----------------- | ------------- | -------------- | ---------------- |\n| 0     | OFF           | OFF           | OFF               | OFF           | OFF            | OFF              |\n| 1-119 | MIDI CC 1-119 | MIDI CC 1-119 | MIDI CC 1-119     | MIDI CC 1-119 | MIDI CC 1-119  | MIDI CC 1-119    |\n| 124   | -             | -             | Pitchbend UP      | -             | -              | -                |\n| 125   | -             | -             | Pitchbend DOWN    | -             | -              | -                |\n| 126   | -             | -             | Pitchbend up-down | -             | -              | -                |\n| 127   | Aftertouch    | Aftertouch    | Pitchbend down-up | Aftertouch    | Pitchbend UP   | Pitchbend DOWN   |\n\n\n*Aftertouch* is always *Channel Pressure*, aka *Mono Aftertouch*.\n*Note Pressure*, aka *Poly Aftertouch*, is not supported.\n\n\n## Development\n\nUsing the [hatch](https://hatch.pypa.io/) tool:\n\n- `hatch run ewi-usb-config --version`\n- `hatch run ewi-usb-config --help`\n- `hatch status`\n- `hatch project metadata | jq -C | less-R`\n- `hatch version`\n\n*Note:* `hatch run ewi-usb-config` can be abbreviated as `hatch run euc`.\n\n\n## Deployment\n\n```con\nhatch version \u003cnew version number\u003e\ngit add ewi_usb_config/version.py\ngit commit -m \"Bump version to \u003cnew version number\u003e\"\ngit tag -a -m \"Tagging new release \u003cnew version number\u003e\" vX.Y.Z\ngit push --tags master\n```\n\n... and let the GitHub Actions `release` workflow do the rest.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspotlightkid%2Fewi-usb-config-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspotlightkid%2Fewi-usb-config-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspotlightkid%2Fewi-usb-config-cli/lists"}