diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..89cc49c --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +.pio +.vscode/.browse.c_cpp.db* +.vscode/c_cpp_properties.json +.vscode/launch.json +.vscode/ipch diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..080e70d --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,10 @@ +{ + // See http://go.microsoft.com/fwlink/?LinkId=827846 + // for the documentation about the extensions.json format + "recommendations": [ + "platformio.platformio-ide" + ], + "unwantedRecommendations": [ + "ms-vscode.cpptools-extension-pack" + ] +} diff --git a/include/README b/include/README new file mode 100644 index 0000000..194dcd4 --- /dev/null +++ b/include/README @@ -0,0 +1,39 @@ + +This directory is intended for project header files. + +A header file is a file containing C declarations and macro definitions +to be shared between several project source files. You request the use of a +header file in your project source file (C, C++, etc) located in `src` folder +by including it, with the C preprocessing directive `#include'. + +```src/main.c + +#include "header.h" + +int main (void) +{ + ... +} +``` + +Including a header file produces the same results as copying the header file +into each source file that needs it. Such copying would be time-consuming +and error-prone. With a header file, the related declarations appear +in only one place. If they need to be changed, they can be changed in one +place, and programs that include the header file will automatically use the +new version when next recompiled. The header file eliminates the labor of +finding and changing all the copies as well as the risk that a failure to +find one copy will result in inconsistencies within a program. + +In C, the usual convention is to give header files names that end with `.h'. +It is most portable to use only letters, digits, dashes, and underscores in +header file names, and at most one dot. + +Read more about using header files in official GCC documentation: + +* Include Syntax +* Include Operation +* Once-Only Headers +* Computed Includes + +https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html diff --git a/lib/README b/lib/README new file mode 100644 index 0000000..2593a33 --- /dev/null +++ b/lib/README @@ -0,0 +1,46 @@ + +This directory is intended for project specific (private) libraries. +PlatformIO will compile them to static libraries and link into executable file. + +The source code of each library should be placed in an own separate directory +("lib/your_library_name/[here are source files]"). + +For example, see a structure of the following two libraries `Foo` and `Bar`: + +|--lib +| | +| |--Bar +| | |--docs +| | |--examples +| | |--src +| | |- Bar.c +| | |- Bar.h +| | |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html +| | +| |--Foo +| | |- Foo.c +| | |- Foo.h +| | +| |- README --> THIS FILE +| +|- platformio.ini +|--src + |- main.c + +and a contents of `src/main.c`: +``` +#include +#include + +int main (void) +{ + ... +} + +``` + +PlatformIO Library Dependency Finder will find automatically dependent +libraries scanning project source files. + +More information about PlatformIO Library Dependency Finder +- https://docs.platformio.org/page/librarymanager/ldf.html diff --git a/platformio.ini b/platformio.ini new file mode 100644 index 0000000..07919a5 --- /dev/null +++ b/platformio.ini @@ -0,0 +1,17 @@ +; PlatformIO Project Configuration File +; +; Build options: build flags, source filter +; Upload options: custom upload port, speed and extra flags +; Library options: dependencies, extra library storages +; Advanced options: extra scripting +; +; Please visit documentation for the other options and examples +; https://docs.platformio.org/page/projectconf.html + +[env:lolin_s2_mini] +platform = espressif32 +board = lolin_s2_mini +framework = arduino +lib_deps = + hideakitai/ArtNet @ ^0.8.0 + someweisguy/esp_dmx @ ^4.1.0 \ No newline at end of file diff --git a/src/ESPDMX.cpp b/src/ESPDMX.cpp new file mode 100644 index 0000000..79a05b5 --- /dev/null +++ b/src/ESPDMX.cpp @@ -0,0 +1,84 @@ +// - - - - - +// ESPDMX - A Arduino library for sending and receiving DMX using the builtin serial hardware port. +// ESPDMX.cpp: Library implementation file +// +// Copyright (C) 2015 Rick +// This work is licensed under a GNU style license. +// +// Last change: Marcel Seerig +// +// Documentation and samples are available at https://github.com/Rickgg/ESP-Dmx +// - - - - - + +/* ----- LIBRARIES ----- */ +#include +#include "ESPDMX.h" + +#define DMXSPEED 250000 +#define DMXFORMAT SERIAL_8N2 +#define BREAKSPEED 83333 +#define BREAKFORMAT SERIAL_8N1 +#define SERIALPORT Serial0 +#define DMXCHANNELS 512 + +bool dmxStarted = false; +int sendPin = 18; +int receivePin = -1; + +// DMX value array and size. Entry 0 will hold startbyte, so we need 512+1 elements +uint8_t dmxDataStore[DMXCHANNELS+1] = {}; + + +// Set up the DMX-Protocol +void DMXESPSerial::init() { + SERIALPORT.begin(DMXSPEED, DMXFORMAT, receivePin, sendPin); + pinMode(sendPin, OUTPUT); + dmxStarted = true; +} + +// Function to read DMX data +uint8_t DMXESPSerial::read(int Channel) { + if (dmxStarted == false) init(); + + if (Channel < 1) Channel = 1; + if (Channel > DMXCHANNELS) Channel = DMXCHANNELS; + return(dmxDataStore[Channel]); +} + +// Function to send DMX data +void DMXESPSerial::write(int Channel, uint8_t value) { + if (dmxStarted == false) init(); + + if (Channel < 1) Channel = 1; + if (Channel > DMXCHANNELS) Channel = DMXCHANNELS; + if (value < 0) value = 0; + if (value > 255) value = 255; + + dmxDataStore[Channel] = value; +} + +void DMXESPSerial::end() { + SERIALPORT.end(); + dmxStarted = false; +} + +// Function to update the DMX bus +void DMXESPSerial::update() { + if (dmxStarted == false) init(); + + //Send break + digitalWrite(sendPin, HIGH); + SERIALPORT.begin(BREAKSPEED, BREAKFORMAT, receivePin, sendPin); + SERIALPORT.write(0); + SERIALPORT.flush(); + delay(1); + SERIALPORT.end(); + + //send data + SERIALPORT.begin(DMXSPEED, DMXFORMAT, receivePin, sendPin); + digitalWrite(sendPin, LOW); + SERIALPORT.write(dmxDataStore, DMXCHANNELS); + SERIALPORT.flush(); + delay(1); + SERIALPORT.end(); +} \ No newline at end of file diff --git a/src/ESPDMX.h b/src/ESPDMX.h new file mode 100644 index 0000000..1a8cb90 --- /dev/null +++ b/src/ESPDMX.h @@ -0,0 +1,30 @@ +// - - - - - +// ESPDMX - A Arduino library for sending and receiving DMX using the builtin serial hardware port. +// ESPDMX.cpp: Library implementation file +// +// Copyright (C) 2015 Rick +// This work is licensed under a GNU style license. +// +// Last change: Marcel Seerig +// +// Documentation and samples are available at https://github.com/Rickgg/ESP-Dmx +// - - - - - + +#include + + +#ifndef ESPDMX_h +#define ESPDMX_h + +// ---- Methods ---- + +class DMXESPSerial { +public: + void init(); + uint8_t read(int Channel); + void write(int channel, uint8_t value); + void update(); + void end(); +}; + +#endif diff --git a/src/main.cpp b/src/main.cpp new file mode 100644 index 0000000..74d591f --- /dev/null +++ b/src/main.cpp @@ -0,0 +1,104 @@ +// Art-Net DMX Interface Demo +// 2024-10-17 Patrick Schwarz + +#include +//#include + +#include "ESPDMX.h" + +// WiFi stuff +const char* ssid = "artnet"; +const char* pwd = "mbgmbgmbg"; +const IPAddress ip(192, 168, 1, 201); +const IPAddress gateway(192, 168, 1, 1); +const IPAddress subnet(255, 255, 255, 0); + +// Art-Net stuff +ArtnetWiFi artnet; +//const String target_ip = "192.168.1.200"; +uint8_t universe = 1; // 0 - 15 +const uint16_t size = 512; +uint8_t data[size]; +uint8_t value = 0; + +// DMX stuff +DMXESPSerial dmx; + + +void setup() { + + // Serial console + //Serial.begin(115200); + + // WiFi stuff + //WiFi.begin(ssid, pwd); + WiFi.softAP(ssid, pwd); + WiFi.softAPConfig(ip, gateway, subnet); + //WiFi.config(ip, gateway, subnet); + //while (WiFi.status() != WL_CONNECTED) { + // Serial.print("."); + delay(500); + //} + //Serial.print("WiFi connected, IP = "); + //Serial.println(WiFi.localIP()); + + // Initialize Art-Net + artnet.begin(); + + // Initialize DMX ports + dmx.init(); + + // if Artnet packet comes to this universe, this function is called + artnet.subscribeArtDmxUniverse(universe, [&](const uint8_t *data, uint16_t size, const ArtDmxMetadata& metadata, const ArtNetRemoteInfo& remote) { + /*Serial.print("lambda : artnet data from "); + Serial.print(remote.ip); + Serial.print(":"); + Serial.print(remote.port); + Serial.print(", universe = "); + Serial.print(universe); + Serial.print(", size = "); + Serial.print(size); + Serial.print(") :");*/ + + for (size_t i = 0; i < size; ++i) { + dmx.write((i+1), data[i]); + // Serial.print(data[i]); + // Serial.print(","); + } + //Serial.println(); + + dmx.update(); + + }); + + // if Artnet packet comes, this function is called to every universe + artnet.subscribeArtDmx([&](const uint8_t *data, uint16_t size, const ArtDmxMetadata& metadata, const ArtNetRemoteInfo& remote) { + /*Serial.print("received ArtNet data from "); + Serial.print(remote.ip); + Serial.print(":"); + Serial.print(remote.port); + Serial.print(", net = "); + Serial.print(metadata.net); + Serial.print(", subnet = "); + Serial.print(metadata.subnet); + Serial.print(", universe = "); + Serial.print(metadata.universe); + Serial.print(", sequence = "); + Serial.print(metadata.sequence); + Serial.print(", size = "); + Serial.print(size); + Serial.println(")");*/ + }); +} + +void loop() { + artnet.parse(); // check if artnet packet has come and execute callback + + /*value = (millis() / 4) % 256; + memset(data, value, size); + + artnet.setArtDmxData(data, size); + artnet.streamArtDmxTo(target_ip, universe); // automatically send set data in 40fps + // artnet.streamArtDmxTo(target_ip, net, subnet, univ); // or you can set net, subnet, and universe */ + +} \ No newline at end of file diff --git a/test/README b/test/README new file mode 100644 index 0000000..9b1e87b --- /dev/null +++ b/test/README @@ -0,0 +1,11 @@ + +This directory is intended for PlatformIO Test Runner and project tests. + +Unit Testing is a software testing method by which individual units of +source code, sets of one or more MCU program modules together with associated +control data, usage procedures, and operating procedures, are tested to +determine whether they are fit for use. Unit testing finds problems early +in the development cycle. + +More information about PlatformIO Unit Testing: +- https://docs.platformio.org/en/latest/advanced/unit-testing/index.html