denko 0.13.0 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d685b8963656392d25464b4728bf3ee2191409ac06001418cdddbd465536983d
-  data.tar.gz: 19103a6a62a0399f27ca9d525c86c516448e853868d548afc3d6b21ba89e7cd3
+  metadata.gz: a8f92242ec380e61b3b9d8729c8268cd0384196a982b3546deea690449e1b969
+  data.tar.gz: f706c61a73d4ad2ea7ebc531454c79b1e45368f303b484189b8bf749d4845d52
 SHA512:
-  metadata.gz: 61acf4aabaad137625f3ab32341a991f84b69321fc68db253026beae952e5d2bc69b8afa0126a407810860b69fec0ddbfca755171d02cf5b38a1b224d4c20c99
-  data.tar.gz: f4f63fa0146b463483c95b4474a97dba6c07b77081dd6576bd7efc1d098431a8967e7b5051aaef0fca9cb4dba484e1c7c3cdb0e29b272158b7dfcfa1f93b8f6a
+  metadata.gz: f8d870fb998fe4694b6e18b3570f5caaaf965f4e54f8b6af609b6cdf27acae5be47482454b0c818bf3bd58e0d18d3548e8c18573bef3aef91054655c5120c411
+  data.tar.gz: 7d44fa1875dc2c023d4cbc664a5f8960bcaac9b3f32c44b41c366e9d9d8570f1d6d39850584be502c18e010c2d5d69aa2c786b85d504bb7bfda9064d0ba2c8a0

data/HARDWARE.md

@@ -2,22 +2,29 @@
 
 :green_heart: Full support :yellow_heart: Partial support :heart: Planned. No support yet :question: Works in theory. Untested in real hardware.
 
