denko 0.13.0

data/tutorial/04-pwm_led/pwm_led.rb

@@ -0,0 +1,66 @@
+#
+# Example 4: LED Brightness and PWM
+#
+require 'bundler/setup'
+require 'denko'
+
+# Set up the board, connecting with serial over USB
+board = Denko::Board.new(Denko::Connection::Serial.new)
+
+#
+# LEDs don't change brightness much with voltage, but we can vary it with a
+# technique called PWM. PWM sets up a fast (500Hz+) wave on the LED pin. Then we
+# set a duty cycle, telling the LED what fraction of those cycles to be on for.
+#
+# Eg. 1 cycle on, 4 cycles off = 20% duty cycle.
+# This happens so fast that it looks like 20% brightness to the naked eye. 
+# 
+# Depending on your board, some pins may not be PWM capable. Pin 13 on Arduinos
+# isn't, so the earlier example was limited to on/off. There might be a wave
+# symbol printed next to the pin number, but check your documentation. 
+#
+# Note: If you have pins labeled "DAC", do not use them here. DACs generate steady
+# analog voltages, not pulses.
+#
+# Set up LED on a PWM pin. See pwm_led.pdf in this folder for hook-up diagram.
+#
+led = Denko::LED.new(board: board, pin: 11)
+
+# led.pwm_write sets duty cycle from 0 to 255, where 255 maps to 100%.
+[0, 63, 127, 191, 255].each do |duty|
+  led.pwm_write duty
+  percentage = (((duty+1)/256.to_f) * 100).floor
+  print "LED at #{percentage}% duty cycle. Press Enter..."; gets
+end
+puts
+
+# Now let's add the potentiometer from the previous example to control it.
+potentiometer = Denko::AnalogIO::Potentiometer.new(pin: 'A0', board: board)
+
+# Helper method to calculate brightness.
+def map_pot_value(value)
+  # Map 10 bit value into 0 to 1 range.
+  fraction = value / 1023.to_f
+
+  # Linearization hack for audio taper potentiometers.
+  # Adjust k for different tapers. This was an A500K.
+  # k = 5
+  # linearized = (fraction * (k + 1)) / ((k * fraction) + 1)
+
+  # Use this for linear potentiometers instead.
+  linearized = fraction 
+  
+  # Map to the linearized 0-1 range to a 0-255 range for 8-bit PWM.
+  (linearized * 255).floor
+end
+
+# Callback to change brightness.
+potentiometer.on_change do |value|
+  duty = map_pot_value(value)
+  led.pwm_write(duty)
+  percentage = (((duty+1)/256.to_f) * 100).floor
+  print "LED brightness: #{percentage}%  \r"
+end
+
+puts "Turn potentiometer to control the LED brightness. Press Ctrl+C to exit..."
+sleep

data/tutorial/05-rgb_led/rgb_led.rb

@@ -0,0 +1,58 @@
+#
+# Example 5: RGB LED
+#
+require 'bundler/setup'
+require 'denko'
+
+# Set up the board, connecting with serial over USB
+board = Denko::Board.new(Denko::Connection::Serial.new)
+
+#
+# To set up an RGB LED, connect its cathode leg to ground, and each of its 3 color
+# anodes to PWM-capable pin on your board, through a current limiting resistor. Make
+# the green resistor much larger. Since green is usually brighter, we want to limit
+# its current more than the others. See rgb_led.pdf for a hook-up diagram.
+# The values used are 4.7k Ohm for green, 220 Ohm for red and blue.
+#
+# An RGB LED is really 3 individual LEDS in one, sharing a cathode (sometimes anode).
+# We could initailize them separately, or use the RGBLed class, which takes all 3 pins.
+#
+rgb_led = Denko::LED::RGB.new(pins: {red: 11, green: 10, blue: 9}, board: board)
+
+#
+# We can call methods on the RGBLed as a whole. For example, these 8 defined colors.
+#
+print "Press Enter to cycle through RGBLed defined colors..."; gets
+[:red, :green, :blue, :cyan, :yellow, :magenta, :white, :off].each do |color|
+  rgb_led.color = color
+  sleep 0.5
+end
+
+#
+# Or we can access the individual Leds through the #red, #green and #blue methods.
+# This makes an orange color with them.
+#
+rgb_led.red.write 255
+rgb_led.green.write 100
+rgb_led.blue.off
+print "Done. Changed to orange. Press Enter to continue..."; gets
+
+# Let's bring the potentiometer back from the previous examples.
+potentiometer = Denko::AnalogIO::Potentiometer.new(pin: 'A0', board: board)
+
+#
+# In a separate file (rgb_mapping.rb), there are methods to map the 0-1023 values
+# received from the potentiometer into RGB values that create a rough color spectrum.
+#
+require_relative 'rgb_mapping'
+potentiometer.on_change do |pot_value|
+  # Use the mapping methods to calculate values and write them.
+  rgb_led.red.write   map_red(pot_value)
+  rgb_led.green.write map_green(pot_value)
+  rgb_led.blue.write  map_blue(pot_value)
+  
+  print "Potentiometer value: #{pot_value}   \r"
+end
+
+puts "Turn potentiometer to change the RGB LED color. Press Ctrl+C to exit..."
+sleep

