Skip to content

Commit 2eb70e1

Browse files
committed
Update documentation, update dependencies definition
1 parent 3f58fa9 commit 2eb70e1

File tree

3 files changed

+30
-19
lines changed

3 files changed

+30
-19
lines changed

README.md

Lines changed: 27 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@
33
<img src="https://raw.githubusercontent.com/vanous/PollToMVR/refs/heads/master/images/PollToMVR_icon.png" width="128px">
44

55
[PollToMVR](https://github.com/vanous/PollToMVR) - a tool to perform network
6-
discovery via ArtNet - ArtPoll and save found devices in an
6+
discovery via ArtNet - ArtPoll and to save found devices in an
77
[MVR](https://gdtf-share.com/) (My Virtual Rig) scene file.
88

99
<img src="https://raw.githubusercontent.com/vanous/PollToMVR/refs/heads/master/images/polltomvr_00.png">
1010

11-
## Features
11+
## Overview
1212

1313
- Uses [pymvr](https://pypi.org/project/pymvr/) to write fixtures to MVR files
1414
- Provides Graphical [Terminal User Interface](https://textual.textualize.io/)
15-
- Uses ArtPoll based device network discovery to create an MVR file with list of devices discovered on the network
16-
- Uses the [GDTF Share](https://gdtf-share.com) Fixture Library
15+
- Uses ArtPoll based device network discovery, can parse DMX Address and Universe from device description if present
16+
- Uses the [GDTF Share](https://gdtf-share.com) Fixture Library for fixture definitions in MVR
1717

1818
## FAQ
1919

@@ -30,6 +30,12 @@ This is not a general tool to create MVR files.
3030
Read the [Quick Start](#quick-start), see [Screenshots](#screenshots), for
3131
further documentation, check out [Features](#features).
3232

33+
### Does it use ArtRDM?
34+
35+
No, it only uses ArtPoll and ArtPollReply. Some manufacturers put DMX
36+
Address/Universe into `long_name`. If present and parsed, these values will
37+
then be used in the MVR export.
38+
3339
## Instalation
3440

3541
Binary releases for Linux, macOS and Windows are available from the
@@ -53,36 +59,40 @@ Hub](https://gdtf.eu/).
5359
- After discovery, press the "Add devices to MVR Layer", click Add
5460
- Click `Save Devices` to store the result as an MVR file
5561

56-
This will create a barebone MVR file with device names and their IP addresses (and Universes, DMX address, if also discovered).
62+
This will create a barebone MVR file with device names and their IP addresses
63+
(and Universes, DMX address, if also discovered). For more featured MVR: set
64+
user login credential in the Config, download some GDTF files and after network
65+
discovery, link the GDTFs to the discovered fixtures. After saving, the MVR
66+
will also contain the full GDTF definitions
5767

5868
## Features
5969

6070
- ### Config
6171
- Network Discovery Timeout: how long for should be the waiting for
62-
ArtPolly from devices
72+
ArtPollReply from devices
6373
- GDTF Share credentials: fill in username/password to be able to download
64-
GDTF files from GDTF Share
74+
GDTF files from GDTF Share, create a free account there if needed
6575
- ### Main Screen
6676
- Shows a list of discovered devices
6777
- Shows the possibility to define a GDTF file for each device. This GDTF
68-
file will then be used for the created MVR file
78+
file will then be used for the created MVR file. To download the GDTF
79+
files, use the GDTF Files button on the main screen.
6980
- ### Discover
70-
- Create a list of devices found on the local network
81+
- Discover devices on the local network
7182
- Select a network interface on which the discovery will run
7283
- ### Add Discovered Devices
73-
- Either add the discovered devices to a selected MVR layer
84+
- Add the discovered devices to a selected MVR layer
7485
- Create a new named MVR Layer
7586
- ### GDTF Files
76-
- Update GDTF Share data - download the list of available GDTF files from
77-
the GDTF Share
78-
- Filter the devices by name, manufacturer name
87+
- Update GDTF Share data - download the latest list of available GDTF files
88+
from the GDTF Share
89+
- Filter the devices by name or by a manufacturer name
7990
- Filter the devices by creator: Official Manufacturer Files or User
8091
created files
81-
- Downloiad the GDTF files
92+
- Download the GDTF files
8293

8394
## Screenshots
8495

85-
8696
<img src="https://raw.githubusercontent.com/vanous/PollToMVR/refs/heads/master/images/polltomvr_00.png">
8797

8898
<img src="https://raw.githubusercontent.com/vanous/PollToMVR/refs/heads/master/images/polltomvr_01.png">
@@ -129,7 +139,7 @@ pkg install uv python3 wget
129139
```sh
130140
wget https://github.com/vanous/PollToMVR/archive/refs/heads/master.zip
131141
unzip master.zip
132-
cd uptime-kume-mvr-master
142+
cd PollToMVR-master
133143
```
134144

135145
- You will need to edit the pyproject.toml and change python to 3.11, then you
@@ -157,6 +167,7 @@ Initial pyinstaller setup
157167
uv run pyinstaller packaging.spec
158168
```
159169

170+
```bibtex
160171
@software{pymvr2025,
161172
title = {pyMVR: Python Library for My Virtual Rig},
162173
author = {{OpenStage}},

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
[project]
22
name = "PolltoMVR"
33
version = "0.1.0"
4-
description = "A tool to discover network devices via Art-Net ArtPoll and save them into [MVR](https://gdtf-share.com/) (My Virtual Rig) scene file"
4+
description = "A tool to discover network devices via Art-Net ArtPoll and to save them into [MVR](https://gdtf-share.com/) (My Virtual Rig) scene file"
55
readme = "README.md"
66
requires-python = ">=3.13"
77
dependencies = [
88
"ifaddr>=0.2.0",
99
"pymvr>=1.0.4",
1010
"requests>=2.32.5",
11-
"textual>=6.2.1",
11+
"textual>=6.5.0",
1212
"textual-fspicker>=0.6.0",
1313
]
1414

uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)