denko 0.14.0 → 0.15.0

data/examples/sensor/generic_pir.rb

@@ -1,27 +0,0 @@
-#
-# Example using a PIR motion sensor. Tested with AS312 and HC-SR501 sensors.
-#
-# General notes:
-#   - Both sensors have a few seconds "dead time" after "motion stop" (logical 0), where further
-#     motion will not trigger "motion start" (logical 1).
-#
-# HC-SR501 notes:
-#   - Needs some time to warm up and start working properly.
-#   - Set the time potentiometer to its lowest value.
-#   - Make sure retriggering is enabled. It might be default, but there's a jumper to solder too.
-#
-require 'bundler/setup'
-require 'denko'
-
-PIN    = 8
-
-board  = Denko::Board.new(Denko::Connection::Serial.new)
-sensor = Denko::Sensor::GenericPIR.new(board: board, pin: PIN)
-
-sensor.on_motion_start { print "Motion detected!      \r" }
-sensor.on_motion_stop  { print "No motion detected... \r" }
-
-# Read initial state.
-sensor.read
-
-sleep

data/examples/sensor/hcsr04.rb

@@ -1,17 +0,0 @@
-#
-# Example of reading an HC-SR04 ultrasonic sensor.
-#
-require 'bundler/setup'
-require 'denko'
-
-TRIGGER_PIN = 6
-ECHO_PIN    = 7
-
-board = Denko::Board.new(Denko::Connection::Serial.new)
-hcsr04 = Denko::Sensor::HCSR04.new(board: board, pins: {trigger: TRIGGER_PIN, echo: ECHO_PIN})
-
-hcsr04.poll(0.50) do |distance|
-  puts "Distance: #{distance} mm"
-end
-
-sleep

data/examples/sensor/htu21d.rb

@@ -1,43 +0,0 @@
-#
-# HTU21D sensor over I2C, for temperature and humidity.
-#
-require 'bundler/setup'
-require 'denko'
-require_relative 'neat_tph_readings'
-
-board  = Denko::Board.new(Denko::Connection::Serial.new)
-bus    = Denko::I2C::Bus.new(board: board)
-htu21d = Denko::Sensor::HTU21D.new(bus: bus) # address: 0x40 default
-
-# Get and set heater state.
-htu21d.heater_on
-puts "Heater on: #{htu21d.heater_on?}"
-htu21d.heater_off
-puts "Heater off: #{htu21d.heater_off?}"
-puts
-
-# Back to default settings, except heater state.
-htu21d.reset
-
-# Only 4 resolution combinations are available, and need to be
-# set by giving a bitmask from the datasheet:
-#   0x00 = 14-bit temperature, 12-bit humidity
-#   0x01 = 12-bit temperature,  8-bit humidity (default)
-#   0x80 = 13-bit temperature, 10-bit humidity
-#   0x81 = 11-bit temperature, 11-bit humidity
-#
-htu21d.resolution = 0x81
-puts "Temperature resolution: #{htu21d.resolution[:temperature]} bits"
-puts "Humidity resolution:    #{htu21d.resolution[:humidity]} bits"
-puts
-
-htu21d.read
-puts "Temperature unit helpers: #{htu21d.temperature} \xC2\xB0C | #{htu21d.temperature_f} \xC2\xB0F | #{htu21d.temperature_k} K"
-puts
-
-# Poll it and print readings.
-htu21d.poll(5) do |reading|
-  print_tph_reading(reading)
-end
-
-sleep

data/examples/sensor/htu31d.rb

@@ -1,33 +0,0 @@
-#
-# HTU31D sensor over I2C, for temperature and humidity.
-#
-require 'bundler/setup'
-require 'denko'
-require_relative 'neat_tph_readings'
-
-board  = Denko::Board.new(Denko::Connection::Serial.new)
-bus    = Denko::I2C::Bus.new(board: board)
-sensor = Denko::Sensor::HTU31D.new(bus: bus) # address: 0x40 default
-
-# Get and set heater state.
-sensor.heater_on
-puts "Heater on: #{sensor.heater_on?}"
-sensor.heater_off
-puts "Heater off: #{sensor.heater_off?}"
-
-# Back to default settings, including heater off, unlike HTU21D.
-sensor.reset
-puts "Resetting HTU31D..."
-puts "Heater off: #{sensor.heater_off?}"
-puts
-
-# Resolution goes from 0..3 separately for temperature and humidity. See datasheet.
-sensor.temperature_resolution = 3
-sensor.humidity_resolution    = 3
-
-# Poll it and print readings.
-sensor.poll(5) do |reading|
-  print_tph_reading(reading)
-end
-
-sleep

