denko 0.13.0

data/lib/denko_cli/targets.txt

@@ -0,0 +1,113 @@
+
+  Valid targets:
+
+    mega (default)
+
+      Covers the Atmel/Microchip AVR 8-bit chips and associated Arduino boards.
+      This is the default target. All component features are included.
+
+      Chips:  ATmega328p, ATmega32u4, ATmega1280, ATmega2560
+              Atmega4809 (unconfirmed)
+      Boards: Arduino Uno, Nano, Mini, Ethernet, Pro (some), Pro Mini (some)
+              Leonardo, Micro, Esplora, Leonardo ETH, Lilypad USB
+              Mega 1280, Mega 2560, Mega ADK
+              Nano Every, Uno WiFi Rev2 (unconfirmed)
+
+
+    esp32
+
+      For the the ESP32 chip by Espressif, with integrated 2.4Ghz WiFi.
+      No WiFi OTA updates yet.
+      This option includes all component features EXCEPT:
+          SoftwareSerial
+
+      Chips:  ESP32, ESP32-S2, ESP32-S3
+      Boards: ESP32 DevKit, LOLIN D32 / D32 Pro, LOLIN S2 Pico / Mini,
+              LOLIN S3 Pico / Mini
+         
+
+    esp8266
+
+      For the ESP8266 chip by Espressif, with integrated 2.4Ghz WiFi.
+      WiFi over-the-air updates are enabled by default.
+      This option includes all component features EXCEPT:
+          SoftwareSerial
+
+      Chips:  ES8266, ESP8285
+      Boards: WeMos D1, Node MCU, Bare Modules
+
+      Note: Building the (default) serial sketch will only allow connections via
+            serial. Build the WiFi sketch to connect via the integrated WiFi.
+
+      Note: After the initial upload via serial, the WiFi sketch for this target
+            supports over-the-air updates from the Arduino IDE using ArduinoOTA.
+            
+            
+   rp2040
+
+     For the Raspberry Pi RP2040 microcontroller.
+     Software Serial doesn't work. WiFi available only on the W version.
+     This option includes all component features EXCEPT:
+         SoftwareSerial, LEDArray
+
+     Chips:  RP2040
+     Boards: Raspberry Pi Pico, Raspberry Pi Pico W, and many others
+     
+
+   samd
+
+     For the ATSAMD21G18, with native USB and no EEPROM.
+     Similar to the mega option, but Software Serial doesn't work.
+     This option includes all component features EXCEPT:
+         EEPROM, SoftwareSerial
+
+     Chips:  ATSAMD21G18
+     Boards: Arduino Zero, M0, M0 Pro
+
+
+    sam3x
+
+      Fpr the ATSAM3X8E, with native USB and no EEPROM.
+      Similar to the mega option, but some features don't work.
+      This option includes all component features EXCEPT:
+          EEPROM, SoftwareSerial, Tone, IR Out
+
+      Chips:  ATSAM3X8E
+      Boards: Arduino Due
+      
+      
+    core
+
+      This includes only the core component feature set of denko:
+        Set Pin Mode
+        Digital Read/Write/Listen
+        Analog Read/Write/Listen
+
+      This is mostly useful for testing, or if severely limited on memory, as it
+      is the smallest sketch possible, and should be universally compatible.
+
+
+    mega168
+
+      This targets the older ATmega168 chip used in early Arduinos.
+      With half the RAM and flash available, we need to cut the sketch down.
+      This option includes all component features EXCEPT:
+          SoftwareSerial, IR Out 
+
+      Chips:  ATmega168
+      Boards: Duemilanove, Diecimila, Pro (some), Pro Mini (some)
+              (Later versions of these may carry an ATmega328)
+
+      Note: While you can generate this sketch using any connection type,
+            only the serial version actually fits on the ATmega168.
+            There is not enough memory available for Wi-Fi or Ethernet.
+            Try the core target instead to tradeoff features for networking.
+
+      Note: Aux message is always limited to 264 bytes or less for the ATmega168.
+            Servo count is always limited to 6 (normally 12) for the ATmega168 chip.
+            These limits apply as long as an Atmega168 is selected in the
+            Arduino IDE, regardless of the options passed to this sketch generator.
+
+
+  NOTE: You can manually control which features are enabled before compiling, by editing
+  by editing DenkoDefines.h. (Un)comment #define lines there to toggle features as needed.

data/lib/denko_cli/usage.txt

