denko 0.13.1 → 0.13.2

data/lib/denko/board.rb

@@ -1,42 +1,54 @@
 # Require all files in board folder relative to this file.
-Dir["#{Denko.root}/lib/denko/board/*.rb"].each {|file| require file }
+Dir["#{Denko.root}/lib/denko/board/*.rb"].each { |file| require file }
 
 module Denko
   class Board
-    attr_reader :board_name, :version, :aux_limit, :eeprom_length
+    attr_reader :name, :version, :serial_buffer_size, :aux_limit, :eeprom_length
     attr_reader :low, :high, :analog_write_high, :analog_read_high
 
-    def initialize(io, options={})
-      # Connect the IO, and get the ACK.
-      @io = io
-      ack = io.handshake
-      @name, @version, @aux_limit, @eeprom_length = ack.split(",")
+    def initialize(transport, options={})
+      # Shake hands
+      @transport = transport
+      ack = transport.handshake
 
-      # Parse map, version and eeprom_legnth.
-      @name          = nil if @name.empty?
-      @version       = nil if @version.empty?
-      @eeprom_length = @eeprom_length.to_i
+      # Split handshake acknowledgement into separate values.
+      @name, @version, @serial_buffer_size, @aux_limit, @eeprom_length, @i2c_limit = ack.split(",")
+
+      # Tell transport how much serial buffer the board has, for flow control.
+      @serial_buffer_size = @serial_buffer_size.to_i
+      raise StandardError, "no serial buffer size given in handshake" if @serial_buffer_size < 1
+      @transport.remote_buffer_size = @serial_buffer_size
+
+      # Load board map by name.
+      @name = nil if @name.empty?
+      load_map(@name)
 
       # Leave room for null termination of aux messages.
       @aux_limit = @aux_limit.to_i - 1
 
-      # Load the board map.
-      @map = load_map(@name)
+      # Set I2C transaction size limit. Safe minimum is 32.
+      # This makes I2C fail silently if board does not implement.
+      @i2c_limit = @i2c_limit.to_i
+      @i2c_limit = 32 if @i2c_limit == 0
+
+      # Remaining settings
+      @version       = nil if @version.empty?
+      @eeprom_length = @eeprom_length.to_i
 
-      # Allow the IO to call #update on the board when messages received.
-      io.add_observer(self)
+      # Transport calls #update on board when data is received.
+      transport.add_observer(self)
       
       # Set digital and analog IO levels.
       @low  = 0
       @high = 1
       self.analog_write_resolution = options[:write_bits] || 8
-      self.analog_read_resolution = options[:read_bits] || 10
+      self.analog_read_resolution  = options[:read_bits]  || 10
     end
     
     def finish_write
-      sleep 0.001 while @io.writing?
+      sleep 0.001 while @transport.writing?
       write "\n91\n"
-      sleep 0.001 while @io.writing?
+      sleep 0.001 while @transport.writing?
     end
           
     def analog_write_resolution=(value)
@@ -64,7 +76,7 @@ module Denko
     alias :adc_high :analog_read_high
     
     def write(msg)
-      @io.write(msg)
+      @transport.write(msg)
     end
 
     #
@@ -78,7 +90,7 @@ module Denko
     # signal is read by the TxRx, telling it to resume transmisison.
     #
     def write_and_halt(msg)
-      @io.write(msg, true)
+      @transport.write(msg, true)
     end
 
     #

data/lib/denko/connection/board_uart.rb

@@ -1,11 +1,11 @@
 module Denko
   module Connection
     class BoardUART < Base
-      BAUD = 115200
+      DEFAULT_BAUD = 115200
 
-      def initialize(uart, options={})
+      def initialize(uart, baud: DEFAULT_BAUD)
         @uart = uart
-        @uart.start(options[:baud] || BAUD)
+        @uart.start(baud)
       end
 
       def baud

data/lib/denko/connection/flow_control.rb

@@ -1,11 +1,19 @@
 module Denko
   module Connection
     module FlowControl
-      BOARD_BUFFER = 63
       SLEEP_TIME = 0.001
 
+      # Let Board object tell us the remote buffer size after parsing handshake.
+      def remote_buffer_size=(size)
+        @transit_mutex.synchronize { @remote_buffer_size = size }
+      end
+
       def initialize(*args)
         super(*args)
+        # Start with minimum known buffer size. Board will update after handshake.
+        # WARNING: If not updated, and ack threshold on the board is > minimum,
+        # FlowControl will stop sending data, and appear to hang. Fix this.
+        @remote_buffer_size = 63
         reset_flow_control
         tx_resume
       end