data/examples/sensor/neat_tph_readings.rb

@@ -1,32 +0,0 @@
-#
-# This helper method can be used in temp/pressure/humidity sensor examples.
-# Give a hash with readings as float values and it prints them neatly.
-#
-def print_tph_reading(reading)
-  elements = []
-
-  # Temperature
-  if reading[:temperature]
-    formatted_temp = reading[:temperature].to_f.round(2).to_s.ljust(5, '0')
-    elements << "Temperature: #{formatted_temp} \xC2\xB0C"
-  end
-  
-  # Pressure
-  if reading[:pressure]
-    formatted_pressure = reading[:pressure].round(2).to_s.ljust(7, '0')
-    elements << "Pressure: #{formatted_pressure} Pa"
-  end
-  
-  # Humidity  
-  if reading[:humidity]
-    formatted_humidity = reading[:humidity].round(2).to_s.ljust(5, '0')
-    elements << "Humidity: #{formatted_humidity} %"
-  end
-
-  return if elements.empty?
-  
-  # Time
-  print "#{Time.now.strftime '%Y-%m-%d %H:%M:%S'} - "
-  
-  puts elements.join(" | ")
-end

data/examples/sensor/qmp6988.rb

@@ -1,51 +0,0 @@
-#
-# Example using QMP6988 sensor over I2C, for air temperature and pressure.
-#
-require 'bundler/setup'
-require 'denko'
-require_relative 'neat_tph_readings'
-
-board  = Denko::Board.new(Denko::Connection::Serial.new)
-bus    = Denko::I2C::Bus.new(board: board)
-sensor = Denko::Sensor::QMP6988.new(bus: bus) # address: 0x70 default
-
-# Verify chip_id.
-print "I2C device has chip ID: 0x#{sensor.chip_id.to_s(16).upcase}. "
-if sensor.chip_id == 0x5C
-  puts "This matches the QMP6988."
-else
-  puts "This does not match the QMP6988."
-end
-puts
-
-#
-# Change measurement settings:
-#   temperature_samples can be 1,2,4,8,16,32 or 64 (default: 1)
-#   pressure_samples    can be 1,2,4,8,16,32 or 64 (default: 1)
-#   iir_coefficient     can be 0,2,4,8,16 or 32    (default: 0)
-#
-# High accuracy settings from datasheet, with IIR of 2.
-sensor.temperature_samples = 2
-sensor.pressure_samples    = 16
-sensor.iir_coefficient     = 2
-
-#
-# Change mode (default: forced_mode)
-#
-# Buggy on ESP32S3 in forced mode. Data registers return zeroes on all but first read.
-# Can't recreate on ESP32 V1, AVR or SAMD21. Put it in contiuous mode just in case.
-sensor.continuous_mode
-# sensor.forced_mode
-
-#
-# Set standby time (between measurements) for continuous mode only:
-#   standby_time (given in ms) can be 1,5,20,250,500,1000,2000 or 4000 (default: 1)
-#
-# sensor.standby_time = 500
-
-# Poll it and print readings.
-sensor.poll(5) do |reading|
-  print_tph_reading(reading)
-end
-
-sleep

data/examples/sensor/rcwl9620.rb

@@ -1,15 +0,0 @@
-#
-# RCWL-9620 sensor over I2C to measure distance.
-#
-require 'bundler/setup'
-require 'denko'
-
-board  = Denko::Board.new(Denko::Connection::Serial.new)
-bus    = Denko::I2C::Bus.new(board: board)
-sensor = Denko::Sensor::RCWL9620.new(bus: bus) # address: 0x57 default
-
-sensor.poll(1) do |distance|
-  puts "Distance is #{distance} mm"
-end
-
-sleep

data/examples/sensor/sht3x.rb

@@ -1,32 +0,0 @@
-#
-# SHT30/31/35 sensor over I2C, for temperature and humidity.
-#
-require 'bundler/setup'
-require 'denko'
-require_relative 'neat_tph_readings'
-
-board  = Denko::Board.new(Denko::Connection::Serial.new)
-bus    = Denko::I2C::Bus.new(board: board)
-sensor = Denko::Sensor::SHT3X.new(bus: bus) # address: 0x44 default
-
-# Heater control
-sensor.heater_on
-puts "Heater on: #{sensor.heater_on?}"
-sensor.heater_off
-puts "Heater off: #{sensor.heater_off?}"
-
-# Reset (turns heater off)
-sensor.reset
-puts "Resetting..."
-puts "Heater off: #{sensor.heater_off?}"
-puts
-
-# Set repeatability= :low, :medium or :high (default). See datasheet for details.
-sensor.repeatability = :high
-
-# Poll it and print readings.
-sensor.poll(5) do |reading|
-  print_tph_reading(reading)
-end
-
-sleep

