mutenix

Name	mutenix JSON
Version	0.7.0 JSON
	download
home_page	None
Summary	Mutenix host software for the Mutenix macropad
upload_time	2025-02-09 17:33:15
maintainer	None
docs_url	None
author	None
requires_python	>=3.12
license	None
keywords	keyboard macroboard remote teams
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage

# Mutenix Host Application

Mutenix is a host application designed to translate the button presses of the hardware device into something usefull.

It consists of basically those parts

- **HID Device Communication**: General communication with the device
- **Update**: Updating the device firmware (via USB HID)
- **Teams Websocket Communication**: Connect with teams using the [local api](#enable-local-api)
- **Virtual Keypad**: Offers a virtual keypad to play around without the hardware.

Mutenix is ideal for software teams looking to enhance their project management and collaboration capabilities.

## Tray Icon & Menu

![images/tray_icon.png]

- **Open Virtual Macroboard**: Opens a virtual Macroboard in the browser, same functionalities as the hardware one.
- **Teams connected**: Status information if teams connection has been established.
- **Device connected**: Status information if the device connection has been established.
- **Help**: Opens the help page in the browser.
- **About**: Opens the about page in the browser.
- **Debug Options**: Set some debug options persistent
- **Activate Serial Console**: Activates the serial console (Circuitpython)
- **Deactivate Serial Console**: Deactivates the serial console (Circuitpython)
- **Enable Filesystem**: Enables the filesystem. This cannot be undone using the tray icon. It has to be done by yourself on the filesystem. The file you need to alter is `debug_on.py`. Reason for this is, that the device cannot mount the drive writeable the same time the host has it mounted.
- **Quit**: Quit Mutenix

## Installation

The prefered way is to use [uv](https://docs.astral.sh/uv/getting-started/installation/). The packages tend to not work without hassle.

### Executable

Download the executable here: [Releases](https://github.com/mutenix-org/software-host/releases/latest)
Run it.

### Using uv

Get [uv](https://docs.astral.sh/uv/getting-started/installation/)

```bash
uv tool mutenix
```

```bash
uvx mutenix
```

### Command Line options

**NB**: Command line options may not work on the executable version.

- `--list-devices`: lists HID devices
- `--config <your config file>`: Use that config file
- `--update-file <firmware archive>`: perform an update with that file

## Configuration

Using the configuration file several things could be configured:

- actions of the buttons
- led states/colors
- virtual keypad binding (address and port)
- device identification to connect to
- logging

Mutenix tries to find a file called `mutenix.yaml` in the directory it is run from or `$HOME/.config/`. It it does not find one, it will create one in the current directory.

Please see [Configuration.md](docs/configuration.md).

## Teams it not working

In teams the `Third Pary API` must be enabled.

![Privacy Settings in Teams](images/privacy_settings.png)

## Contributing

### Setting up pre-commit hooks

To set up pre-commit hooks for this project, run the following commands:

```sh
pip install pre-commit
pre-commit install
pre-commit run --all-files
```

## Links

- [Hardware](https://github.com/mutenix-org/hardware-macroboard)
- [Firmware](https://github.com/mutenix-org/firmware-macroboard)

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "mutenix",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.12",
    "maintainer_email": null,
    "keywords": "keyboard, macroboard, remote, teams",
    "author": null,
    "author_email": "Matthias Bilger <matthias@bilger.info>",
    "download_url": "https://files.pythonhosted.org/packages/9e/00/3afe41953800ea24041ea8062232908d7b4b42f0b2beff7b54c1504d595f/mutenix-0.7.0.tar.gz",
    "platform": null,
    "description": "# Mutenix Host Application\n\nMutenix is a host application designed to translate the button presses of the hardware device into something usefull.\n\nIt consists of basically those parts\n\n- **HID Device Communication**: General communication with the device\n- **Update**: Updating the device firmware (via USB HID)\n- **Teams Websocket Communication**: Connect with teams using the [local api](#enable-local-api)\n- **Virtual Keypad**: Offers a virtual keypad to play around without the hardware.\n\nMutenix is ideal for software teams looking to enhance their project management and collaboration capabilities.\n\n## Tray Icon & Menu\n\n![images/tray_icon.png]\n\n- **Open Virtual Macroboard**: Opens a virtual Macroboard in the browser, same functionalities as the hardware one.\n- **Teams connected**: Status information if teams connection has been established.\n- **Device connected**: Status information if the device connection has been established.\n- **Help**: Opens the help page in the browser.\n- **About**: Opens the about page in the browser.\n- **Debug Options**: Set some debug options persistent\n  - **Activate Serial Console**: Activates the serial console (Circuitpython)\n  - **Deactivate Serial Console**: Deactivates the serial console (Circuitpython)\n  - **Enable Filesystem**: Enables the filesystem. This cannot be undone using the tray icon. It has to be done by yourself on the filesystem. The file you need to alter is `debug_on.py`. Reason for this is, that the device cannot mount the drive writeable the same time the host has it mounted.\n- **Quit**: Quit Mutenix\n\n## Installation\n\nThe prefered way is to use [uv](https://docs.astral.sh/uv/getting-started/installation/). The packages tend to not work without hassle.\n\n### Executable\n\nDownload the executable here: [Releases](https://github.com/mutenix-org/software-host/releases/latest)\nRun it.\n\n### Using uv\n\nGet [uv](https://docs.astral.sh/uv/getting-started/installation/)\n\n```bash\nuv tool mutenix\n```\n\nor\n\n```bash\nuvx mutenix\n```\n\n### Command Line options\n\n**NB**: Command line options may not work on the executable version.\n\n- `--list-devices`: lists HID devices\n- `--config <your config file>`: Use that config file\n- `--update-file <firmware archive>`: perform an update with that file\n\n## Configuration\n\nUsing the configuration file several things could be configured:\n\n- actions of the buttons\n- led states/colors\n- virtual keypad binding (address and port)\n- device identification to connect to\n- logging\n\nMutenix tries to find a file called `mutenix.yaml` in the directory it is run from or `$HOME/.config/`. It it does not find one, it will create one in the current directory.\n\nPlease see [Configuration.md](docs/configuration.md).\n\n## Teams it not working\n\nIn teams the `Third Pary API` must be enabled.\n\n![Privacy Settings in Teams](images/privacy_settings.png)\n\n## Contributing\n\n### Setting up pre-commit hooks\n\nTo set up pre-commit hooks for this project, run the following commands:\n\n```sh\npip install pre-commit\npre-commit install\npre-commit run --all-files\n```\n\n## Links\n\n- [Hardware](https://github.com/mutenix-org/hardware-macroboard)\n- [Firmware](https://github.com/mutenix-org/firmware-macroboard)\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Mutenix host software for the Mutenix macropad",
    "version": "0.7.0",
    "project_urls": {
        "Documentation": "https://mutenix.de/docs/host",
        "Homepage": "https://mutenix.de",
        "Issues": "https://github.com/mutenix-org/software-host/issues",
        "Repository": "https://github.com/mutenix-org/software-host"
    },
    "split_keywords": [
        "keyboard",
        " macroboard",
        " remote",
        " teams"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "28970fd46a684015bb4503a7ec056096a61c87c164ca0ebf39dca3e877651a8e",
                "md5": "4918f5de4cc04a5de0c0ff6fcbf04c23",
                "sha256": "9d8d10c49ee8023802277cf7066e7e65412f148e025f3c8b8dbb95c829945e2b"
            },
            "downloads": -1,
            "filename": "mutenix-0.7.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4918f5de4cc04a5de0c0ff6fcbf04c23",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.12",
            "size": 3432371,
            "upload_time": "2025-02-09T17:33:08",
            "upload_time_iso_8601": "2025-02-09T17:33:08.754823Z",
            "url": "https://files.pythonhosted.org/packages/28/97/0fd46a684015bb4503a7ec056096a61c87c164ca0ebf39dca3e877651a8e/mutenix-0.7.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "9e003afe41953800ea24041ea8062232908d7b4b42f0b2beff7b54c1504d595f",
                "md5": "232bb809122c04be9713056eea012c6a",
                "sha256": "00811839f4cab24d9f1e7141aa36fef10f445877cb3f5c110b2059c755ae4d19"
            },
            "downloads": -1,
            "filename": "mutenix-0.7.0.tar.gz",
            "has_sig": false,
            "md5_digest": "232bb809122c04be9713056eea012c6a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.12",
            "size": 3482392,
            "upload_time": "2025-02-09T17:33:15",
            "upload_time_iso_8601": "2025-02-09T17:33:15.006133Z",
            "url": "https://files.pythonhosted.org/packages/9e/00/3afe41953800ea24041ea8062232908d7b4b42f0b2beff7b54c1504d595f/mutenix-0.7.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-09 17:33:15",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mutenix-org",
    "github_project": "software-host",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "mutenix"
}

None