@@ -93,7 +101,7 @@ module Denko
       # Keep transit mutex as short as possible, by only reserving bytes, and writing outside.
       def reserve_bytes(length)
         @transit_mutex.synchronize do
-          available = BOARD_BUFFER - @transit_bytes
+          available = @remote_buffer_size - @transit_bytes
           reserved = (length > available) ? available : length
           @transit_bytes += reserved
           reserved

data/lib/denko/digital_io/output.rb

@@ -16,7 +16,7 @@ module Denko
       end
 
       def digital_write(value)
-        board.digital_write(pin, value)
+        @board.digital_write(@pin, value)
         self.state = value
       end
       

data/lib/denko/display/hd44780.rb

@@ -63,7 +63,7 @@ module Denko
       end
 
       def after_initialize(options={})
-        super(options) if defined?(super)
+        super(options)
         
         # Default to 16x2 display if no options given.
         @columns = options[:columns] || 16
@@ -212,7 +212,7 @@ module Denko
         send(byte, board.low)
       end
       
-      def write(byte);
+      def write(byte)
         send(byte, board.high)
       end
 
@@ -229,27 +229,27 @@ module Denko
       end
       
       def write4(bits)
-        d4.write bits[4]
-        d5.write bits[5]
-        d6.write bits[6]
-        d7.write bits[7]
+        d4.write bits[4].to_i
+        d5.write bits[5].to_i
+        d6.write bits[6].to_i
+        d7.write bits[7].to_i
         pulse_enable
-        d4.write bits[0]
-        d5.write bits[1]
-        d6.write bits[2]
-        d7.write bits[3]
+        d4.write bits[0].to_i
+        d5.write bits[1].to_i
+        d6.write bits[2].to_i
+        d7.write bits[3].to_i
         pulse_enable
       end
 
       def write8(bits)
-        d0.write bits[0]
-        d1.write bits[1]
-        d2.write bits[2]
-        d3.write bits[3]
-        d4.write bits[4]
-        d5.write bits[5]
-        d6.write bits[6]
-        d7.write bits[7]
+        d0.write bits[0].to_i
+        d1.write bits[1].to_i
+        d2.write bits[2].to_i
+        d3.write bits[3].to_i
+        d4.write bits[4].to_i
+        d5.write bits[5].to_i
+        d6.write bits[6].to_i
+        d7.write bits[7].to_i
         pulse_enable
       end
 

data/lib/denko/led/seven_segment.rb

@@ -3,6 +3,9 @@ module Denko
     class SevenSegment
       include Behaviors::MultiPin
       
+      ALL_OFF = [0,0,0,0,0,0,0]
+      BLANK = " "
+
       def initialize_pins(options={})
         [:a, :b, :c, :d, :e, :f, :g].each do |symbol|
           proxy_pin(symbol, DigitalIO::Output)
@@ -20,28 +23,30 @@ module Denko
       attr_reader :segments
 
       def clear
-        segments.each do |pin|
-          pin.low if cathode
-          pin.high if anode
-        end
+        write(BLANK)
       end
 
-      def display(char)
-        char = char.to_s
-        return scroll(char) if char.length > 1
-        off; write(char); on
+      def display(string)
+        on unless on?
+        string = string.to_s.upcase
+        (string.length > 1) ? scroll(string) : write(string)
       end
 
       def on
         anode.high if anode
         cathode.low if cathode
+        @on = true
       end
 
       def off
         anode.low if anode
         cathode.high if cathode
+        @on = false
       end
 
