Code Monkey home page Code Monkey logo

espasynce131's Introduction

ESPAsyncE131 - Asynchronous E.131 (sACN) library for Arduino ESP8266 and ESP32

Build Status

This library is to simplify the validation and handling of E1.31 sACN (DMX over Ethernet) traffic on Arduino ESP8266 and ESP32 based platforms. It supports both Unicast and Multicast configurations, exposing the full E1.31 packet to the user. If you require support for traditional Arduino devices or polling modes, please refer to the E131 library from which this project was derived from.

Requirements

Development is always done against the latest git pulls for the ESP8266 and ESP32 cores. If you are experiencing issues with your current Arduino core, consider updating it.

ESP8266 Platforms

ESP32 Platforms

API / Usage

Notes

  • All incoming E1.31 packets are put into a ring buffer once validated. You access incoming packets by checking the ring buffer and pulling packets as needed.
  • WiFi connection attempts will timeout after 10 seconds if a successful connection has not been established. WIFI_CONNECT_TIMEOUT can be changed in ESPAsyncE131.h.

Constructor

  • ESPAsyncE131(uint8_t buffers = 1): Creates a new ESPAsyncE131 instance and allocates a ring buffer with X buffer slots. You'll want at least 1 buffer for each Universe that may reach your device.

Member Functions and Exposed Data Structures

  • bool begin(e131_listen_t type, uint16_t universe = 1): This should be called from within setup() or whenever you need to re-configure your E1.31 listener. Valid types are E131_UNICAST and E131_MULTICAST. universe is optional and only used for Multicast configuration. Returns true if successful.
  • bool isEmpty(): Returns if the internal ring buffer is empty
  • void *pull(e131_packet_t *packet): Pulls oldest packet from the ring buffer and copies it to packet
  • e131_stats_t stats: E1.31 Statistics

Resources

espasynce131's People

Contributors

forkineye avatar penfold42 avatar per1234 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.