@@ -0,0 +1,34 @@
+
+  Usage:
+    denko task [options]
+
+  Tasks:
+    sketch SKETCH [options]
+    help
+    targets
+
+  Global options:
+
+    --target TARGET    (default: mega. Run 'denko targets' for more info)
+    --debug            (default: off)
+
+  Available sketches and sketch for each sketch:
+
+    serial
+      --baud BAUD    (default: 115200)
+
+    ethernet
+      --mac XX:XX:XX:XX:XX:XX    (required)
+      --ip XXX.XXX.XXX.XXX       (required, no DHCP)
+      --port PORT                (default: 3466)
+
+    wifi
+      --ssid SSID            (required)
+      --password PASSWORD    (required)
+      --port PORT            (default: 3466)
+
+  Examples:
+
+    denko sketch ethernet --mac 12:34:56:78:90:12 --ip 192.168.1.2
+    denko sketch serial --baud 57600
+    denko sketch serial --baud 9600 -target core

data/lib/denko_cli.rb

@@ -0,0 +1,18 @@
+module DenkoCLI
+  require "denko_cli/parser"
+  require "denko_cli/generator"
+
+  TASKS    = ["sketch"]
+  SKETCHES = ["serial", "ethernet", "wifi"]
+
+  def self.start(options={})
+    options = DenkoCLI::Parser.run(options)
+    method = options[:task]
+    self.send method, options
+  end
+
+  def self.sketch(options)
+    result = DenkoCLI::Generator.run!(options)
+    $stdout.puts result[:sketch_folder]
+  end
+end

data/src/denko_ethernet.ino

@@ -0,0 +1,78 @@
+#include "Denko.h"
+#include <SPI.h>
+#include <Ethernet.h>
+
+// Define 'serial' as the serial interface to use.
+// Uses SerialUSB (left port), which is native USB, on Arduino Due and Zero, or Serial otherwise.
+// On many boards, eg. Arduino Due, RP2040, Serial may be native USB anyway.
+#if defined(__SAM3X8E__) || defined(__SAMD21G18A__)
+  #define serial SerialUSB
+  // Use this for Programming USB port (right) on Due and Zero.
+  // #define serial Serial
+#else
+  #define serial Serial
+#endif
+
+// Configure your MAC address, IP address, and HTTP port here.
+byte mac[] = { 0xDE, 0xAD, 0xBE, 0x30, 0x31, 0x32 };
+IPAddress ip(192,168,0,77);
+int port = 3466;
+
+Denko denko;
+EthernetServer server(port);
+EthernetClient client;
+
+void printEthernetStatus() {
+  Serial.print("IP Address: ");
+  Serial.println(Ethernet.localIP());
+  Serial.print("Port: ");
+  Serial.println(port);
+}
+
+void setup() {
+  // Wait for serial ready.
+  serial.begin(115200);
+  while(!serial);
+
+  // Explicitly disable the SD card.
+  pinMode(4,OUTPUT);
+  digitalWrite(4,HIGH);
+
+  // Start up the network connection and server.
+  Ethernet.begin(mac, ip);
+  server.begin();
+  #ifdef debug
+    printEthernetStatus();
+  #endif
+
+  // Add listener callbacks for local logic.
+  denko.digitalListenCallback = onDigitalListen;
+  denko.analogListenCallback = onAnalogListen;
+}
+
+void loop() {
+  // Allow one client at a time to be connected. Set it as the denko IO stream.
+  if (!client){
+    client = server.available();
+    if (client) denko.stream = &client;
+  }
+
+  // Main loop of the denko library.
+  denko.run();
+
+  // End the connection when client disconnects and revert to serial IO.
+  if (client && !client.connected()){
+    client.stop();
+    denko.stream = &serial;
+  }
+}
+
+// This runs every time a digital pin that denko is listening to changes value.
+// p = pin number, v = current value
+void onDigitalListen(byte p, byte v){
+}
+
+// This runs every time an analog pin that denko is listening to gets read.
+// p = pin number, v = read value
+void onAnalogListen(byte p, int v){
+}

data/src/denko_serial.ino

@@ -0,0 +1,41 @@
+#include "Denko.h"
+
+Denko denko;
+
+// Define 'serial' as the serial interface to use.
+// Uses SerialUSB (left port), which is native USB, on Arduino Due and Zero, or Serial otherwise.
+// On many boards, eg. Arduino Due, RP2040, Serial may be native USB anyway.
+#if defined(__SAM3X8E__) || defined(__SAMD21G18A__)
+  #define serial SerialUSB
+  // Use this for Programming USB port (right) on Due and Zero.
+  // #define serial Serial
+#else
+  #define serial Serial
+#endif
+
+void setup() {
+  // Wait for serial ready.
+  serial.begin(115200);
+  while(!serial);
+
+  // Pass serial stream to denko so it can read/write.
+  denko.stream = &serial;
+
+  // Add listener callbacks for local logic.
+  denko.digitalListenCallback = onDigitalListen;
+  denko.analogListenCallback = onAnalogListen;
+}
+
+void loop() {
+  denko.run();
+}
+
+// This runs every time a digital pin that denko is listening to changes value.
+// p = pin number, v = current value
+void onDigitalListen(byte p, byte v){
+}
+
+// This runs every time an analog pin that denko is listening to gets read.
+// p = pin number, v = read value
+void onAnalogListen(byte p, int v){
+}