+      def on?;   @on; end
+      def off?; !@on; end
+      
       CHARACTERS = {
         '0' => [1,1,1,1,1,1,0],
         '1' => [0,1,1,0,0,0,0],
@@ -87,22 +92,16 @@ module Denko
       private
 
       def write(char)
-        bits = CHARACTERS[char.to_s.upcase]
-        unless bits
-          clear
-        else
-          bits.each_with_index do |bit, index|
-            if anode
-              bit == 0 ? bit = 1 : bit = 0
-            end
-            segments[index].write(bit) unless (segments[index].state == bit)
-          end
+        bits = CHARACTERS[char] || ALL_OFF
+        bits.each_with_index do |bit, index|
+          bit = 1^bit if anode
+          segments[index].write(bit) unless (segments[index].state == bit)
         end
       end
 
       def scroll(string)
         string.chars.each do |char|
-          display(char)
+          write(char)
           sleep(0.5)
         end
       end

data/lib/denko/message.rb

@@ -57,7 +57,7 @@ module Denko
       message = "#{command}#{message}\n"
     end
 
-    def self.pack(type, data, options={})
+    def self.pack(type, data, min: nil, max: nil)
       # Always pack as little endian.
       template =  case type
                   when :uint64  then 'Q<*'
@@ -70,20 +70,12 @@ module Denko
       # Can pass a single integer to get packed if we always [] then flatten.
       str = [data].flatten.pack(template)
 
-      # Pad right with null bytes if asked.
-      if options[:pad] && options[:pad] > str.length
-        (options[:pad] - str.length).times do
-          str = str + "\x00"
-        end
-      end
-
-      if options[:min] && str.length < options[:min]
-        raise ArgumentError, "too few bytes given (expected at least #{options[:min]})"
+      # Enforce min and max.
+      if min && str.length < min
+        raise ArgumentError, "too few bytes given (expected at least #{min})"
       end
-
-      # Max should probably always be set to avoid overruning aux message RAM.
-      if options[:max] && str.length > options[:max]
-        raise ArgumentError, "too many bytes given (expected at most #{options[:max]})"
+      if max && str.length > max
+        raise ArgumentError, "too many bytes given (expected at most #{max})"
       end
 
       str

data/lib/denko/pulse_io/ir_transmitter.rb

@@ -3,7 +3,7 @@ module Denko
     class IRTransmitter
       include Behaviors::OutputPin
 
-      def emit(pulses=[], options={})
+      def emit(pulses=[], frequency: 38)
         if pulses.length > 256 || pulses.length < 1
           raise ArgumentError, 'wrong number of IR pulses (expected 1 to 256)'
         end
@@ -14,7 +14,6 @@ module Denko
           raise ArgumentError, 'pulse too long (max 65535 ms)' if pulse > 65535
         end
 
-        frequency = options[:frequency] || 38
         board.infrared_emit(pin, frequency, pulses)
       end
     end

data/lib/denko/version.rb

@@ -1,3 +1,3 @@
 module Denko
-  VERSION = "0.13.1"
+  VERSION = "0.13.2"
 end

data/lib/denko_cli/packages.rb

@@ -12,10 +12,16 @@ PACKAGES = {
       "Denko.cpp",
       "DenkoCoreIO.cpp",
       "DenkoPulseInput.cpp",
-      "DenkoEEPROM.cpp",
       "../../vendor/board-maps/BoardMap.h",
     ]
   },
+  eeprom: {
+    description: "Built-in EEPROM support",
+    directive: "DENKO_EEPROM",
+    files: [
+      "DenkoEEPROM.cpp",
+    ]
+  },
   one_wire: {
     description: "OneWire bus support",
     directive: "DENKO_ONE_WIRE",

data/lib/denko_cli/targets.rb

@@ -11,14 +11,17 @@ class DenkoCLI::Generator
     mega168: [:core, :one_wire, :tone, :i2c, :spi, :servo],
 
     # Other ATmega chips do everything.
-    # Add bit bang serial for 328p / UNO since ith as no extra hardware UART.
+    # Add bit bang serial for 328p / UNO since it has no extra hardware UART.
     mega: STANDARD_PACKAGES + [:uart_bb],
 
-    # No tone or IR support on SAM3X / Due.
-    sam3x: STANDARD_PACKAGES - [:tone, :ir_out],
+    # No tone, infrared or EEPROM on SAM3X / Due.
+    sam3x: STANDARD_PACKAGES - [:tone, :ir_out, :eeprom],
     
-    # SAMD includes all standard packages.
-    samd: STANDARD_PACKAGES,
+    # No EEPROM on SAMD / Zero.
+    samd: STANDARD_PACKAGES - [:eeprom],
+
+    # No IR out and WS2812 on the UNO R4. WS2812 compiles but doesn't work.
+    ra4m1: STANDARD_PACKAGES - [:ir_out, :led_array],
 
     # ESP8266 + ESP32 use a different IR library.
     esp8266: STANDARD_PACKAGES - [:ir_out] + [:ir_out_esp],

data/lib/denko_cli/usage.txt

@@ -1,8 +1,10 @@
 
   Usage:
+
     denko task [options]
 
   Tasks:
+
     sketch SKETCH [options]
     help
     targets
@@ -12,23 +14,25 @@
     --target TARGET    (default: mega. Run 'denko targets' for more info)
     --debug            (default: off)
 
-  Available sketches and sketch for each sketch:
+  Available sketches and options specific to each sketch:
 
     serial
-      --baud BAUD    (default: 115200)
+      --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)
+      --baud BAUD                (default: 115200, serial fallback)
 
     wifi
       --ssid SSID            (required)
       --password PASSWORD    (required)
       --port PORT            (default: 3466)
