ArtNet

Artnet

Art-Net ผู้ส่ง/ตัวรับสัญญาณสำหรับ Arduino (Ethernet, Wifi)

คำเตือน

Breaking API เปลี่ยนจาก v0.4.0 ขึ้นไป

คำเตือน

ลบไลบรารีขึ้นอยู่กับ V0.3.0

หากคุณติดตั้งไลบรารีนี้ก่อน v0.3.0 โปรดติดตาม:

• โคลนจาก GitHub (ด้วยตนเอง): โปรดติดตั้งห้องสมุดที่ขึ้นอยู่กับด้วยตนเอง
• ติดตั้งจาก Library Manager: ติดตั้งไลบรารีนี้อีกครั้งจาก Library Manager
  • ห้องสมุดที่ขึ้นอยู่กับจะถูกติดตั้งโดยอัตโนมัติ

คุณสมบัติ

• รองรับโปรโตคอลต่อไปนี้:
  • งานศิลปะ
  • Artnzs
  • artpoll/artpollreply
  • เครื่องตี
  • งานศิลปะ
• รองรับไลบรารี WiFi/Ethernet หลายตัว
  • wifi
  • wifinina
  • wifis3 (Arduino UNO R4 WiFi)
  • อีเธอร์เน็ต
  • Ethernetenc
  • ETH (ESP32)
• รองรับบอร์ดจำนวนมากซึ่งสามารถใช้อีเธอร์เน็ตหรือ wifi
• การโทรกลับหลายตัวรับสัญญาณขึ้นอยู่กับจักรวาล
• สตรีมมิ่งปลายทางที่กลายเป็นผู้ส่งด้วยผู้ส่ง
• ส่งบรรทัดเดียวไปยังปลายทางที่ต้องการ
• การตั้งค่า Net/Subnet/Universe ที่ยืดหยุ่น
• การส่งต่อข้อมูลง่าย ๆ ไปยัง FARDLED

แพลตฟอร์มที่รองรับ

wifi

• esp32
• esp8266
• Raspberry Pi Pico W
• Arduino uno wifi rev2
• Arduino uno r4 wifi
• Arduino Mkr Vidor 4000
• Arduino MKR WiFi 1010
• Arduino MKR WiFi 1000
• Arduino Nano 33 IoT

อีเธอร์เน็ต

• ESP32 (อีเธอร์เน็ตและ ETH)
• esp8266
• เกือบทุกแพลตฟอร์มที่ไม่มี wifi
• แพลตฟอร์มใด ๆ ที่รองรับโดย Enc28J60 (โปรดอ่านส่วนต่อไปนี้)

หมายเหตุสำหรับคอนโทรลเลอร์ ENC28J60 Ethernet (คลิกเพื่อขยาย)

เมื่อใช้คอนโทรลเลอร์ Enc28J60

• ตรวจสอบให้แน่ใจว่าได้ โคลน ไลบรารี EtherNetenc (เวอร์ชัน = <2.0.4 ไม่รองรับที่อยู่ MAC)
• เพียงแค่แทนที่ #include <Artnet.h> ด้วย #include <ArtnetEtherENC.h>

การใช้งาน

ห้องสมุดนี้มีตัวเลือกตัวควบคุม Art-Net โปรดใช้พวกเขาขึ้นอยู่กับสถานการณ์

• ArtneTreveiver
• Artnetsender
• ArtNet (ผู้ส่ง/ผู้รับรวม)

รวม ArtNet

โปรดรวม #include "Artnet.h ก่อน

หากคุณใช้บอร์ดที่มีทั้ง WiFi และ Ethernet คุณไม่สามารถใช้ #include <Artnet.h> โปรดแทนที่ด้วย #include <ArtnetWiFi.h> หรือ #include <ArtnetEther.h> ขึ้นอยู่กับอินเทอร์เฟซที่คุณต้องการใช้

 // For the boards which can use ether WiFi or Ethernet
# include < Artnet.h >
// OR use WiFi on the board which can use both WiFi and Ethernet
# include < ArtnetWiFi.h >
// OR use Ethenet on the board which can use both WiFi and Ethernet
# include < ArtnetEther.h >

