byte-triggers


Namebyte-triggers JSON
Version 0.4.1 PyPI version JSON
download
home_pageNone
SummaryProvides byte (0 to 255) triggers on serial/parallel ports and on LSL streams.
upload_time2024-09-11 09:38:08
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseMIT License Copyright (c) 2022 Mathieu Scheltienne Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords events lsl parallel python serial triggers
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
[![codecov](https://codecov.io/gh/fcbg-platforms/byte-triggers/graph/badge.svg?token=rSGaJehUMl)](https://codecov.io/gh/fcbg-platforms/byte-triggers)
[![tests](https://github.com/fcbg-platforms/byte-triggers/actions/workflows/pytest.yml/badge.svg?branch=main)](https://github.com/fcbg-platforms/byte-triggers/actions/workflows/pytest.yml)
[![doc](https://github.com/fcbg-platforms/byte-triggers/actions/workflows/doc.yml/badge.svg?branch=main)](https://github.com/fcbg-platforms/byte-triggers/actions/workflows/doc.yml)

# Byte-triggers

Delivers integer triggers between 0 and 255 on a parallel port or on an LSL marker
stream.

## Install

`byte_triggers` is available on [PyPI](https://pypi.org/project/byte_triggers/).

```
pip install byte_triggers
```

## Usage

For the API reference, see the online
[documentation](https://fcbg-platforms.github.io/byte-triggers).

```
from byte_triggers import LSLTrigger, MockTrigger, ParallelPortTrigger

trigger = MockTrigger()
trigger.signal(1)

trigger = LSLTrigger("MyTrigger")
trigger.signal(1)

# on-board parallel port on linux
trigger = ParallelPortTrigger("/dev/parport0")
trigger.signal(1)

# on-board parallel port on windows
trigger = ParallelPortTrigger(0x4FB8)
trigger.signal(1)

# arduino to parallel port converter
trigger = ParallelPortTrigger("arduino")
trigger.signal(1)
```

# Copyright and license

The code is released under the [MIT License](https://opensource.org/licenses/MIT).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "byte-triggers",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "Mathieu Scheltienne <mathieu.scheltienne@fcbg.ch>",
    "keywords": "events, lsl, parallel, python, serial, triggers",
    "author": null,
    "author_email": "Mathieu Scheltienne <mathieu.scheltienne@fcbg.ch>",
    "download_url": "https://files.pythonhosted.org/packages/d2/a6/a0588cc1e8eaff6fdf51e90fec7d833edb8c18438e3aa03b453befdb7665/byte_triggers-0.4.1.tar.gz",
    "platform": null,
    "description": "[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)\n[![codecov](https://codecov.io/gh/fcbg-platforms/byte-triggers/graph/badge.svg?token=rSGaJehUMl)](https://codecov.io/gh/fcbg-platforms/byte-triggers)\n[![tests](https://github.com/fcbg-platforms/byte-triggers/actions/workflows/pytest.yml/badge.svg?branch=main)](https://github.com/fcbg-platforms/byte-triggers/actions/workflows/pytest.yml)\n[![doc](https://github.com/fcbg-platforms/byte-triggers/actions/workflows/doc.yml/badge.svg?branch=main)](https://github.com/fcbg-platforms/byte-triggers/actions/workflows/doc.yml)\n\n# Byte-triggers\n\nDelivers integer triggers between 0 and 255 on a parallel port or on an LSL marker\nstream.\n\n## Install\n\n`byte_triggers` is available on [PyPI](https://pypi.org/project/byte_triggers/).\n\n```\npip install byte_triggers\n```\n\n## Usage\n\nFor the API reference, see the online\n[documentation](https://fcbg-platforms.github.io/byte-triggers).\n\n```\nfrom byte_triggers import LSLTrigger, MockTrigger, ParallelPortTrigger\n\ntrigger = MockTrigger()\ntrigger.signal(1)\n\ntrigger = LSLTrigger(\"MyTrigger\")\ntrigger.signal(1)\n\n# on-board parallel port on linux\ntrigger = ParallelPortTrigger(\"/dev/parport0\")\ntrigger.signal(1)\n\n# on-board parallel port on windows\ntrigger = ParallelPortTrigger(0x4FB8)\ntrigger.signal(1)\n\n# arduino to parallel port converter\ntrigger = ParallelPortTrigger(\"arduino\")\ntrigger.signal(1)\n```\n\n# Copyright and license\n\nThe code is released under the [MIT License](https://opensource.org/licenses/MIT).\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2022 Mathieu Scheltienne  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Provides byte (0 to 255) triggers on serial/parallel ports and on LSL streams.",
    "version": "0.4.1",
    "project_urls": {
        "documentation": "https://fcbg-platforms.github.io/byte-triggers",
        "source": "https://github.com/fcbg-platforms/byte-triggers",
        "tracker": "https://github.com/fcbg-platforms/byte-triggers/issues"
    },
    "split_keywords": [
        "events",
        " lsl",
        " parallel",
        " python",
        " serial",
        " triggers"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bbbad687e846d43c45b9f83e4fe8a401fdab9b2e333c9d075936b759dc780449",
                "md5": "ea797a496c4d2980b76ed024d66e831a",
                "sha256": "1f534aa1b3a0dbb9b91dde39c8f0ae598bda6fec582a7f973155650c069ae695"
            },
            "downloads": -1,
            "filename": "byte_triggers-0.4.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ea797a496c4d2980b76ed024d66e831a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 27199,
            "upload_time": "2024-09-11T09:38:07",
            "upload_time_iso_8601": "2024-09-11T09:38:07.252896Z",
            "url": "https://files.pythonhosted.org/packages/bb/ba/d687e846d43c45b9f83e4fe8a401fdab9b2e333c9d075936b759dc780449/byte_triggers-0.4.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d2a6a0588cc1e8eaff6fdf51e90fec7d833edb8c18438e3aa03b453befdb7665",
                "md5": "171dc9c65b04a43893cdfda1d11a6587",
                "sha256": "6754a68f41a336cc1ef33f294511767711e4a686a85dae5de7f0accb3da8749f"
            },
            "downloads": -1,
            "filename": "byte_triggers-0.4.1.tar.gz",
            "has_sig": false,
            "md5_digest": "171dc9c65b04a43893cdfda1d11a6587",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 22133,
            "upload_time": "2024-09-11T09:38:08",
            "upload_time_iso_8601": "2024-09-11T09:38:08.660456Z",
            "url": "https://files.pythonhosted.org/packages/d2/a6/a0588cc1e8eaff6fdf51e90fec7d833edb8c18438e3aa03b453befdb7665/byte_triggers-0.4.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-11 09:38:08",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "fcbg-platforms",
    "github_project": "byte-triggers",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "byte-triggers"
}
        
Elapsed time: 0.33354s