DMXControl 3 uses gRPC for its internal network communication since version 3.3.0. The protocol specification is done with Protobuf files. This repository makes the required Protobuf files to communicate with DMXControl 3 publicly available. It can be used to write your own applications which can connect to the DMXControl 3 Network.
Starting with DMXControl 3.3.0, there is a commit for every final release version of DMXControl. Each commit is tagged with the respective version tag and represents the latest version of the DMXControl 3 network interface at that time.
Client libraries generated from the Protobuf files are built and published automatically by GitHub Actions whenever a version tag (v*) is pushed. The package version is taken from the tag (e.g. v3.3.2 → 3.3.2).
The first three parts of the version always match the DMXControl version. Releases that only update dependencies (e.g. for security fixes) add a fourth part, which is mapped per registry:
| Tag | NuGet | PyPI | npm |
|---|---|---|---|
v3.3.3 |
3.3.3 |
3.3.3 |
3.3.3 |
v3.3.3.1 |
3.3.3.1 |
3.3.3.post1 |
not published (semver has no fourth part; the npm dependency ranges already pick up fixed versions) |
v3.3.3-rc.0 |
3.3.3-rc.0 |
3.3.3rc0 |
3.3.3-rc.0 (dist-tag next) |
The mapping is done by .github/scripts/release-version.sh.
| Language | Package | Source |
|---|---|---|
| TypeScript / JavaScript | @dmxcontrolprojects/dmxcontrol3-network-interface (npm) |
npm/ |
| C# / .NET | DMXControl3-Network-Interface (NuGet, namespace LumosProtobuf) |
csharp/ |
| Python | dmxcontrol3-network-interface (PyPI, import dmxc_protobuf) |
python/dmxc_protobuf/ |
Besides the generated code, the npm and Python packages contain ports of the helpers in csharp/ (UmbraConnectionClient, UmbraDiscoveryClient, NetConstants, the TranslateableData builder and the message extensions). See the package READMEs for details.
To build locally (npm and Python require protoc; the NuGet build brings its own via Grpc.Tools):
- NuGet:
cd csharp && dotnet pack -c Release - npm:
cd npm && npm ci && npm run build && npm test - Python:
cd python/dmxc_protobuf && poetry install && poetry run ./build.sh && poetry run python -m unittest discover -s tests -t . && poetry build
This repository and the packages built from it are licensed under the MIT License.
We will not directly accept PRs here because this repository is a read-only copy of the internal Protobuf specification repository. However, if approved, we will copy the changes to the internal repository, and they will then appear in the commit for one of the following DMXControl 3 releases.