data/examples/spi/bitbang_loopback.rb

@@ -1,46 +0,0 @@
-require 'bundler/setup'
-require 'denko'
-
-SPI_BIT_BANG_PINS = { clock: 13, input: 12, output: 11 }
-SELECT_PIN        = 10
-
-board = Denko::Board.new(Denko::Connection::Serial.new)
-bus = Denko::SPI::BitBang.new(board: board, pins: SPI_BIT_BANG_PINS)
-
-# Methods so results print neatly. SPI transfers don't block main thread.
-def stop_waiting
-  $waiting = false
-end
-
-def wait_for_read
-  $waiting = true
-  sleep 0.001 while $waiting
-end
-
-# Create a simple test component class.
-class SPITester
-  include Denko::SPI::Peripheral::SinglePin
-end
-spi_tester = SPITester.new(bus: bus, pin: SELECT_PIN)
-
-spi_tester.add_callback do |rx_bytes|
-  # If MOSI and MISO are connected this should match TEST_DATA.
-  # If not, all bytes should be 255.
-  puts "Result      : #{rx_bytes.inspect}"
-  stop_waiting
-end
-
-TEST_DATA = [0, 1, 2, 3, 4, 5, 6, 7]
-
-# Send and receive same data.
-puts "Tx 8 / Rx 8 : #{TEST_DATA.inspect}"
-spi_tester.spi_transfer(write: TEST_DATA, read: 8)
-wait_for_read
-
-puts "Tx 8 / Rx 12: #{TEST_DATA.inspect}"
-spi_tester.spi_transfer(write: TEST_DATA, read: 12)
-wait_for_read
-
-puts "Tx 8 / Rx 4 : #{TEST_DATA.inspect}"
-spi_tester.spi_transfer(write: TEST_DATA, read: 4)
-wait_for_read

data/examples/spi/input_register.rb

@@ -1,40 +0,0 @@
-#
-# Button connected through input shift register (CD4021B).
-#
-require 'bundler/setup'
-require 'denko'
-
-# SPI pins (on board)
-SPI_BIT_BANG_PINS   = { clock: 13, input: 12 }
-REGISTER_SELECT_PIN = 9
-
-# Button pin (on register parallel outputs)
-BUTTON_PIN = 0
-
-board = Denko::Board.new(Denko::Connection::Serial.new)
-bus   = Denko::SPI::BitBang.new(board: board, pins: SPI_BIT_BANG_PINS)
-
-# InputRegister needs a bus and its select pin. The CD4021 likes SPI mode 2.
-# Other options and their defaults:
-#     bytes:          1          - For daisy-chaining registers
-#     spi_frequency:  1000000    - Only affects hardware SPI interfaces
-#     spi_mode:       0
-#     spi_bit_order:  :msbfirst
-#
-register = Denko::SPI::InputRegister.new(bus: bus, pin: REGISTER_SELECT_PIN, spi_mode: 2)
-
-# InputRegister is a BoardProxy, so DigitalInput components can can use
-# it in place of a board. Use it with a Button instance.
-#
-# button starts listening automatically, which tells register to start listening.
-# On Denko::Board, InputRegisters listen with an 8ms interval by default, compared
-# to 1ms default for a Button directly connected to a Board.
-#
-button = Denko::DigitalIO::Button.new(pin: BUTTON_PIN, board: register)
-
-# Button callbacks.
-button.down { puts "Button pressed"  }
-button.up   { puts "Button released" }
-
-# Keep main thread alive.
-sleep

data/examples/spi/output_register.rb

@@ -1,41 +0,0 @@
-#
-# Example of LED connected through an output shift register (74HC595).
-# Can be used over either a bit bang or hardware SPI interface.
-#
-require 'bundler/setup'
-require 'denko'
-
-# SPI pins (on board)
-SPI_BIT_BANG_PINS   = { clock: 13, output: 11 }
-REGISTER_SELECT_PIN = 10
-
-# LED pin (on register parallel outputs)
-LED_PIN = 0
-
-# Works on hardware or bit-bang SPI.
-board = Denko::Board.new(Denko::Connection::Serial.new)
-# bus = Denko::SPI::Bus.new(board: board)
-bus = Denko::SPI::BitBang.new(board: board, pins: SPI_BIT_BANG_PINS)
-
-# OutputRegister needs a bus and its select pin.
-# Other options and their defaults:
-#     bytes:          1          - For daisy-chaining registers
-#     spi_frequency:  1000000    - Only affects hardware SPI interfaces
-#     spi_mode:       0
-#     spi_bit_order:  :msbfirst
-#
-register = Denko::SPI::OutputRegister.new(bus: bus, pin: REGISTER_SELECT_PIN)
-
-# Turn the LED on by setting the corresponding register bit to 1, then writing to it.
-register.bit_set(LED_PIN, 1)
-register.write
-sleep 2
-
-# OutputRegister is a BoardProxy, so DigitalOutput components can use
-# it in place of a board. Use it with an LED instance.
-#
-led = Denko::LED.new(board: register, pin: LED_PIN)
-
-# Blink the LED and sleep the main thread.
-led.blink 0.5
-sleep

