Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cansik/artnet4j
Art-Net DMX over IP library for Java and Processing
https://github.com/cansik/artnet4j
artnet dmx java light network processing udp
Last synced: 5 days ago
JSON representation
Art-Net DMX over IP library for Java and Processing
- Host: GitHub
- URL: https://github.com/cansik/artnet4j
- Owner: cansik
- License: gpl-3.0
- Created: 2016-10-24T22:15:41.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-05-31T07:46:11.000Z (6 months ago)
- Last Synced: 2024-10-23T10:00:29.096Z (28 days ago)
- Topics: artnet, dmx, java, light, network, processing, udp
- Language: Java
- Homepage:
- Size: 239 KB
- Stars: 94
- Watchers: 13
- Forks: 21
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ArtNet for Java & Processing [](https://github.com/cansik/artnet4j/actions?workflow=Java+CI) [](https://travis-ci.org/cansik/artnet4j) [](https://ci.appveyor.com/project/cansik/artnet4j)
Art-Net DMX over IP library for Java and Processing. This library adds a lot of features to the existing artnet4j project. Including support to read dmx data.
## Features
* Bind server to a custom network interface
* Reuse of the socket address
* Added ability to receive `OpDmx` packages
* Send and receive via UDP broadcast.
* Support for [Art-Ext](https://github.com/mattbeghin/Art-Ext-Poll) packages.
* Support for [OpTimeCode](https://art-net.org.uk/structure/time-keeping-triggering/arttimecode/) packages (thanks to [@MrExplode](https://github.com/MrExplode))
* Port selection of the UDP services
* Supports java version `8` and `11` (oracle and openjdk)
## Installation
I recommend to install it from maven central. Otherwise it is also possible to use [github packages](packages), [jitpack.io](https://jitpack.io/#cansik/artnet4j) or just the [binary download](releases).
### Maven
```xml
ch.bildspur
artnet4j
0.6.2
```
### Gradle
```groovy
repositories {
mavenCentral()
}
dependencies {
compile 'ch.bildspur:artnet4j:0.6.2'
}
```
## Examples
The library adds a new class called `ArtNetClient`, which contains easy access to the underlaying Art-Net implementation.
### Send Dmx Data
To send dmx data you have to create a new client. It is possible to skip the buffer creation by passing `null` to the constructor.
```java
byte[] dmxData = new byte[512];
ArtNetClient artnet = new ArtNetClient();
artnet.start();
// set data
dmxData[0] = 128;
// send data to localhost on subnet 0 and universe 0
artnet.unicastDmx("127.0.0.1", 0, 0, dmxData);
artnet.stop();
```
*Based on [SendDmxData](examples/SendDmxData/SendDmxData.pde)*
It is also possible to send the data via broadcast.
```java
// to broad cast data
artnet.broadcastDmx(0, 0, dmxData);
```
### Read Dmx Data
To read data you have to create a new client and read the bytes from the buffer. Please be aware that you have to mask the bytes with `0xFF` (because they are signed).
```java
ArtNetClient artnet = new ArtNetClient();
artnet.start();
byte[] data = artnet.readDmxData(0, 0);
System.out.println("First Byte: " + data[0] & 0xFF);
artnet.start.stop();
```
*Based on [ReceiveDmxData](examples/ReceiveDmxData/ReceiveDmxData.pde)*
### Select Port
While creating the `ArtNetClient`, it is possible to select the specific ports for the **server** (incoming) and the **client** (outgoing).
```java
ArtNetClient artnet = new ArtNetClient(new ArtNetBuffer(), 8000, 8000);
```
*Based on [SendOnSpecificPort](examples/SendOnSpecificPort/SendOnSpecificPort.pde)*
### Bind Custom Network Interface
It is also possible to set a custom network interface. Here you see how to bind a custom network interface `en5` to the ArtNet server:
```java
NetworkInterface ni = NetworkInterface.getByName("en5");
InetAddress address = ni.getInetAddresses().nextElement();
artnet.start(address);
```
### Receive Packet Events
Sometimes it is necessary to receive events when a new package was received. For this prupose you can get the underlaying **ArtNetServer** and add a new listener to it.
```java
artnet = new ArtNetClient();
// add packet listener to server
artnet.getArtNetServer().addListener(
new ArtNetServerEventAdapter() {
@Override public void artNetPacketReceived(ArtNetPacket packet) {
println("new packet received!");
}
});
artnet.start();
```
## About
The library is based on then [artnet4j](https://code.google.com/archive/p/artnet4j/) project.
Art-Net by Artistic Licence allows for broadcasting DMX data via IP/UDP. This library is implementing the basic protocol for Java applications.
Currently supported core features are:
* Device/node discovery & automatic updating of node configurations
* Java typed descriptors of nodes & node properties
* Abstracted DmxUniverse allowing direct pixel/channel access without having to deal with packets
* JAXB configuration support for storing universe/node descriptions as XML
* Listener support for various events
* Sending of DMX512 data via UDP broadcast or unicast
This project is currently still in pre-alpha stage, so currently only source access via hg. Be also aware that large parts of the codebase are still undergoing major changes.
New features are developed by [Florian](https://github.com/cansik).