-### Microchip/Atmel Chips in Arduino Products (and Compatibles)
-[![AVR Build Status](https://github.com/denko-rb/denko/actions/workflows/build_avr.yml/badge.svg)](https://github.com/denko-rb/denko/actions/workflows/build_avr.yml) [![MegaAVR Build Status](https://github.com/denko-rb/denko/actions/workflows/build_megaavr.yml/badge.svg)](https://github.com/denko-rb/denko/actions/workflows/build_megaavr.yml) [![SAM3X Build Satus](https://github.com/denko-rb/denko/actions/workflows/build_sam3x.yml/badge.svg)](https://github.com/denko-rb/denko/actions/workflows/build_sam3x.yml) [![SAMD Build Satus](https://github.com/denko-rb/denko/actions/workflows/build_samd.yml/badge.svg)](https://github.com/denko-rb/denko/actions/workflows/build_samd.yml)
+### AVR/MegaAVR Based in Arduino Products (and Clones)
+[![AVR Build Status](https://github.com/denko-rb/denko/actions/workflows/build_avr.yml/badge.svg)](https://github.com/denko-rb/denko/actions/workflows/build_avr.yml) [![MegaAVR Build Status](https://github.com/denko-rb/denko/actions/workflows/build_megaavr.yml/badge.svg)](https://github.com/denko-rb/denko/actions/workflows/build_megaavr.yml)
 
 |    Chip        | Status          | Products         | Notes |
 | :--------      | :------:        | :--------------- |------ |
 | ATmega168      | :green_heart:   | Duemilanove, Diecimila, Pro | Features omitted to save memory. `denko targets` for more info.
-| ATmega328      | :green_heart:   | Uno, Nano, Fio, Pro  |
+| ATmega328      | :green_heart:   | Uno R3, Uno WiFi, Nano, Fio, Pro  |
 | ATmega32u4     | :green_heart:   | Leonardo, Micro, Leonardo ETH, Esplora, LilyPad USB |
 | ATmega1280     | :green_heart:   | Mega |
 | ATmega2560     | :green_heart:   | Mega2560, Arduino Mega ADK |
 | ATmega4809     | :question:      | Nano Every, Uno WiFi Rev2 | No hardware to test, but should work
-| ATSAM3X8E      | :yellow_heart:  | Due | Native USB port. Tone, and IR Out don't work.
-| ATSAMD21       | :green_heart:   | Zero, M0, M0 Pro | Native USB port. I2C seems stuck on 100 kHz.
 
 **Note:** Only USB boards listed. Any board with a supported chip should work, once you can flash it and connect to serial.
 
+### ARM Based Arduino Products (and Clones)
+[![SAM3X Build Satus](https://github.com/denko-rb/denko/actions/workflows/build_sam3x.yml/badge.svg)](https://github.com/denko-rb/denko/actions/workflows/build_sam3x.yml) [![SAMD Build Satus](https://github.com/denko-rb/denko/actions/workflows/build_samd.yml/badge.svg)](https://github.com/denko-rb/denko/actions/workflows/build_samd.yml)
+
+|    Chip        | Status          | Products         | Notes |
+| :--------      | :------:        | :--------------- |------ |
+| ATSAM3X8E      | :yellow_heart:  | Due | Native USB port. Tone, and IR Out don't work.
+| ATSAMD21       | :green_heart:   | Zero, M0, M0 Pro | Native USB port. I2C seems stuck on 100 kHz.
+| RA4M1          | :heart:         | Uno R4 Minima, Uno R4 WiFi |
+
 ### Arduino Accessories
 
 |    Chip               | Status          | Product          | Notes |

data/README.md

@@ -2,7 +2,7 @@
 ### Ruby Meets Microcontrollers
 Denko gives you a high-level Ruby interface to low-level hardware, without writing microcontroller code. Use LEDs, buttons, sensors and more, just as easily as any Ruby object:
 
-````ruby
+```ruby
 led.blink 0.5
 
 lcd.print "Hello World!"
@@ -12,9 +12,9 @@ reading = sensor.read
 button.down do
   puts "Button pressed!"
 end
-````
+```
 
-Denko doesn't run Ruby on the microcontroller (see the [mruby-dino](#mruby) project). It runs a C++ firmware that exposes as much low-level I/O as possible, so we can use it in Ruby. It becomes a peripheral for your computer.
+Denko doesn't run Ruby on the microcontroller (see [mruby-denko](#mruby-denko) for that). It runs C++ firmware that exposes as much low-level I/O as possible, so we can use it in Ruby. It becomes a peripheral for your computer.
 
 High-level abstraction in Ruby makes hardware classes easy to implement, with intuitive interfaces. They multitask a single core microcontroller, with thread-safe state, and callbacks for inputs, but no "task" priority. If you need more I/O, integration is seamless. Connect another board and instantiate it in Ruby.
 
@@ -22,7 +22,15 @@ Each peripheral connected to your microcontroller(s) maps to a Ruby object you c
 
 ### Supported Hardware
 
-See a full list of supported mircocontroller platforms, interfaces, and peripherals [here](HARDWARE.md).
+Full list of supported mircocontroller platforms, interfaces, and peripherals is located [here](HARDWARE.md).
+
+##### denko-piboard
+There's an add-on for this gem  in development, [denko-piboard](https://github.com/denko-rb/denko-piboard), which supports the Raspberry Pi's built in GPIO pins, as `Denko::PiBoard`, class-compatible with `Denko::Board`. Connect peripherals directly to the Pi, with no microcontroller between, then use the same peripheral classes from this gem.
+
+##### mruby-denko
+A solo Raspberry Pi (or other small SBC + microcontroller) is a great standalone setup if your project needs the compute power anyway, but what if you don't? Why not run Ruby on the microcontroller itself? 
+
+That's the goal of [mruby-denko](https://github.com/denko-rb/mruby-denko). Write mruby on the ESP32, using peripheral classes as close to this gem as possible. Still early in development, and limited features, but already working.
 
 ## Getting Started
 
@@ -33,17 +41,17 @@ See a full list of supported mircocontroller platforms, interfaces, and peripher
 gem install denko
 ```
 
-Before using the microcontroller in Ruby, we need to flash it with the denko firmware (or "sketch" in Arduino lingo). This is needed **once** for each board, but future denko versions may need reflashing to add functionality.
+Before using the microcontroller in Ruby, we need to flash it with the denko firmware (or "sketch" in Arduino lingo). This is needed **once** for each board, but future versions may need reflashing to add functionality.
 
 #### 2. Install the Arduino IDE OR CLI
 
 Get the Arduino IDE [here](http://arduino.cc/en/Main/Software) for a graphical interface (recommended for Windows), or use the command line interface from [here](https://github.com/arduino/arduino-cli/releases), or Homebrew.
 
 **CLI Installation with Homebrew on Mac or Linux:**
-````shell
+```shell
 brew update
 brew install arduino-cli
-````
+```
 
 #### 3. Install Arduino Dependencies
 Denko uses Arduino cores, which add support for microcontrollers, and a few libraries. Install only the ones for your microcontroller, or install everything. There are no conflcits. Instructions for supported microcontrollers:
@@ -56,22 +64,22 @@ The `denko` command is included with the gem. It will make the Arduino sketch fo
 **For ATmega boards, Serial over USB:** (Arduino Uno, Nano, Mega, Leonardo, Micro)
 ```shell
 denko sketch serial
-````
+```
 
 **For ESP8266, Serial over USB:**
 ```shell
 denko sketch serial --target esp8266
-````
+```
 
 **For ESP8266 or ESP32 over WiFi (2.4Ghz and DHCP Only):**
 ```shell
 denko sketch wifi --target esp8266 --ssid YOUR_SSID --password YOUR_PASSWORD
 denko sketch wifi --target esp32 --ssid YOUR_SSID --password YOUR_PASSWORD
-````
+```
 
-**Note:** [This example](examples/connection/tcp.rb) shows how to connect to a board with a TCP socket, but the WiFi & Ethernet sketches fall back to the serial interface when no TCP client is connected.
+**Note:** [This example](examples/connection/tcp.rb) shows how to connect to a board with a TCP socket, but the WiFi & Ethernet sketches fall back to the Serial interface when no TCP client is connected.
 
-#### 5a) IDE Flashing
+#### 5a. IDE Flashing
 
 * Connect the board to your computer with a USB cable.
 * Open the .ino file inside your sketch folder with the IDE.
@@ -82,45 +90,45 @@ denko sketch wifi --target esp32 --ssid YOUR_SSID --password YOUR_PASSWORD
 * If your serial port is in the list, but the board is wrong, select the serial port anyway, then you will be asked to manually select a board.
 * If your board doesn't show up at all, make sure it is connected properly. Try disconnecting and reconnecting, use a different USB port or cable, or press the reset button after plugging it in.
 
-#### 5b) CLI Flashing
+#### 5b. CLI Flashing
 
 * The path output by `denko sketch` earlier is your sketch folder. Keep it handy.
 * Connect the board to your computer with a USB cable.
 * Check if the CLI recognizes it:
 
-````shell
+```shell
 arduino-cli board list
-````
+```
   
 * Using the Port and FQBN (Fully Qualified Board Name) shown, compile and upload the sketch:
-````shell
+```shell
 arduino-cli compile -b YOUR_FQBN YOUR_SKETCH_FOLDER
 arduino-cli upload -v -p YOUR_PORT -b YOUR_FQBN YOUR_SKETCH_FOLDER
-````
+```
 
 **Troubleshooting:**
 * Follow the same steps as the IDE method above. List all FQBNs using:
-````shell
+```shell
 arduino-cli board listall
-````
+```
 
-#### 6)  Test It
+#### 6. Test It
 
-Most boards have a regular LED on-board. Test it with the [blink](examples/led/builtin_blink.rb) example. If you have an on-board WS2812 LED, use the [WS2812 blink](examples/led/ws2812_builtin_blink.rb) example instead. If it starts blinking, you're ready for Ruby!
+Most boards have a regular LED on-board. Test it with the [blink](examples/led/builtin_blink.rb) example. If you have an on-board WS2812 LED (Neopixel), use the [WS2812 blink](examples/led/ws2812_builtin_blink.rb) example instead. If it starts blinking, you're ready for Ruby!
 
 ## Examples and Tutorials
 
 #### Tutorial
 
 - [Here](tutorial) you will find a beginner-friendly tutorial, that goes through the basics, using commented examples and diagrams. Read the comments and try modifying the code. You will need the following:
-  * 1 compatible microcontroller (see [supported hardware](HARDWARE.md))
-  * 1 button or momentary switch
-  * 1 potentiometer (any value)
-  * 1 external RGB LED (4 legs common cathode, not a Neopixel or individually addressable)
-  * 1 external LED (any color, or use one color from the RGB LED)
-  * Current limiting resistors for LEDs
-  * Breadboard
-  * Jumper wires
+  - 1 compatible microcontroller (see [supported hardware](HARDWARE.md))
+  - 1 button or momentary switch
+  - 1 potentiometer (any value)
+  - 1 external RGB LED (4 legs common cathode, not a Neopixel or individually addressable)
+  - 1 external LED (any color, or use one color from the RGB LED)
+  - Current limiting resistors for LEDs
+  - Breadboard
+  - Jumper wires
   
   **Tip:** Kits are a cost-effective way to get started. They will almost certainly include these parts, plus more, getting you well beyond the tutorial.
 
@@ -140,13 +148,3 @@ Most boards have a regular LED on-board. Test it with the [blink](examples/led/b
 - "Arduino the Ruby Way" at RubyConf 2012
   - [Video by ConFreaks](https://www.youtube.com/watch?v=oUIor6GK-qA)
   - [Slides on SpeakerDeck](https://speakerdeck.com/austinbv/arduino-the-ruby-way)
-  
-## mruby Port
-
-A single-board computer plus microcontroller can be a great standalone solution, especially if your project needs the computer anyway. For example, a Raspberry Pi Zero and Arduino Nano combo, running CRuby, Denko and other software.
-
-But what if you want to be _really_ small? Building on the [mruby-esp32](https://github.com/mruby-esp32/mruby-esp32) project, Denko is being ported to run directly on the ESP32 here: [mruby-dino-template](https://github.com/denko-rb/mruby-dino-template).
-
-## denko-piboard
-
-There's an add-on for this gem, [denko-piboard](https://github.com/denko-rb/denko-piboard), in early development, which adds support for the Raspberry Pi's built in GPIO interface as a class-compatible "board". This allows you to connect peripherals directly to the Pi, without a microcontroller, and use the denko peripherals classes as-is.

data/examples/sensor/aht20.rb

@@ -5,7 +5,7 @@ require 'bundler/setup'
 require 'denko'
 
 board = Denko::Board.new(Denko::Connection::Serial.new)
-bus = Denko::I2C::Bus.new(board: board, pin: :SDA0)
+bus = Denko::I2C::Bus.new(board: board, pin: :SDA)
 aht20 = Denko::Sensor::AHT20.new(bus: bus)
 
 aht20.poll(2) do |reading|

data/lib/denko/behaviors/bus_peripheral_addressed.rb

@@ -4,7 +4,7 @@ module Denko
       include Denko::Behaviors::BusPeripheral
 
       def before_initialize(options={})
-        # Aallow @address override in options, even if peripheral sets default.
+        # Allow @address override in options, even if peripheral sets a default.
         @address = options[:address] if options[:address]
 
         raise ArgumentError, "missing address for #{self}. Try Bus#search first" unless @address

data/lib/denko/behaviors/component.rb

@@ -33,7 +33,7 @@ module Denko
         board.remove_component(self)
       end
 
-      # Setup::Base only requires a board.
+      # Behaviors::Component only requires a board.
       # Include modules from Setup or override this to use pins.
       #
       def before_initialize(options={}); end

data/lib/denko/behaviors/input_pin.rb

@@ -12,9 +12,12 @@ module Denko
       def initialize_pins(options={})
         super(options)
         
+        # Assume input direction, and look for pull mode in options.
         initial_mode = :input
         initial_mode = :input_pullup   if options[:pullup]
         initial_mode = :input_pulldown if options[:pulldown]
+
+        # If user was explicit about mode, just use that.
         initial_mode = options[:mode]  if options[:mode]
         
         self.mode = initial_mode

data/lib/denko/behaviors/single_pin.rb

@@ -11,15 +11,13 @@ module Denko
       
     protected
 
-      attr_writer :pin
-
       def convert_pins(options={})
         raise ArgumentError, 'a pin is required for this component' unless options[:pin]
         options[:pin] = board.convert_pin(options[:pin])
       end
 
       def initialize_pins(options={})
-        self.pin = options[:pin]
+        @pin = options[:pin]
       end
     end
   end

data/lib/denko/behaviors/state.rb

@@ -2,6 +2,7 @@ module Denko
   module Behaviors
     module State
       def initialize(options={})
+        # Component includes State, so no need to call super here.
         @state_mutex = Mutex.new
         @state = nil
       end

data/lib/denko/one_wire/bus.rb

@@ -4,7 +4,7 @@ module Denko
       include Behaviors::SinglePin
       include Behaviors::BusControllerAddressed
       include Behaviors::Reader
-      include BusEnumeration
+      include BusEnumerator
       include Constants
 
       attr_reader :parasite_power

data/lib/denko/one_wire/{bus_enumeration.rb → bus_enumerator.rb}

@@ -1,6 +1,8 @@
 module Denko
   module OneWire
-    module BusEnumeration
+    module BusEnumerator
+      include Constants
+
       def _search(branch_mask)
         reset
         write(SEARCH_ROM)
@@ -42,12 +44,12 @@ module Denko
       def parse_search_result(result)
         address, complement = split_search_result(result)
 
-        raise "CRC error during OneWire search" unless Helper.crc_check(address)
-
         if (address & complement) > 0
           raise "OneWire device not connected or disconnected during search"
         end
 
+        raise "CRC error during OneWire search" unless Helper.crc(address)
+
         # Gives 0 at every discrepancy we didn't write 1 for on this search.
         new_discrepancies = address ^ complement
 
@@ -73,12 +75,18 @@ module Denko
         [address, complement]
       end
 
-      # Set FAMILY_CODE in peripheral class to get it identified during search.
+      # 
+      # Set FAMILY_CODE in peripheral class, and add the class to this array
+      # for the class to be identified during search.
+      #
+      PERIPHERAL_CLASSES = [
+        Sensor::DS18B20,
+      ]
+
       def family_lookup(family_code)
-        OneWire.constants.each do |const|
-          obj = OneWire.const_get(const)
-          if (obj.is_a? Class) && (obj.const_defined? "FAMILY_CODE")
-            return obj if obj::FAMILY_CODE == family_code
+        PERIPHERAL_CLASSES.each do |klass|
+          if (klass.const_defined? "FAMILY_CODE")
+            return klass if klass::FAMILY_CODE == family_code
           end
         end
         return nil

data/lib/denko/one_wire/helper.rb

@@ -5,7 +5,7 @@ module Denko
         [address].pack('Q<').split("").map(&:ord)
       end
 
-      def self.crc_check(data)
+      def self.crc(data)
         calculated, received = self.calculate_crc(data)
         calculated == received
       end

data/lib/denko/one_wire.rb

@@ -2,7 +2,7 @@ module Denko
   module OneWire
     autoload :Constants,      "#{__dir__}/one_wire/constants"
     autoload :Helper,         "#{__dir__}/one_wire/helper"
-    autoload :BusEnumeration, "#{__dir__}/one_wire/bus_enumeration"
+    autoload :BusEnumerator,  "#{__dir__}/one_wire/bus_enumerator"
     autoload :Bus,            "#{__dir__}/one_wire/bus"
     autoload :Peripheral,     "#{__dir__}/one_wire/peripheral"
   end

data/lib/denko/sensor/ds18b20.rb

@@ -47,7 +47,7 @@ module Denko
       end
 
       def pre_callback_filter(bytes)
-        return { crc_error: true } unless Helper.crc_check(bytes)
+        return { crc_error: true } unless OneWire::Helper.crc(bytes)
         @resolution = decode_resolution(bytes)
 
         decode_temperature(bytes).merge(raw: bytes)

data/lib/denko/version.rb

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

data/test/one_wire/bus_enumerator_test.rb

@@ -131,4 +131,8 @@ class OneWireEnumeratorTest < Minitest::Test
     found_addresses = bus.found_devices.map { |d| d[:address] }
     assert_equal found_addresses.sort, bus_sim.addresses.sort
   end
+
+  def test_includes_constants
+    assert Denko::OneWire::BusEnumerator.ancestors.include?(Denko::OneWire::Constants)
+  end
 end

data/test/one_wire/helper_test.rb

@@ -3,16 +3,16 @@ require_relative '../test_helper'
 class OneWireHelper < Minitest::Test
   
   def test_with_valid_crc
-    assert Denko::OneWire::Helper.crc_check(18086456125349333800)
-    assert Denko::OneWire::Helper.crc_check([121, 117, 144, 185, 6, 165, 43, 26])
+    assert Denko::OneWire::Helper.crc(18086456125349333800)
+    assert Denko::OneWire::Helper.crc([121, 117, 144, 185, 6, 165, 43, 26])
   end
   
   def test_with_invalid_crc
-    refute Denko::OneWire::Helper.crc_check(18086456125349333801)
+    refute Denko::OneWire::Helper.crc(18086456125349333801)
   end
   
   def test_arbitrary_length_read
-    assert Denko::OneWire::Helper.crc_check([181, 1, 75, 70, 127, 255, 11, 16, 163])
-    refute Denko::OneWire::Helper.crc_check([181, 1, 75, 70, 127, 255, 11, 16, 164])
+    assert Denko::OneWire::Helper.crc([181, 1, 75, 70, 127, 255, 11, 16, 163])
+    refute Denko::OneWire::Helper.crc([181, 1, 75, 70, 127, 255, 11, 16, 164])
   end
 end

data/test/sensor/ds18b20_test.rb

@@ -43,6 +43,16 @@ class DS18B20Test < MiniTest::Test
     assert_equal 0.75, part.instance_variable_get(:@convert_time)
   end
 
+  def test_pre_callback_filter_does_crc_and_returns_error_on_fail
+    raw_bytes = [239, 1, 75, 70, 127, 255, 1, 16, 245]
+    mock = MiniTest::Mock.new.expect(:call, false, [raw_bytes])
+
+    Denko::OneWire::Helper.stub(:crc, mock) do
+      assert_equal({crc_error: true}, part.pre_callback_filter(raw_bytes))
+    end
+    mock.verify
+  end
+
   # test resolution=
 
   def test_convert_is_atomic

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: denko
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.13.1
 platform: ruby
 authors:
 - vickash, Austinbv
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-20 00:00:00.000000000 Z
+date: 2023-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyserial
@@ -229,7 +229,7 @@ files:
 - lib/denko/motor/stepper.rb
 - lib/denko/one_wire.rb
 - lib/denko/one_wire/bus.rb
-- lib/denko/one_wire/bus_enumeration.rb
+- lib/denko/one_wire/bus_enumerator.rb
 - lib/denko/one_wire/constants.rb
 - lib/denko/one_wire/helper.rb
 - lib/denko/one_wire/peripheral.rb