rfrx


Namerfrx JSON
Version 2.1.2 PyPI version JSON
download
home_pagehttps://github.com/nim65s/rfrx
SummaryReceive RF frames from SBUS and Pro-Tronik PTR-6A v2
upload_time2023-05-26 12:02:28
maintainer
docs_urlNone
authorGuilhem Saurel
requires_python>=3.7,<4.0
licenseBSD-2-Clause
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # rfrx

[![Test](https://github.com/nim65s/rfrx/actions/workflows/test.yml/badge.svg)](https://github.com/nim65s/rfrx/actions/workflows/test.yml)
[![Release](https://github.com/nim65s/rfrx/actions/workflows/release.yml/badge.svg)](https://github.com/nim65s/rfrx/actions/workflows/release.yml)
[![PyPI version](https://badge.fury.io/py/rfrx.svg)](https://pypi.org/project/rfrx)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/nim65s/rfrx/main.svg)](https://results.pre-commit.ci/latest/github/nim65s/rfrx/main)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json)](https://github.com/charliermarsh/ruff)

Receive RF frames from some remote controllers.

Available Decoder / Readers:
- SBUS
- Pro-Tronik PTR-6A v2

:warning: Don't forget to invert its electrical signal, eg. with a NAND gate ! :warning:

## Configuration

Could be done in python calls, or by setting the following environment variables:

### SBUS

- `RFRX_PORT`: default to `/dev/ttyS0`
- `RFRX_TIMEOUT`: default to 1
- `RFRX_N_CHANS`: default to 16, number of useful channels for your case
- `RFRX_RUNNING`: default to `ON`, to keep reading and procesing data
- `RFRX_RETRY`: default to `ON`, to close and reopen the port again when something went wrong
- `RFRX_LOG_LEVEL`: default to `WARNING`

### ProTronik

Minimum, Middle and Maximum values read on your Right and Left Horizontal and Vertical joysticks

- `RFRX_RX_MIN`: default to 192
- `RFRX_RX_MID`: default to 992
- `RFRX_RX_MAX`: default to 1796
- `RFRX_RY_MIN`: default to 302
- `RFRX_RY_MID`: default to 1100
- `RFRX_RY_MAX`: default to 1900
- `RFRX_LY_MIN`: default to 180
- `RFRX_LY_MID`: default to 980
- `RFRX_LY_MAX`: default to 1779
- `RFRX_LX_MIN`: default to 192
- `RFRX_LX_MID`: default to 992
- `RFRX_LX_MAX`: default to 1790

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/nim65s/rfrx",
    "name": "rfrx",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "Guilhem Saurel",
    "author_email": "guilhem.saurel@laas.fr",
    "download_url": "https://files.pythonhosted.org/packages/0c/8d/a751c1cc41fe7ec78f0840a49eb960ee94b67456b6b80798f5374b6f17fa/rfrx-2.1.2.tar.gz",
    "platform": null,
    "description": "# rfrx\n\n[![Test](https://github.com/nim65s/rfrx/actions/workflows/test.yml/badge.svg)](https://github.com/nim65s/rfrx/actions/workflows/test.yml)\n[![Release](https://github.com/nim65s/rfrx/actions/workflows/release.yml/badge.svg)](https://github.com/nim65s/rfrx/actions/workflows/release.yml)\n[![PyPI version](https://badge.fury.io/py/rfrx.svg)](https://pypi.org/project/rfrx)\n[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/nim65s/rfrx/main.svg)](https://results.pre-commit.ci/latest/github/nim65s/rfrx/main)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json)](https://github.com/charliermarsh/ruff)\n\nReceive RF frames from some remote controllers.\n\nAvailable Decoder / Readers:\n- SBUS\n- Pro-Tronik PTR-6A v2\n\n:warning: Don't forget to invert its electrical signal, eg. with a NAND gate ! :warning:\n\n## Configuration\n\nCould be done in python calls, or by setting the following environment variables:\n\n### SBUS\n\n- `RFRX_PORT`: default to `/dev/ttyS0`\n- `RFRX_TIMEOUT`: default to 1\n- `RFRX_N_CHANS`: default to 16, number of useful channels for your case\n- `RFRX_RUNNING`: default to `ON`, to keep reading and procesing data\n- `RFRX_RETRY`: default to `ON`, to close and reopen the port again when something went wrong\n- `RFRX_LOG_LEVEL`: default to `WARNING`\n\n### ProTronik\n\nMinimum, Middle and Maximum values read on your Right and Left Horizontal and Vertical joysticks\n\n- `RFRX_RX_MIN`: default to 192\n- `RFRX_RX_MID`: default to 992\n- `RFRX_RX_MAX`: default to 1796\n- `RFRX_RY_MIN`: default to 302\n- `RFRX_RY_MID`: default to 1100\n- `RFRX_RY_MAX`: default to 1900\n- `RFRX_LY_MIN`: default to 180\n- `RFRX_LY_MID`: default to 980\n- `RFRX_LY_MAX`: default to 1779\n- `RFRX_LX_MIN`: default to 192\n- `RFRX_LX_MID`: default to 992\n- `RFRX_LX_MAX`: default to 1790\n",
    "bugtrack_url": null,
    "license": "BSD-2-Clause",
    "summary": "Receive RF frames from SBUS and Pro-Tronik PTR-6A v2",
    "version": "2.1.2",
    "project_urls": {
        "Homepage": "https://github.com/nim65s/rfrx",
        "changelog": "https://github.com/nim65s/rfrx/blob/main/CHANGELOG.md"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "704a2b08780e47e4d86c81bfcf4e42fe4835164652c0b5d39002da93b0e5be3c",
                "md5": "edee5243554e8515493954adcf2a8fd3",
                "sha256": "b53ee268b7cbc9edc7323ac43abb749bd3af23e5a7a0c5615e48c469fd937aac"
            },
            "downloads": -1,
            "filename": "rfrx-2.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "edee5243554e8515493954adcf2a8fd3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7,<4.0",
            "size": 5815,
            "upload_time": "2023-05-26T12:02:26",
            "upload_time_iso_8601": "2023-05-26T12:02:26.197644Z",
            "url": "https://files.pythonhosted.org/packages/70/4a/2b08780e47e4d86c81bfcf4e42fe4835164652c0b5d39002da93b0e5be3c/rfrx-2.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0c8da751c1cc41fe7ec78f0840a49eb960ee94b67456b6b80798f5374b6f17fa",
                "md5": "ee4293575e40515dc1a7245b488ac889",
                "sha256": "c20864a44594090fed399926db2d028df68f51fe63e8cb05e7b93a70bcff33e1"
            },
            "downloads": -1,
            "filename": "rfrx-2.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "ee4293575e40515dc1a7245b488ac889",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7,<4.0",
            "size": 4760,
            "upload_time": "2023-05-26T12:02:28",
            "upload_time_iso_8601": "2023-05-26T12:02:28.720247Z",
            "url": "https://files.pythonhosted.org/packages/0c/8d/a751c1cc41fe7ec78f0840a49eb960ee94b67456b6b80798f5374b6f17fa/rfrx-2.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-26 12:02:28",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "nim65s",
    "github_project": "rfrx",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "rfrx"
}
        
Elapsed time: 0.57937s