ArtNetreceiver

# include < Artnet.h >
ArtnetReceiver artnet;

void callback ( const uint8_t *data, uint16_t size, const ArtDmxMetadata &metadata, const ArtNetRemoteInfo &remote) {
    // you can also use pre-defined callbacks
}

void setup () {
    // setup Ethernet/WiFi...

    artnet. begin (); // waiting for Art-Net in default port

    artnet. subscribeArtDmxUniverse (universe15bit, [&]( const uint8_t *data, uint16_t size, const ArtDmxMetadata &metadata, const ArtNetRemoteInfo &remote) {
        // if Artnet packet comes to this universe(0-15), this function is called
    });

    // you can also use pre-defined callbacks
    artnet. subscribeArtDmxUniverse (net, subnet, universe, callback);
}

void loop () {
    artnet. parse (); // check if artnet packet has come and execute callback
}

Artnetsender

# include < Artnet.h >
ArtnetSender artnet;

void setup () {
    // setup Ethernet/WiFi...

    artnet. begin ();
}

void loop () {
    // change send data as you want

    // one-line send
    artnet. sendArtDmx ( " 127.0.0.1 " , universe15bit, data_ptr, size);
    // or you can set net and subnet
    // artnet.sendArtDmx("127.0.0.1", net, subnet, universe, data_ptr, size);

    // To use streamArtDmxTo(), you need to setArtDmxData() before streamArtDmxTo()
    artnet. setArtDmxData (data_ptr, size);
    // automatically send set data in 40fps
    artnet. streamArtDmxTo ( " 127.0.0.1 " , universe15bit);
    // or you can set net and subnet here
    // artnet.streamArtDmxTo("127.0.0.1", net, subnet, universe);
}

ArtNet (ผู้ส่ง/ผู้รับรวม)

ArtNet Class มีคุณสมบัติ ArtNetReceiver และ ArtNetSender

# include < Artnet.h >
Artnet artnet;

void setup ()
{
    // setup Ethernet/WiFi...

    artnet. begin (); // send to localhost and listen to default port

    artnet. subscribeArtDmxUniverse (universe, [&]( const uint8_t *data, uint16_t size, const ArtDmxMetadata &metadata, const ArtNetRemoteInfo &remote) {
        // if Artnet packet comes to this universe, this function is called
    });
    artnet. subscribeArtDmx ([&]( const uint8_t *data, uint16_t size, const ArtDmxMetadata& metadata, const ArtNetRemoteInfo& remote) {
        // if Artnet packet comes, this function is called for every universe
    });
}

void loop () {
    artnet. parse (); // check if artnet packet has come and execute callback

    // change send data as you want

    artnet. send ( " 127.0.0.1 " , universe, data_ptr, size); // one-line send

    artnet. streaming_data (data_ptr, size);
    artnet. streaming ( " 127.0.0.1 " , universe); // stream in 40 fps
}

เครื่องรับ ArtNet + FARDLED

# include < Artnet.h >
ArtnetReceiver artnet;

// FastLED
# define NUM_LEDS 1
CRGB leds[NUM_LEDS];
const uint8_t PIN_LED_DATA = 3 ;

void setup () {
    // setup Ethernet/WiFi...

    // setup FastLED
    FastLED. addLeds <NEOPIXEL, PIN_LED>(&leds, NUM_LEDS);

    artnet. begin ();
    // if Artnet packet comes to this universe, forward them to fastled directly
    artnet. forwardArtDmxDataToFastLED (universe, leds, NUM_LEDS);

    // this can be achieved manually as follows
    // artnet.subscribeArtDmxUniverse(universe, [](const uint8_t *data, uint16_t size, const ArtDmxMetadata& metadata, const ArtNetRemoteInfo& remote)
    // {
    //     // artnet data size per packet is 512 max
    //     // so there is max 170 pixel per packet (per universe)
    //     for (size_t pixel = 0; pixel < NUM_LEDS; ++pixel)
    //     {
    //         size_t idx = pixel * 3;
    //         leds[pixel].r = data[idx + 0];
    //         leds[pixel].g = data[idx + 1];
    //         leds[pixel].b = data[idx + 2];
    //     }
    // });
}