data/examples/spi/ssd_through_registers.rb

@@ -1,28 +0,0 @@
-#
-# SevenSegment LED driven though a pair of daisy chained OutputRegisters
-# (74HC595), with some segments on each register.
-#
-require 'bundler/setup'
-require 'denko'
-
-# SPI pins (on board)
-SPI_BIT_BANG_PINS   = { clock: 13, output: 11 }
-REGISTER_SELECT_PIN = 10
-
-# SevenSegment pins (on registers' parallel outputs)
-SEVEN_SEGMENT_PINS = { cathode: 14, a: 10, b: 9, c: 4, d: 2, e: 1, f: 12, g: 13 }
-
-board = Denko::Board.new(Denko::Connection::Serial.new)
-bus   = Denko::SPI::BitBang.new(board: board, pins: SPI_BIT_BANG_PINS)
-
-# Model as one 2-byte (16-bit) OutputRegister, since they're daisy chained.
-# Bit numbering starts at the first register, so bit 0 of the second register
-# is bit 8 of the OutputRegister instance.
-register = Denko::SPI::OutputRegister.new(bus: bus, pin: REGISTER_SELECT_PIN, bytes: 2)
-ssd      = Denko::LED::SevenSegment.new(board: register, pins: SEVEN_SEGMENT_PINS)
-
-# Turn off the ssd on exit.
-trap("SIGINT") { exit !ssd.off }
-
-# Type a character and press Enter to show it on the SevenSegment LED.
-loop { ssd.display(gets.chomp) }

data/examples/spi/two_registers.rb

@@ -1,40 +0,0 @@
-#
-# 2 SPI registers (74HC595 and CD4021B) on the same bus, both acting as
-# BoardProxies for their Subcomponents.
-#
-require 'bundler/setup'
-require 'denko'
-
-# SPI pins (on board)
-SPI_BIT_BANG_PINS   = { clock: 13, input: 12, output: 11 }
-OUT_REGISTER_SELECT = 10
-IN_REGISTER_SELECT  = 9
-
-# LED and Button pins (on their respective registers' parallel pins)
-LED_PIN    = 0
-BUTTON_PIN = 0
-
-board        = Denko::Board.new(Denko::Connection::Serial.new)
-bus          = Denko::SPI::BitBang.new(board: board, pins: SPI_BIT_BANG_PINS)
-out_register = Denko::SPI::OutputRegister.new(bus: bus, pin: OUT_REGISTER_SELECT)
-in_register  = Denko::SPI::InputRegister.new(bus: bus, pin: IN_REGISTER_SELECT, spi_mode: 2)
-
-# LED connected to the output register.
-led = Denko::LED.new(board: out_register, pin: LED_PIN)
-
-# Button connected to the input register.
-button = Denko::DigitalIO::Button.new(board: in_register, pin: BUTTON_PIN)
-
-# Button callbacks.
-button.down do
-  led.on
-  puts "Button pressed"
-end
-
-button.up do
-  led.off
-  puts "Button released"
-end
-
-# Keep main thread alive.
-sleep

data/examples/uart/bit_bang_demo.rb

@@ -1,25 +0,0 @@
-#
-# Bit-bang UART is only used on the Arduino UNO / ATmega328p, because it has no
-# extra hardware UARTs. This also makes a self-loopback test impossible. Connect a
-# second board (Arduino Mega) and use its UART1 to verify bit-bang works on the Uno.
-#
-require 'bundler/setup'
-require 'denko'
-
-uno  = Denko::Board.new(Denko::Connection::Serial.new(device: "/dev/cu.usbserial-1450"))
-mega = Denko::Board.new(Denko::Connection::Serial.new(device: "/dev/cu.usbmodem14101"))
-
-mega_uart1  = Denko::UART::Hardware.new(board: mega, index: 1, baud: 31250)
-uno_bb_uart = Denko::UART::BitBang.new(board: uno, pins: { rx:10, tx:11 }, baud: 31250)
-
-# Write to Uno, read from Mega
-uno_bb_uart.write("Hello World!\n")
-sleep 0.5
-line = mega_uart1.gets
-puts "Mega received from Uno: #{line}"
-
-# Write to Uno, read from Mega
-mega_uart1.write("Goodbye World!\n")
-sleep 0.5
-line = uno_bb_uart.gets
-puts "Uno received from Mega: #{line}"

