ArtNet
v0.8.1
Arduino 용 Art-Net 발신자/수신기 (Ethernet, Wi-Fi)
경고
API를 깨는 것은 V0.4.0 이상에서 변경됩니다
경고
종속 라이브러리는 V0.3.0에서 제거되었습니다
V0.3.0 전에 이미이 라이브러리를 설치 한 경우 다음을 따르십시오.
ENC28J60 컨트롤러를 사용할 때
#include <Artnet.h>
#include <ArtnetEtherENC.h>
로 바꾸십시오 이 라이브러리에는 ART-NET 컨트롤러 옵션이 있습니다. 상황에 따라 사용하십시오.
#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 >
# 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
}
# 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
클래스에는 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
}
# 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 ();
}
universe15bit = (net << 8) | (subnet << 4) | universe4bit
artnet.subscribeArtDmxUniverse(net, subnet, universe, callback)
와 같은 Net (0-127), 서브 네트 (0-15) 및 4 비트 유니버스 (0-15)에 대한 ArtDMX 데이터를 구독 할 수 있습니다.artnet.subscribeArtDmxUniverse(universe, callback)
설정할 수 있습니다.ArtPollreply
에서 net_sw
sub_sw
sw_out
에 자동으로 반영됩니다.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);
Follwing API를 사용하여 ArtTrigger
보내거나 구독 할 수 있습니다. 자세한 내용은 여기를 참조하십시오.
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)>;
Follwing API를 사용하여 ArtSync
보내거나 구독 할 수 있습니다. 자세한 내용은 여기를 참조하십시오.
void sendArtSync ( const String& ip);
void subscribeArtSync ( const ArtSyncCallback &func);
using ArtSyncCallback = std::function< void ( const ArtNetRemoteInfo &remote)>;
// 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);
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 등)는 충분한 메모리가 없기 때문에 통합 발신자/수신기를 사용할 수 없습니다. 보다 강력한 보드를 사용하거나 발신자 또는 수신자 만 사용하도록 고려하십시오.
MIT