void loop () {
    artnet. parse (); // check if artnet packet has come and execute callback
    FastLED. show ();
}

การกำหนดค่าอื่น ๆ

สมัครสมาชิกโทรกลับด้วย NET, Sub-Net และ Universe ตามที่คุณต้องการ

• ความสัมพันธ์ของ NET (0-127), Sub-Net (0-15), จักรวาล 4 บิต (0-15) และจักรวาล 15 ​​บิต (0-32767) คือ universe15bit = (net << 8) | (subnet << 4) | universe4bit
• คุณสามารถสมัครสมาชิก ArtDMX Data สำหรับ NET (0-127), Sub-Net (0-15) และจักรวาล 4 บิต (0-15) เช่น artnet.subscribeArtDmxUniverse(net, subnet, universe, callback)
• หรือคุณสามารถใช้จักรวาล 15 ​​บิต (0-32767) สามารถตั้งค่า lnke artnet.subscribeArtDmxUniverse(universe, callback)
• Universes ที่สมัครสมาชิก (เป้าหมายของการโทรกลับ) จะสะท้อนให้เห็นโดยอัตโนมัติไปยัง net_sw sub_sw sw_out ใน ArtPollreply โดยอัตโนมัติ

การกำหนดค่า artpollreply

• ห้องสมุดนี้รองรับ ArtPoll และ ArtPollReply
• ArtPoll จะแยกวิเคราะห์โดยอัตโนมัติและส่ง ArtPollReply
• คุณสามารถกำหนดค่าข้อมูลต่อไปนี้ของ setArtPollReplyConfig()
• การตั้งค่าอื่น ๆ จะถูกตั้งค่าโดยอัตโนมัติตามการโทรกลับลงทะเบียน
• โปรดอ้างอิงที่นี่สำหรับข้อมูลเพิ่มเติม

 struct ArtPollReplyMetadata
{
    uint16_t oem { 0x00FF };      // OemUnknown https://github.com/tobiasebsen/ArtNode/blob/master/src/Art-NetOemCodes.h
    uint16_t esta_man { 0x0000 }; // ESTA manufacturer code
    uint8_t status1 { 0x00 };     // Unknown / Normal
    uint8_t status2 { 0x08 };     // sACN capable
    String short_name { " Arduino ArtNet " };
    String long_name { " Ardino ArtNet Protocol by hideakitai/ArtNet " };
    String node_report { " " };
    // Four universes from Device to Controller
    // NOTE: Only low 4 bits of the universes
    // NOTE: Upper 11 bits of the universes will be
    //       shared with the subscribed universe (net, subnet)
    // e.g.) If you have subscribed universe 0x1234,
    //       you can set the device to controller universes
    //       from 0x1230 to 0x123F (sw_in will be from 0x0 to 0xF).
    //       So, I recommned subscribing only in the range of
    //       0x1230 to 0x123F if you want to set the sw_in.
    // REF: Please refer the Art-Net spec for the detail.
    //      https://art-net.org.uk/downloads/art-net.pdf
    uint8_t sw_in[ 4 ] { 0 };
};

 // set information for artpollreply individually
// https://art-net.org.uk/downloads/art-net.pdf
void setArtPollReplyConfig ( const ArtPollReplyConfig &cfg);
void setArtPollReplyConfig ( uint16_t oem, uint16_t esta_man, uint8_t status1, uint8_t status2, const String &short_name, const String &long_name, const String &node_report, uint8_t sw_in[ 4 ]);
void setArtPollReplyConfigOem ( uint16_t oem);
void setArtPollReplyConfigEstaMan ( uint16_t esta_man);
void setArtPollReplyConfigStatus1 ( uint8_t status1);
void setArtPollReplyConfigStatus2 ( uint8_t status2);
void setArtPollReplyConfigShortName ( const String &short_name);
void setArtPollReplyConfigLongName ( const String &long_name);
void setArtPollReplyConfigNodeReport ( const String &node_report);
void setArtPollReplyConfigSwIn ( size_t index, uint8_t sw_in);
void setArtPollReplyConfigSwIn ( uint8_t sw_in[ 4 ]);
void setArtPollReplyConfigSwIn ( uint8_t sw_in_0, uint8_t sw_in_1, uint8_t sw_in_2, uint8_t sw_in_3);