data/examples/uart/board_passthrough.rb

@@ -1,40 +0,0 @@
-#
-# Example using one board's UART as the transport for a second board, also running Denko.
-#
-# For this example, board1 (direct) is an Arduino Mega. board2 (passthrough) is an Uno,
-# running Denko, with its UART pins (0, 1) connected to the Mega's UART1 pins (18, 19)
-#
-# This isn't 100% reliable. The Rx buffer on the direct board is periodically read, instead
-# of using an interrupt. It can potentially overflow, causing data from the passthrough board
-# to be lost. If flow control data is lost, the connection will halt.
-#
-# Use at your own risk, but for the best possible performance:
-#  1) Avoid long running commands on the direct board (eg. IR output, WS2812 etc.).
-#     These block the CPU enough that the Rx buffer may not be read in time to avoid overflow.
-#  2) Use the lowest practical baud rate on the passthrough board, so the direct board's Rx
-#     buffer takes as long as possible to fill, reducing the chance of data loss.
-#
-require 'bundler/setup'
-require 'denko'
-
-board1 = Denko::Board.new(Denko::Connection::Serial.new)
-
-uart   = Denko::UART::Hardware.new(board: board1, index: 1)
-board2 = Denko::Board.new(Denko::Connection::BoardUART.new(uart, baud: 115200))
-
-led1 = Denko::LED.new(board: board1, pin: 13)
-led1.blink(0.5)
-
-led2 = Denko::LED.new(board: board2, pin: 13)
-led2.blink(0.5)
-
-input = Denko::AnalogIO::Input.new(board: board2, pin: :A0)
-input.smoothing = true
-input.smoothing_size = 10
-# Show input value only if it differs from previous state.
-input.add_callback do |value|
-  puts "A0 value: #{value}" if value != input.state
-end
-input.listen(16)
-
-sleep

data/examples/uart/hardware_loopback.rb

@@ -1,16 +0,0 @@
-#
-# Write to Tx pin of hardware UART1 and read data back on its Rx pin.
-#
-require 'bundler/setup'
-require 'denko'
-
-board = Denko::Board.new(Denko::Connection::Serial.new)
-
-uart = Denko::UART::Hardware.new(board: board, index: 1, baud: 31250)
-
-uart.write("Hello World!\nBye World!\n")
-
-sleep 1
-
-puts uart.gets
-puts uart.gets

data/lib/denko/eeprom/built_in.rb

@@ -1,72 +0,0 @@
-module Denko
-  module EEPROM
-    class BuiltIn
-      include Behaviors::Component
-      include Behaviors::Reader
-      include Behaviors::Lifecycle
-
-      public :state=
-
-      def pin
-        254
-      end
-
-      after_initialize do
-        load
-      end
-
-      def state
-        state_mutex.synchronize { @state ||= Array.new(board.eeprom_length, nil) }
-      end
-
-      def load
-        state.each_slice(128).with_index do |slice, index|
-          read_using -> { board.eeprom_read(index * 128, slice.length) }
-        end
-      end
-
-      def save
-        state_mutex.synchronize do
-          @state.each_slice(128).with_index do |slice, index|
-            board.eeprom_write(index * 128, slice)
-          end
-        end
-        load
-      end
-
-      #
-      # Specific Array-like methods for convenience.
-      #
-      def length; board.eeprom_length; end
-      alias :count :length
-
-      def [](index)
-        state_mutex.synchronize { @state.send :[], index }
-      end
-
-      def []=(index, value)
-        state_mutex.synchronize { @state.send :[]=, index, value }
-      end
-
-      def each(&block)
-        state_mutex.synchronize { @state.send :each, &block }
-      end
-
-      def each_with_index(&block)
-        state_mutex.synchronize { @state.send :each_with_index, &block }
-      end
-
-      def pre_callback_filter(message)
-        address = message.split("-", 2)[0].to_i
-        bytes = message.split("-", 2)[1].split(",").map(&:to_i)
-        {address: address, data: bytes}
-      end
-
-      def update_state(hash)
-        state_mutex.synchronize do
-          @state[hash[:address], hash[:data].length] = hash[:data]
-        end
-      end
-    end
-  end
-end