| Name | python-artnet JSON |
| Version |
1.1.0
JSON |
| download |
| home_page | None |
| Summary | Easy-to-use and simple python receiver for Art-Net (that also implements device polling). |
| upload_time | 2024-05-11 18:25:55 |
| maintainer | sciencegey |
| docs_url | None |
| author | sciencegey |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2023 Sam Knowles 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 |
art-net
artnet
dmx
lighting
lighting control
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# python_artnet
Easy-to-use and simple python receiver for Art-Net (that also implements device polling).
## Installaton
All you need to do is clone the repository
``` bash
$ git clone https://github.com/sciencegey/python_artnet.git
$ cd python_artnet
$ python3 samples/exampleReceiver.py
```
***OR***
Install using PIP
``` bash
$ pip install python_artnet
```
## Usage
All you need to do to start receiving data is import the module, start the listener, then check for received data whenever you want!
```python
import python_artnet as Artnet
# By default it will listen on 0.0.0.0 (all interfaces)
artNet = Artnet.Artnet()
# Fetch the latest packet we received from universe 0.
artNetPacket = artNet.readBuffer()[0]
# And extract the DMX data from that packet.
dmxPacket = artNetPacket.data
# You'll also want to check that there *is* data in the packet;
# if there isn't then it returns None
# See the example for more information
# Close the listener nicely :)
artNet.close()
```
There are also plenty of arguments you can pass when you start the listener:
- **BINDIP** - Which IP address you want to *listen* on (usually a broadcast address). This is the only one you really ever need to change. *(Defaults to "" AKA 0.0.0.0 AKA all interfaces)*
- **PORT** - Which UDP port you want to listen on. Shouldn't need to ever
change this. *(Defaults to 6454)*
<details>
<summary>The following are used for purely management purposes:</summary>
- **SYSIP** - What the IP address of your system is. Purely cosmetic and only used to identify the system to ArtNet controllers. *(Defaults to "10.10.10.1")*
- **MAC** - What the MAC address of your system is. Same as above. *(Defaults to ["AA","BB","CC","DD","EE","FF"])*
- **SWVER** - What version of Art-Net we're using. In this case, V1.4 *(Defaults to "14")*
- **SHORTNAME** and **LONGNAME** - Used to see what devices are what on a controller. *(Shortname is truncated to 17 bytes long, longname is truncated to 63)*
- **OEMCODE** - What the Art-Net OEM code your device has. Only needs to be set if you have one. *(In hex)*
- **ESTACODE** - What the ESTA Manafacturer Code your device has. Only needs to be set if you have one. *(In hex)*
- **PORTTYPE** - Used to tell the controller what type of physical ports your device has. *(Defaults to [0x80,0x00,0x00,0x00])* *See the Art-Net documentation for more information*
- **REFRESH** - What the refresh rate (in Hz) of your device. *(Defaults to 44 (the max for DMX))*
- **DEBUG** - Used to turn on debug output. *(Defaults to False)*
</details>
### The artnet packet consists of the following:
- **ver** - Which version of Art-Net the packet is using. *Latest is V1.4 (14)*
- **sequence** - Sequence number, used to check if the packets have arrived in the correct order *(counts up to 255)*
- **physical** - The physical DMX512 port this data came from
- **universe** - Which universe this packet is meant for
- **data** - The data in the packet
- **length** - How much DMX data we have *(full packet is 18+length)*
### The following functions are available to use:
- **readPacket** - Returns the last Art-Net packet that we received. *(Returns ArtnetPacket)*
- **readBuffer** - Returns the last Art-Net packet that we received for each universe. *(Returns an array of ArtnetPacket, one per universe)*
- **close** - Make sure to run this at the end of your program. Tells the socket to stop running and joins the thread back. *(Returns None)*
- **version** - Returns the library version. *(Returns String)*
Further information on how it all works can be found in the [Art-Net documentation](https://www.artisticlicence.com/WebSiteMaster/User%20Guides/art-net.pdf).\
*Art-Net™ Designed by and Copyright Artistic Licence Engineering Ltd*
## License
This project is licensed under an MIT License (see the [LICENSE](LICENSE) file).
Raw data
{
"_id": null,
"home_page": null,
"name": "python-artnet",
"maintainer": "sciencegey",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "Art-Net, ArtNet, DMX, Lighting, Lighting Control",
"author": "sciencegey",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/1d/ba/d7ceaba518abe6c73f8c2edd65882463040d6b35ad5947039089e55c0829/python_artnet-1.1.0.tar.gz",
"platform": null,
"description": "# python_artnet\nEasy-to-use and simple python receiver for Art-Net (that also implements device polling).\n\n## Installaton\nAll you need to do is clone the repository\n``` bash\n$ git clone https://github.com/sciencegey/python_artnet.git\n$ cd python_artnet\n$ python3 samples/exampleReceiver.py\n```\n***OR***\n\nInstall using PIP\n``` bash\n$ pip install python_artnet\n```\n\n## Usage\nAll you need to do to start receiving data is import the module, start the listener, then check for received data whenever you want!\n```python\nimport python_artnet as Artnet\n\n# By default it will listen on 0.0.0.0 (all interfaces)\nartNet = Artnet.Artnet()\n\n# Fetch the latest packet we received from universe 0.\nartNetPacket = artNet.readBuffer()[0]\n# And extract the DMX data from that packet.\ndmxPacket = artNetPacket.data\n# You'll also want to check that there *is* data in the packet;\n# if there isn't then it returns None\n# See the example for more information\n\n# Close the listener nicely :)\nartNet.close()\n```\n\nThere are also plenty of arguments you can pass when you start the listener:\n\n- **BINDIP** - Which IP address you want to *listen* on (usually a broadcast address). This is the only one you really ever need to change. *(Defaults to \"\" AKA 0.0.0.0 AKA all interfaces)*\n- **PORT** - Which UDP port you want to listen on. Shouldn't need to ever \nchange this. *(Defaults to 6454)*\n\n<details>\n<summary>The following are used for purely management purposes:</summary>\n\n- **SYSIP** - What the IP address of your system is. Purely cosmetic and only used to identify the system to ArtNet controllers. *(Defaults to \"10.10.10.1\")*\n- **MAC** - What the MAC address of your system is. Same as above. *(Defaults to [\"AA\",\"BB\",\"CC\",\"DD\",\"EE\",\"FF\"])*\n- **SWVER** - What version of Art-Net we're using. In this case, V1.4 *(Defaults to \"14\")*\n- **SHORTNAME** and **LONGNAME** - Used to see what devices are what on a controller. *(Shortname is truncated to 17 bytes long, longname is truncated to 63)*\n- **OEMCODE** - What the Art-Net OEM code your device has. Only needs to be set if you have one. *(In hex)*\n- **ESTACODE** - What the ESTA Manafacturer Code your device has. Only needs to be set if you have one. *(In hex)*\n- **PORTTYPE** - Used to tell the controller what type of physical ports your device has. *(Defaults to [0x80,0x00,0x00,0x00])* *See the Art-Net documentation for more information*\n- **REFRESH** - What the refresh rate (in Hz) of your device. *(Defaults to 44 (the max for DMX))*\n- **DEBUG** - Used to turn on debug output. *(Defaults to False)*\n</details>\n\n### The artnet packet consists of the following:\n- **ver** - Which version of Art-Net the packet is using. *Latest is V1.4 (14)*\n- **sequence** - Sequence number, used to check if the packets have arrived in the correct order *(counts up to 255)*\n- **physical** - The physical DMX512 port this data came from\n- **universe** - Which universe this packet is meant for\n- **data** - The data in the packet\n- **length** - How much DMX data we have *(full packet is 18+length)*\n\n\n### The following functions are available to use:\n- **readPacket** - Returns the last Art-Net packet that we received. *(Returns ArtnetPacket)*\n- **readBuffer** - Returns the last Art-Net packet that we received for each universe. *(Returns an array of ArtnetPacket, one per universe)*\n- **close** - Make sure to run this at the end of your program. Tells the socket to stop running and joins the thread back. *(Returns None)*\n- **version** - Returns the library version. *(Returns String)*\n\n\nFurther information on how it all works can be found in the [Art-Net documentation](https://www.artisticlicence.com/WebSiteMaster/User%20Guides/art-net.pdf).\\\n*Art-Net\u2122 Designed by and Copyright Artistic Licence Engineering Ltd*\n\n## License\nThis project is licensed under an MIT License (see the [LICENSE](LICENSE) file).\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Sam Knowles 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": "Easy-to-use and simple python receiver for Art-Net (that also implements device polling).",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://github.com/sciencegey/python_artnet",
"Issues": "https://github.com/sciencegey/python_artnet/issues",
"Repository": "https://github.com/sciencegey/python_artnet.git"
},
"split_keywords": [
"art-net",
" artnet",
" dmx",
" lighting",
" lighting control"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4a03bbf1348192867a4bac27f93b00505565c8d8eef2d6c504d26cd3a388a424",
"md5": "81977082bf7b5ab19d8d497f07286df9",
"sha256": "98446128464ea112a5839adf5b4145374a919eae49c4ef757038faa7ccb146d2"
},
"downloads": -1,
"filename": "python_artnet-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "81977082bf7b5ab19d8d497f07286df9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 8979,
"upload_time": "2024-05-11T18:25:53",
"upload_time_iso_8601": "2024-05-11T18:25:53.552494Z",
"url": "https://files.pythonhosted.org/packages/4a/03/bbf1348192867a4bac27f93b00505565c8d8eef2d6c504d26cd3a388a424/python_artnet-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1dbad7ceaba518abe6c73f8c2edd65882463040d6b35ad5947039089e55c0829",
"md5": "3598adc43f4ae3393638d666f917cfa8",
"sha256": "01db8debc66e55b8ba2adff091ab9bfdb317645cf0c28f2ee410a7054f772e61"
},
"downloads": -1,
"filename": "python_artnet-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "3598adc43f4ae3393638d666f917cfa8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 8559,
"upload_time": "2024-05-11T18:25:55",
"upload_time_iso_8601": "2024-05-11T18:25:55.462968Z",
"url": "https://files.pythonhosted.org/packages/1d/ba/d7ceaba518abe6c73f8c2edd65882463040d6b35ad5947039089e55c0829/python_artnet-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-11 18:25:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sciencegey",
"github_project": "python_artnet",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "python-artnet"
}
