Artnet.cpp

/*The MIT License (MIT)

Copyright (c) 2014 Nathanaël Lécaudé
https://github.com/natcl/Artnet, http://forum.pjrc.com/threads/24688-Artnet-to-OctoWS2811

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.
*/

#include <Artnet.h>
//#include <ESP8266WiFi.h>
//#include <ESP8266WiFi.h>
#ifdef ESP32
    #include <WiFi.h>
#else
    #include <ESP8266WiFi.h>
#endif

const char Artnet::artnetId[] = ART_NET_ID;

Artnet::Artnet() : net(0), subNet(0), numUniverses(1) {}

void Artnet::begin()
{
  Udp.begin(ART_NET_PORT);
}

void Artnet::setBroadcast(byte bc[])
{
  //sets the broadcast address
  broadcast = bc;
}

uint16_t Artnet::read()
{
  packetSize = Udp.parsePacket();
  IPAddress artnetServer = Udp.remoteIP();
  if (packetSize <= MAX_BUFFER_ARTNET && packetSize > 0)
  { 
      Udp.read(artnetPacket, MAX_BUFFER_ARTNET);

      // Check that packetID is "Art-Net" else ignore
      for (byte i = 0 ; i < 9 ; i++)
      {
        if (artnetPacket[i] != ART_NET_ID[i])
          return 0;
      }
      opcode = artnetPacket[8] | artnetPacket[9] << 8; 

      if (opcode == ART_DMX)
      {
        sequence = artnetPacket[12];
        incomingUniverse = artnetPacket[14] | artnetPacket[15] << 8;  
        dmxDataLength = artnetPacket[17] | artnetPacket[16] << 8;

        if (artDmxCallback) (*artDmxCallback)(incomingUniverse, dmxDataLength, sequence, artnetPacket + ART_DMX_START);
        return ART_DMX;
      }
      if (opcode == ART_POLL)
      {
        for(int replyNr = 0; !(numUniverses < (replyNr * 4)) ; replyNr++){

            //fill the reply struct, and then send it to the network's broadcast address

            /*Serial.print("POLL from ");
            Serial.print(artnetServer);
            Serial.print(" broadcast addr: ");
            Serial.println(broadcast);*/


            IPAddress local_ip = WiFi.localIP();
            node_ip_address[0] = local_ip[0];
            node_ip_address[1] = local_ip[1];
            node_ip_address[2] = local_ip[2];
            node_ip_address[3] = local_ip[3];

            sprintf((char *)id, "Art-Net\0");
            memcpy(ArtPollReply.id, id, sizeof(ArtPollReply.id));
            memcpy(ArtPollReply.ip, node_ip_address, sizeof(ArtPollReply.ip));

            ArtPollReply.opCode = ART_POLL_REPLY;
            ArtPollReply.port =  ART_NET_PORT;

            memset(ArtPollReply.goodinput,  0x08, 4);
            memset(ArtPollReply.goodoutput,  0x80, 4);

            for(uint8_t i = 0; i < 4; i++){
                if(i < numUniverses)
                    ArtPollReply.porttypes[i] = 0x80; //read only
                else
                    ArtPollReply.porttypes[i] = 0x00; //read only

            }

            uint8_t shortname [18];
            uint8_t longname [64];

            sprintf((char *)shortname, "artnet arduino\0");
            sprintf((char *)longname, "Art-Net -> Arduino Bridge\0");
            memcpy(ArtPollReply.shortname, shortname, sizeof(shortname));
            memcpy(ArtPollReply.longname, longname, sizeof(longname));

            ArtPollReply.etsaman[0] = 0;
            ArtPollReply.etsaman[1] = 0;
            ArtPollReply.verH       = 1;
            ArtPollReply.ver        = 0;
            ArtPollReply.subH       = net;
            ArtPollReply.sub        = subNet;
            ArtPollReply.oemH       = 0;
            ArtPollReply.oem        = 0xFF;
            ArtPollReply.ubea       = 0;
            ArtPollReply.status     = 0xd2;
            ArtPollReply.swvideo    = 0;
            ArtPollReply.swmacro    = 0;
            ArtPollReply.swremote   = 0;
            ArtPollReply.style      = 0;

            ArtPollReply.numbportsH = 0;
            ArtPollReply.numbports  = std::min(numUniverses - (replyNr * 4),4);
            ArtPollReply.status2    = 0x08;

            ArtPollReply.bindip[0] = node_ip_address[0];
            ArtPollReply.bindip[1] = node_ip_address[1];
            ArtPollReply.bindip[2] = node_ip_address[2];
            ArtPollReply.bindip[3] = node_ip_address[3];
            ArtPollReply.bindindex = replyNr;

            uint8_t swin[4]  = {0x00,0x00,0x00,0x00};//we can't send packages anyway
            for(uint8_t i = 0; i < 4; i++)
            {
                ArtPollReply.swin[i] = swin[i];
            }

            for(uint8_t i = 0; i < numUniverses - replyNr*4; i++){
                ArtPollReply.swout[i] = universe_a + i + replyNr*4;
            }


            sprintf((char *)ArtPollReply.nodereport, "%i DMX output universes active.\0", ArtPollReply.numbports);

            WiFi.macAddress(ArtPollReply.mac); //sets the mac adress

            Udp.beginPacket(broadcast, ART_NET_PORT);//send the packet to the broadcast address
            Udp.write((uint8_t *)&ArtPollReply, sizeof(ArtPollReply));
            Udp.endPacket();
            }
        return ART_POLL; 
      }
  }
  else
  {
    return 0;
  }
}