เครื่องตี

คุณสามารถส่ง/สมัครสมาชิก ArtTrigger โดยใช้ API Follwing โปรดอ้างอิงที่นี่สำหรับข้อมูลเพิ่มเติม

 void sendArtTrigger ( const String& ip, uint16_t oem = 0 , uint8_t key = 0 , uint8_t subkey = 0 , const uint8_t *payload = nullptr , uint16_t size = 512 );
void subscribeArtTrigger ( const ArtTriggerCallback &func);
using ArtTriggerCallback = std::function< void ( const ArtTriggerMetadata &metadata, const ArtNetRemoteInfo &remote)>;

งานศิลปะ

คุณสามารถส่ง/สมัครสมาชิก ArtSync โดยใช้ Follwing API โปรดอ้างอิงที่นี่สำหรับข้อมูลเพิ่มเติม

 void sendArtSync ( const String& ip);
void subscribeArtSync ( const ArtSyncCallback &func);
using ArtSyncCallback = std::function< void ( const ArtNetRemoteInfo &remote)>;

APIs

Artnetsender

 // streaming artdmx packet
void setArtDmxData ( const uint8_t * const data, uint16_t size);
void setArtDmxData ( uint16_t ch, uint8_t data);
void streamArtDmxTo ( const String& ip, uint16_t universe15bit);
void streamArtDmxTo ( const String& ip, uint8_t net, uint8_t subnet, uint8_t universe);
void streamArtDmxTo ( const String& ip, uint8_t net, uint8_t subnet, uint8_t universe, uint8_t physical);
// streaming artnzs packet
void setArtNzsData ( const uint8_t * const data, uint16_t size);
void setArtNzsData ( uint16_t ch, uint8_t data);
void streamArtNzsTo ( const String& ip, uint16_t universe15bit);
void streamArtNzsTo ( const String& ip, uint8_t net, uint8_t subnet, uint8_t universe);
void streamArtNzsTo ( const String& ip, uint8_t net, uint8_t subnet, uint8_t universe, uint8_t start_code);
// one-line artdmx sender
void sendArtDmx ( const String& ip, uint16_t universe15bit, const uint8_t * const data, uint16_t size);
void sendArtDmx ( const String& ip, uint8_t net, uint8_t subnet, uint8_t universe, const uint8_t * const data, uint16_t size);
void sendArtDmx ( const String& ip, uint8_t net, uint8_t subnet, uint8_t universe, uint8_t physical, const uint8_t *data, uint16_t size);
// one-line artnzs sender
void sendArtNzs ( const String& ip, uint16_t universe15bit, const uint8_t * const data, uint16_t size);
void sendArtNzs ( const String& ip, uint8_t net, uint8_t subnet, uint8_t universe, const uint8_t * const data, uint16_t size);
void sendArtNzs ( const String& ip, uint8_t net, uint8_t subnet, uint8_t universe, uint8_t start_code, const uint8_t *data, uint16_t size);
// send other packets
void sendArtTrigger ( const String& ip, uint16_t oem = 0 , uint8_t key = 0 , uint8_t subkey = 0 , const uint8_t *payload = nullptr , uint16_t size = 512 );
void sendArtSync ( const String& ip);

ArtNetreceiver

 using ArtDmxCallback = std::function< void ( const uint8_t *data, uint16_t size, const ArtDmxMetadata &metadata, const ArtNetRemoteInfo &remote)>;
using ArtSyncCallback = std::function< void ( const ArtNetRemoteInfo &remote)>;
using ArtTriggerCallback = std::function< void ( const ArtTriggerMetadata &metadata, const RemoteInfo &remote)>;

 struct ArtNetRemoteInfo
{
    IPAddress ip;
    uint16_t port;
};