+      --baud BAUD            (default: 115200, serial fallback)
 
   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
+    denko sketch serial   --baud 57600 --target esp32
+    denko sketch serial   --baud 9600  --target core

data/src/denko_ethernet.ino

@@ -2,17 +2,6 @@
 #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);
@@ -31,8 +20,8 @@ void printEthernetStatus() {
 
 void setup() {
   // Wait for serial ready.
-  serial.begin(115200);
-  while(!serial);
+  DENKO_SERIAL_IF.begin(115200);
+  while(!DENKO_SERIAL_IF);
 
   // Explicitly disable the SD card.
   pinMode(4,OUTPUT);
@@ -41,9 +30,7 @@ void setup() {
   // Start up the network connection and server.
   Ethernet.begin(mac, ip);
   server.begin();
-  #ifdef debug
-    printEthernetStatus();
-  #endif
+  printEthernetStatus();
 
   // Add listener callbacks for local logic.
   denko.digitalListenCallback = onDigitalListen;
@@ -51,20 +38,25 @@ void setup() {
 }
 
 void loop() {
+  // End connection if client disconnects.
+  if (client && !client.connected()) {
+    client.stop();
+  }
+
   // 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;
+    if (client) {
+      // TCP Client
+      denko.stream = &client;
+    } else {
+      // Serial fallback
+      denko.stream = &DENKO_SERIAL_IF;
+    }
   }
 
   // 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.

data/src/denko_serial.ino

@@ -2,24 +2,13 @@
 
 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);
+  DENKO_SERIAL_IF.begin(115200);
+  while(!DENKO_SERIAL_IF);
 
   // Pass serial stream to denko so it can read/write.
-  denko.stream = &serial;
+  denko.stream = &DENKO_SERIAL_IF;
 
   // Add listener callbacks for local logic.
   denko.digitalListenCallback = onDigitalListen;

data/src/denko_wifi.ino

@@ -17,18 +17,6 @@
   #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";
@@ -50,16 +38,16 @@ void indicateWiFi(byte value) {
 }
 
 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);
+  DENKO_SERIAL_IF.println("WiFi Connected");
+  DENKO_SERIAL_IF.print("SSID: ");
+  DENKO_SERIAL_IF.println(WiFi.SSID());
+  DENKO_SERIAL_IF.print("Signal Strength (RSSI):");
+  DENKO_SERIAL_IF.print(WiFi.RSSI());
+  DENKO_SERIAL_IF.println(" dBm");
+  DENKO_SERIAL_IF.print("IP Address: ");
+  DENKO_SERIAL_IF.println(WiFi.localIP());
+  DENKO_SERIAL_IF.print("Denko TCP Port: ");
+  DENKO_SERIAL_IF.println(port);
   indicateWiFi(true);
 }
 
@@ -70,37 +58,29 @@ void connect(){
   #endif
 
   // Try to connect.
-  serial.print("Connecting to WiFi ");
+  DENKO_SERIAL_IF.print("Connecting to WiFi ");
   WiFi.begin(ssid, pass);
 
   // Delay until connected.
   while (WiFi.status() != WL_CONNECTED) {
     delay(500);
-    serial.print(".");
+    DENKO_SERIAL_IF.print(".");
   }
   connected = true;
+  printWifiStatus();
 }
 
 void maintainWiFi(){
-  if (connected == true){
-    if (WiFi.status() == WL_CONNECTED) return;
+  if (WiFi.status() != WL_CONNECTED) {
     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);
+  DENKO_SERIAL_IF.begin(115200);
+  while(!DENKO_SERIAL_IF);
 
   // Enable over the air updates on the ESP8266.
   #if defined(ESP8266)
@@ -117,33 +97,38 @@ void setup() {
   denko.digitalListenCallback = onDigitalListen;
   denko.analogListenCallback = onAnalogListen;
 
-  // Use serial as the denko IO stream until we get a TCP connection.
-  denko.stream = &serial;
+  // Use DENKO_SERIAL_IF as the denko IO stream until we get a TCP connection.
+  denko.stream = &DENKO_SERIAL_IF;
 }
 
 void loop() {
   // Reconnect if we've lost WiFi.
   maintainWiFi();
 
+  // Handle OTA updates.
+  #if defined(ESP8266)
+    ArduinoOTA.handle();
+  #endif
+
+  // End connection if client disconnects.
+  if (client && !client.connected()) {
+    client.stop();
+  }
+
   // 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;
+    if (client) {
+      // TCP Client
+      denko.stream = &client;
+    } else {
+      // Serial fallback
+      denko.stream = &DENKO_SERIAL_IF;
+    }
   }
 
   // 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.