data/tutorial/05-rgb_led/rgb_mapping.rb

@@ -0,0 +1,76 @@
+# Maximum and minimum PWM values.
+OUT_MAX = 255
+OUT_MIN = 0
+
+def map_value(value, input_steps, reverse=false)
+  # Map it to a 0-1 range first.
+  fraction = value / input_steps.to_f
+
+  # Reverse if needed.
+  fraction = 1 - fraction if reverse
+  
+  # Map to the output range
+  value = (fraction * OUT_MAX).floor
+  
+  # Clamp within the range just in case.
+  value = OUT_MAX if value > OUT_MAX
+  value = OUT_MIN if value < OUT_MIN
+  value
+end
+
+def map_red(pot_value)
+  # Red full on at low end.
+  return OUT_MAX if pot_value < 171
+  
+  # Red fades out from 171-341
+  if (171..341).include? pot_value
+    return map_value(pot_value - 171, 170, true)
+  end
+  
+  # Red full off in the middle third.
+  return OUT_MIN if (342..682).include? pot_value
+  
+  # Red fades in from 683-853
+  if (683..853).include? pot_value
+    return map_value(pot_value - 683, 170, false)
+  end
+  
+  # Red full on at high end.
+  return OUT_MAX if pot_value > 853
+end
+
+def map_green(pot_value)
+  # Green fades in from 0-171
+  if (0..170).include? pot_value
+    return map_value(pot_value, 170, false)
+  end
+
+  # Green full on from 1/6 to 1/2.
+  return OUT_MAX if (171..511).include? pot_value
+  
+  # Green fades out from 512-682
+  if (512..682).include? pot_value
+    return map_value(pot_value - 512, 170, true)
+  end
+  
+  # Geen full off above 2/3.
+  return OUT_MIN if pot_value > 682
+end
+
+def map_blue(pot_value)
+  # Blue full off until 1/3
+  return OUT_MIN if pot_value < 342
+  
+  # Blue fades in from 342-512 (170 steps)
+  if (342..542).include? pot_value
+    return map_value(pot_value - 342, 170, false)
+  end
+  
+  # Blue full on from 513 to 852
+  return OUT_MAX if (513..852).include? pot_value
+
+  # Blue fades out from 853-1023 (170 steps)
+  if (853..1023).include? pot_value
+    return map_value(pot_value - 853, 170, true)
+  end
+end

data/vendor/board-maps/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/vendor/board-maps/.gitmodules

@@ -0,0 +1,21 @@
+[submodule "cores/avr"]
+	path = cores/avr
+	url = https://github.com/arduino/ArduinoCore-avr.git
+[submodule "cores/esp8266"]
+	path = cores/esp8266
+	url = https://github.com/esp8266/Arduino.git
+[submodule "cores/esp32"]
+	path = cores/esp32
+	url = https://github.com/espressif/arduino-esp32.git
+[submodule "cores/megaavr"]
+	path = cores/megaavr
+	url = https://github.com/arduino/ArduinoCore-megaavr.git
+[submodule "cores/rp2040"]
+	path = cores/rp2040
+	url = https://github.com/earlephilhower/arduino-pico.git
+[submodule "cores/samd"]
+	path = cores/samd
+	url = https://github.com/arduino/ArduinoCore-samd.git
+[submodule "cores/sam3x"]
+	path = cores/sam3x
+	url = https://github.com/arduino/ArduinoCore-sam