void Artnet::printPacketHeader()
{
  Serial.print("packet size = ");
  Serial.print(packetSize);
  Serial.print("\topcode = ");
  Serial.print(opcode, HEX);
  Serial.print("\tuniverse number = ");
  Serial.print(incomingUniverse);
  Serial.print("\tdata length = ");
  Serial.print(dmxDataLength);
  Serial.print("\tsequence n0. = ");
  Serial.println(sequence);
}

void Artnet::printPacketContent()
{
  for (uint16_t i = ART_DMX_START ; i < dmxDataLength ; i++){
    Serial.print(artnetPacket[i], DEC);
    Serial.print("  ");
  }
  Serial.println('\n');
}

void Artnet::setNet(uint8_t n){
    net = n;
}

void Artnet::setSubnet(uint8_t n){
    subNet = n;
}

void Artnet::setUniverseA(uint8_t u){
    universe_a = u;
}

void Artnet::setNumUniverses(uint8_t num)
{
    numUniverses = num;
}

uint16_t Artnet::send(uint16_t outgoingUniverse, uint8_t* data, uint16_t data_length, IPAddress destIp)
{
  uint16_t len;
  uint16_t version;

  memcpy(artnetPacket, artnetId, sizeof(artnetId));
  opcode = ART_DMX;
  artnetPacket[8] = opcode;
  artnetPacket[9] = opcode >> 8;
  version = 14;
  artnetPacket[11] = version;
  artnetPacket[10] = version >> 8;
  artnetPacket[12] = sequence;
  sequence++;
  if (!sequence) {
    sequence = 1;
  }
  artnetPacket[13] = 0; //physical
  artnetPacket[14] = outgoingUniverse;
  artnetPacket[15] = outgoingUniverse >> 8;
  len = data_length + (data_length % 2); // make a even number
  artnetPacket[17] = len;
  artnetPacket[16] = len >> 8;

  memcpy(artnetPacket + ART_DMX_START, data, data_length);//insert DMX data
  
  Udp.beginPacket(destIp, ART_NET_PORT);
  Udp.write(artnetPacket, ART_DMX_START + len);

  return Udp.endPacket();
}