struct ArtDmxMetadata
{
    uint8_t sequence;
    uint8_t physical;
    uint8_t net;
    uint8_t subnet;
    uint8_t universe;
};

OpCode parse ()
// subscribe artdmx packet for specified net, subnet, and universe
void subscribeArtDmxUniverse( uint8_t net, uint8_t subnet, uint8_t universe, const ArtDmxCallback &func);
// subscribe artdmx packet for specified universe (15 bit)
void subscribeArtDmxUniverse ( uint16_t universe, const ArtDmxCallback &func);
// subscribe artnzs packet for specified universe (15 bit)
auto subscribeArtNzsUniverse ( uint16_t universe, const ArtNzsCallback &func);
// subscribe artdmx packet for all universes
void subscribeArtDmx ( const ArtDmxCallback &func);
// subscribe other packets
void subscribeArtSync ( const ArtSyncCallback &func);
void subscribeArtTrigger ( const ArtTriggerCallback &func);
// unsubscribe callbacks
void unsubscribeArtDmxUniverse ( uint8_t net, uint8_t subnet, uint8_t universe);
void unsubscribeArtDmxUniverse ( uint16_t universe);
void unsubscribeArtDmxUniverses ();
void unsubscribeArtDmx ();
void unsubscribeArtNzsUniverse ( uint16_t universe);
void unsubscribeArtSync ();
void unsubscribeArtTrigger ();
// set artdmx data to CRGB (FastLED) directly
void forwardArtDmxDataToFastLED ( uint8_t net, uint8_t subnet, uint8_t universe, CRGB* leds, uint16_t num);
void forwardArtDmxDataToFastLED ( uint16_t universe, CRGB* leds, uint16_t num);
// set information for artpollreply individually
// https://art-net.org.uk/downloads/art-net.pdf
void setArtPollReplyConfig ( const ArtPollReplyConfig &cfg);
void setArtPollReplyConfig ( uint16_t oem, uint16_t esta_man, uint8_t status1, uint8_t status2, const String &short_name, const String &long_name, const String &node_report, uint8_t sw_in[ 4 ]);
void setArtPollReplyConfigOem ( uint16_t oem);
void setArtPollReplyConfigEstaMan ( uint16_t esta_man);
void setArtPollReplyConfigStatus1 ( uint8_t status1);
void setArtPollReplyConfigStatus2 ( uint8_t status2);
void setArtPollReplyConfigShortName ( const String &short_name);
void setArtPollReplyConfigLongName ( const String &long_name);
void setArtPollReplyConfigNodeReport ( const String &node_report);
void setArtPollReplyConfigSwIn ( size_t index, uint8_t sw_in);
void setArtPollReplyConfigSwIn ( uint8_t sw_in[ 4 ]);
void setArtPollReplyConfigSwIn ( uint8_t sw_in_0, uint8_t sw_in_1, uint8_t sw_in_2, uint8_t sw_in_3);
// Set where debug output should go (e.g. setLogger(&Serial); default is nowhere)
void setLogger (Print*);

บันทึก

บอร์ดบางตัวที่ไม่มีหน่วยความจำเพียงพอ (เช่น Uno, Nano ฯลฯ ) อาจไม่สามารถใช้ผู้ส่ง/ตัวรับสัญญาณรวมเนื่องจากขาดหน่วยความจำเพียงพอ โปรดพิจารณาใช้บอร์ดที่มีประสิทธิภาพมากขึ้นหรือใช้เฉพาะผู้ส่งหรือผู้รับ

อ้างอิง

• ข้อมูลจำเพาะ (Art-Net 4)
• สรุปแพ็คเก็ต
• คำจำกัดความของแพ็คเก็ต

ห้องสมุดขึ้นอยู่กับ

• arxContainer
• arxtypetraits

ห้องสมุดฝัง

• TeensydirtystlerRorSolution v0.1.0

ใบอนุญาต

มิกซ์