jonasarnold/artnete131lib_esp8266

Library to use ArtNet V4 and sAcn (E131) on an ESP8266.

ArtNet V4 and sACN (E131) Library for esp8266

With this library you can receive or send ArtNet V4 or sACN (E131) on an ESP8266.

Initial version by Matthew Tong. The library was copied from there and extended. The library was extended by utilising the E131 Lib by forkineye.

USAGE

** Note: ** The following library must be installed: E131 by forkineye

Instanciate:

  espArtNetRDM myArtRdm;

Configuration:

Initialize:

myArtRdm.init(ArtNetOEMCode, EstaManufacturerCode, macAddress);
myArtRdm.init(shortName, ArtNetOEMCode, EstaManufacturerCode, macAddress);
myArtRdm.init(shortName, longName, ArtNetOEMCode, EstaManufacturerCode, macAddress);
myArtRdm.init(ipAddress, subnetMask, dhcpEnabled, ArtNetOEMCode, EstaManufacturerCode, macAddress);
myArtRdm.init(ipAddress, subnetMask, dhcpEnabled, shortName, longName, ArtNetOEMCode, EstaManufacturerCode, macAddress);

More information: ArtNet OEM, ESTA Manufacturer Code, Get MAC address of ESP8266

To add a ArtNet net and subnet:

uint8_t _group = myArtRdm.addGroup(netNum, subnetNum);  // store the return value

To add a Port (Universe):

portType can be:

• DMX_OUT = receive DMX from Network
• DMX_IN = send DMX to Network

htpMerge: true for Highest Takes Precedence, false for Latest Takes Precedence.

uint8_t _port = myArtRdm.addPort(_group, portNum, universeNum, portType, htpMerge);

To set the network protocol type:

protocolType can be:

• ARTNET = ArtNet V4
• sACN_UNICAST = sACN Unicast
• sACN_MULTICAST = sACN Multicast (not yet implemented)

myArtRdm.setProtocolType(_group, _port, protocolType);  // store the return value

At the end of the configuration process start listening to UDP packets with this command:

myArtRdm.begin();

Place this function in main loop to let the library handle the data periodically:

myArtRdm.handler();

Receiving ArtNet/sACN data:

Setup a callback function:

myArtRdm.setArtDMXCallback(dmxHandle);

and implement the callback function like this:

void dmxHandle(uint8_t group, uint8_t port, uint16_t numChans, bool syncEnabled)
{
	if(group == _group && port == _port)
	{
		// read out the value of the dmx channel (-1 because buffer of dmx data starts at 0)
		uint8_t valueOfDmxChannel = myArtRdm.getDMX(_group, _port)[channel -1];
	}
}

Send Data to ArtNet/sACN:

To send data use the following function:

  myArtRdm.sendDMX(groupNum, portNum, broadcastAddress, dataArray, 512);

General:

To set the Firmware version sent with each ArtPoll:

  myArtRdm.setFirmwareVersion(fwVersion);

To set the default ArtNet IP (generates IP by using the MAC address):

  myArtRdm.setDefaultIP();

artnete131lib_esp8266's Issues

ESPAsyncE131 ?

Has anyone used this with the later ESPAsyncE131 ?

Sending E131 example

How would the most simple sending example look like to an E131 receiver? Thanks!