feat: support send/receive art-sync

hideakitai · Jan 31, 2024 · 1a7d6a8 · 1a7d6a8
1 parent 41ee725
commit 1a7d6a8
Show file tree

Hide file tree

Showing 5 changed files with 75 additions and 0 deletions.
diff --git a/Artnet/ArtSync.h b/Artnet/ArtSync.h
@@ -0,0 +1,36 @@
+#pragma once
+#ifndef ARTNET_ART_SYNC_H
+#define ARTNET_ART_SYNC_H
+
+#include "Common.h"
+#include <stdint.h>
+#include <stddef.h>
+
+namespace art_net {
+namespace art_sync {
+
+enum Index : uint16_t {
+    ID = 0,
+    OP_CODE_L = 8,
+    OP_CODE_H = 9,
+    PROTOCOL_VER_H = 10,
+    PROTOCOL_VER_L = 11,
+    AUX1 = 12,
+    AUX2 = 13,
+};
+
+inline void set_header(uint8_t *packet)
+{
+    for (size_t i = 0; i < ID_LENGTH; i++) packet[i] = static_cast<uint8_t>(ARTNET_ID[i]);
+    packet[OP_CODE_L] = (static_cast<uint16_t>(OpCode::Sync) >> 0) & 0x00FF;
+    packet[OP_CODE_H] = (static_cast<uint16_t>(OpCode::Sync) >> 8) & 0x00FF;
+    packet[PROTOCOL_VER_H] = (PROTOCOL_VER >> 8) & 0x00FF;
+    packet[PROTOCOL_VER_L] = (PROTOCOL_VER >> 0) & 0x00FF;
+    packet[AUX1] = 0;
+    packet[AUX2] = 0;
+}
+
+} // namespace art_sync
+} // namespace art_net
+
+#endif // ARTNET_ART_SYNC_H
diff --git a/Artnet/Common.h b/Artnet/Common.h
@@ -64,6 +64,7 @@ constexpr uint16_t PACKET_SIZE {530};
 
 using CallbackAllType = std::function<void(const uint32_t universe, const uint8_t* data, const uint16_t size)>;
 using CallbackType = std::function<void(const uint8_t* data, const uint16_t size)>;
+using CallbackArtSync = std::function<void(void)>;
 
 #if ARX_HAVE_LIBSTDCPLUSPLUS >= 201103L  // Have libstdc++11
 template <uint16_t SIZE>

diff --git a/Artnet/Receiver.h b/Artnet/Receiver.h
@@ -17,6 +17,7 @@ class Receiver_ {
     uint8_t sub_switch;  // subnet of universe
     CallbackMap callbacks;
     CallbackAllType callback_all;
+    CallbackArtSync callback_artsync;
     S* stream;
     bool b_verbose {false};
     artpollreply::ArtPollReply artpollreply_ctx;
@@ -71,6 +72,11 @@ class Receiver_ {
                     op_code = OpCode::Poll;
                     break;
                 }
+                case OpCode::Sync: {
+                    if (callback_artsync) callback_artsync();
+                    op_code = OpCode::Sync;
+                    break;
+                }
                 default: {
                     if (b_verbose) {
                         Serial.print(F("Unsupported OpCode: "));
@@ -178,6 +184,14 @@ class Receiver_ {
     inline auto subscribe(F* func) -> std::enable_if_t<arx::is_callable<F>::value> {
         callback_all = arx::function_traits<F>::cast(func);
     }
+    template <typename F>
+    inline auto subscribeArtsync(F&& func) -> std::enable_if_t<arx::is_callable<F>::value> {
+        callback_artsync = arx::function_traits<F>::cast(func);
+    }
+    template <typename F>
+    inline auto subscribeArtsync(F* func) -> std::enable_if_t<arx::is_callable<F>::value> {
+        callback_artsync = arx::function_traits<F>::cast(func);
+    }
 
     inline void unsubscribe(const uint8_t universe) {
         auto it = callbacks.find(universe);
@@ -186,6 +200,9 @@ class Receiver_ {
     inline void unsubscribe() {
         callback_all = nullptr;
     }
+    inline void unsubscribeArtSync() {
+        callback_artsync = nullptr;
+    }
 
     inline void clear_subscribers() {
         unsubscribe();

diff --git a/Artnet/Sender.h b/Artnet/Sender.h
@@ -5,6 +5,7 @@
 #include "Common.h"
 #include "ArtDmx.h"
 #include "ArtTrigger.h"
+#include "ArtSync.h"
 
 namespace art_net {
 
@@ -100,6 +101,12 @@ class Sender_ {
         send_raw(ip, DEFAULT_PORT, packet.data(), packet.size());
     }
 
+    // ArtSync
+    void sync(const String& ip) {
+        art_sync::set_header(packet.data());
+        send_raw(ip, DEFAULT_PORT, packet.data(), packet.size());
+    }
+
 protected:
     void attach(S& s) {
         stream = &s;

diff --git a/README.md b/README.md
@@ -21,6 +21,11 @@ If you have already installed this library, please follow:
 - One-line send to desired destination
 - Flexible net/subnet/universe setting
 - Easy data forwarding to [FastLED](https://github.com/FastLED/FastLED)
+- Supports following protocols:
+  - ArtDmx
+  - ArtPoll/ArtPollReply
+  - ArtTrigger
+  - ArtSync
 
 ## Supported Platforms
 
@@ -284,6 +289,8 @@ void set_subkey(uint8_t subkey);
 void set_payload(const uint8_t* const payload, uint16_t size);
 // send ArtTrigger based on the config above
 void trigger(const String& ip);
+// send ArtSync
+void sync(const String& ip);
 ```
 
 ### ArtnetReceiver
@@ -295,12 +302,19 @@ template <typename F> inline auto subscribe(const uint8_t universe, F&& func);
 template <typename F> inline auto subscribe(const uint8_t universe, F* func);
 template <typename F> inline auto subscribe(F&& func);
 template <typename F> inline auto subscribe(F* func);
+template <typename F> inline auto subscribeArtsync(F&& func);
+template <typename F> inline auto subscribeArtsync(F* func);
+// callback definitions for subscribers
+using CallbackAllType = std::function<void(const uint32_t universe, const uint8_t* data, const uint16_t size)>;
+using CallbackType = std::function<void(const uint8_t* data, const uint16_t size)>;
+using CallbackArtSync = std::function<void(void)>;
 // for FastLED
 inline void forward(const uint8_t universe, CRGB* leds, const uint16_t num);
 // unsubscribe
 inline void unsubscribe(const uint8_t universe);
 inline void unsubscribe();
 inline void clear_subscribers();
+inline void unsubscribeArtSync();
 // ArtPollReply information
 void shortname(const String& sn);
 void longname(const String& ln);