data/src/denko_wifi.ino

@@ -0,0 +1,157 @@
+#include "Denko.h"
+#if defined(ESP8266)
+  #include <ESP8266WiFi.h>
+  #include <ESP8266mDNS.h>
+  #include <WiFiUdp.h>
+  #include <ArduinoOTA.h>
+  #define WIFI_STATUS_LED 2
+#elif defined(ESP32)
+  #include <WiFi.h>
+  #include <ESPmDNS.h>
+  // #include <WiFiUdp.h>
+  // #include <ArduinoOTA.h>
+  #define WIFI_STATUS_LED 2
+#else
+  #include <SPI.h>
+  #include <WiFi.h>
+  #define WIFI_STATUS_LED 13
+#endif
+
+
+// Define 'serial' as the serial interface to use.
+// Uses SerialUSB (left port), which is native USB, on Arduino Due and Zero, or Serial otherwise.
+// On many boards, eg. Arduino Due, RP2040, Serial may be native USB anyway.
+#if defined(__SAM3X8E__) || defined(__SAMD21G18A__)
+  #define serial SerialUSB
+  // Use this for Programming USB port (right) on Due and Zero.
+  // #define serial Serial
+#else
+  #define serial Serial
+#endif
+
+// Configure your WiFi options here. IP address is not configurable. Uses DHCP.
+int port = 3466;
+char* ssid = "yourNetwork";
+char* pass = "yourPassword";
+boolean connected = false;
+
+Denko denko;
+WiFiServer server(port);
+WiFiClient client;
+
+// Use the built in LED to indicate WiFi status.
+void indicateWiFi(byte value) {
+  pinMode(WIFI_STATUS_LED, OUTPUT);
+  #if defined(ESP8266)
+    digitalWrite(WIFI_STATUS_LED, !value);
+  #else
+    digitalWrite(WIFI_STATUS_LED, value);
+  #endif
+}
+
+void printWifiStatus() {
+  serial.println("WiFi Connected");
+  serial.print("SSID: ");
+  serial.println(WiFi.SSID());
+  serial.print("Signal Strength (RSSI):");
+  serial.print(WiFi.RSSI());
+  serial.println(" dBm");
+  serial.print("IP Address: ");
+  serial.println(WiFi.localIP());
+  serial.print("Denko TCP Port: ");
+  serial.println(port);
+  indicateWiFi(true);
+}
+
+void connect(){
+  // Make sure we're in STA mode on ESP boards, which can also be AP.
+  #if defined(ESP8266) || defined(ESP32)
+    WiFi.mode(WIFI_STA);
+  #endif
+
+  // Try to connect.
+  serial.print("Connecting to WiFi ");
+  WiFi.begin(ssid, pass);
+
+  // Delay until connected.
+  while (WiFi.status() != WL_CONNECTED) {
+    delay(500);
+    serial.print(".");
+  }
+  connected = true;
+}
+
+void maintainWiFi(){
+  if (connected == true){
+    if (WiFi.status() == WL_CONNECTED) return;
+    connected = false;
+    connect();
+  }
+  if (connected == false){
+    if (WiFi.status() != WL_CONNECTED) {
+      connect();
+      return;
+    }
+    connected = true;
+    printWifiStatus();
+  }
+}
+
+void setup() {
+  // Wait for serial ready.
+  serial.begin(115200);
+  while(!serial);
+
+  // Enable over the air updates on the ESP8266.
+  #if defined(ESP8266)
+    ArduinoOTA.begin();
+  #endif
+
+  // Attempt initial WiFi connection.
+  connect();
+  
+  // Start the denko TCP server.
+  server.begin();
+
+  // Add listener callbacks for local logic.
+  denko.digitalListenCallback = onDigitalListen;
+  denko.analogListenCallback = onAnalogListen;
+
+  // Use serial as the denko IO stream until we get a TCP connection.
+  denko.stream = &serial;
+}
+
+void loop() {
+  // Reconnect if we've lost WiFi.
+  maintainWiFi();
+
+  // Allow one client at a time to be connected. Set it as the denko IO stream.
+  if (!client){
+    client = server.available();
+    if (client) denko.stream = &client;
+  }
+
+  // Main loop of the denko library.
+  denko.run();
+
+  // End the connection when client disconnects and revert to serial IO.
+  if (client && !client.connected()){
+    client.stop();
+    denko.stream = &serial;
+  }
+
+  // Handle OTA updates.
+  #if defined(ESP8266)
+    ArduinoOTA.handle();
+  #endif
+}
+
+// This runs every time a digital pin that denko is listening to changes value.
+// p = pin number, v = current value
+void onDigitalListen(byte p, byte v){
+}
+
+// This runs every time an analog pin that denko is listening to gets read.
+// p = pin number, v = read value
+void onAnalogListen(byte p, int v){
+}