tamashii-agent 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e9ec90a332693cf4e81bc2c7425eca46d8dc7d2
-  data.tar.gz: 970f014149a4cf6f427e8217323414be5f80a744
+  metadata.gz: f9d22e0f412ffe228a1d91b28c78da5108f60024
+  data.tar.gz: 686f0b637d4a6a941b06fff85df869b568fb4f0d
 SHA512:
-  metadata.gz: 4b7035125ae4da75c9bae4cb2cca8b601a1215a57d0da0654195b7611607e11a2577b1e54fcdbe607b914edf29173aa360bb52e5a4e29f140e8cb650de7114a1
-  data.tar.gz: 99a438cc526180f5cf261f2a7f9582733251f9285cd6ed489e94bf388907efa1e409cbba77c1460ee513b1fed008ddf604c8ace5585e9692f8238af95b15c7c4
+  metadata.gz: 59b573c6b0a744a33c19d1424d62abb05173df4e1fa546c48ec5bb8d253c65d4ba3c34fef3217c7113181968e396b9ca9ece0d40ffa576e04034684e36613638
+  data.tar.gz: 7cdd4e93f41cd4e66e640c8636917f2c4c93b03a50c5e591a73677c33c1911e23c7702411c0c80334ce1e311f8cfa43562b73fb9dc500f889dfe791bbefa93ab

data/README.md

@@ -1,38 +1,251 @@
-# Tamashii::Agent
+Tamashii Agent [![Gem Version](https://badge.fury.io/rb/tamashii-agent.svg)](https://badge.fury.io/rb/tamashii-agent) 
+===
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tamashii/agent`. To experiment with that code, run `bin/console` for an interactive prompt.
+Tamashii Agent is the client gem opposites to the server gem [Tamashii Manager](https://github.com/tamashii-io/tamashii-manager).
+
+The Tamashii Agent runs on Raspberry PI. It manages the IoT components on the device and provides high-level API to let developers control the components easily.
+
+It is designed to integrate the devices into internet. With the help of [Tamashii Manager](https://github.com/tamashii-io/tamashii-manager), we can create IoT applications with Rails. The networking is based on [Tamashii Client](https://github.com/tamashii-io/tamashii-client).
+
+## Hardware Requirement
+
+Tamashii Agent is designed and tested on Raspberry PI 3 (running Raspbian Jessie). This readme will assume you are using the same version of Raspberry PI (newer versions should also be supported, however the configuration may differ).
+
+You need to install this gem on a real device to make it work. Following sections assume you are operating on a correctly configured Raspberry PI. 
+
+>**Note**: we also provide **dummy** devices. These devices will simulate the behavior of those real devices such as RFID readers and buzzers. With them, the Tamashii Agent doesn't need to be executed on Raspberry PI. You can also run Tamashii Agent on non-Raspberry PI devices such as desktop Linux or Mac. Please refer to [this section](#dummy-devices).
+
+Tamashii Agent comes with some common hardware-related modules. They wrap the low-level operation of the devices. 
+
+You can choose which components to be integrated into your application in [configuration file](#configuration-and-execution). Currently it supports the following hardware that can be attached to a Raspberry PI:
+
+- RFID/NFC modules
+    - MFRC522 RFID reader (SPI)
+    - PN532 NFC module (UART)
+- LCD Displays
+    - LCM 1602 (I2C)
+- Buzzers
+    - DC buzzer using PWM
+
+For pin layout of each component module, please refer to [this page](https://github.com/tamashii-io/tamashii-agent/tree/master/lib/tamashii/agent/device).
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add the following code to your `Gemfile`:
 
 ```ruby
 gem 'tamashii-agent'
 ```
 
 And then execute:
+```
+$ bundle install
+```
 
-    $ bundle
+Or install it yourself with:
+```
+$ gem install tamashii-agent
+```
 
-Or install it yourself as:
+After installation, a new command line tool is provided as `tamashii-agent`. Get more information by executing 
+```
+$ tamashii-agent -h
+```
+
+### Daemonize 
+
+Although it is okay to run Tamashii Agent as a usual ruby program, Tamashii Agent usually runs as a system daemon on the Raspberry PI.
+
+This gem also provides a simple daemon installation for `systemd`. 
+If you are using Raspberry PI running `systemd` (such as Raspbian Jessie), you can install daemon scripts by executing:
+```
+$ tamashii-agent --install-systemd
+```
+
+This will generate a `systemd` script `/etc/systemd/system/tamashii-agent.service` and a default configuration file `/etc/tamashii-agent-config.rb`. Modify them to match your need. 
 
-    $ gem install tamashii-agent
 
 ## Usage
 
-TODO: Write usage instructions here
+### Configuration and Execution
+
+Whether the Tamashii Agent is running as system daemon or simply as a ruby program, we need to write a configuration file for it. The default configuration generated by `tamashii-agent --install-systemd` is:
+
+```ruby
+Tamashii::Agent::config do
+  # these connection configuration will be forwarded to Tamashii Client
+  # please refer to configuration of Tamashii Client
+  use_ssl false
+  host "localhost"
+  port 3000
+  entry_point "/tamashii"
+  # where to output logs. Default is STDOUT
+  log_file "/var/log/tamashii-agent.log"
+  # the log level. Default is :DEBUG
+  log_level :INFO
+  # the authentication information. Must be the same as those in Tamashii Manager
+  auth_type :token
+  token "SECRET_TOKEN"
+end
+```
+
+The configuration above does not drive any extra components such as NFC readers or buzzers. It only establishs a connection to the [Tamashii Manager](https://github.com/tamashii-io/tamashii-manager) running on `localhost:3000`. 
+
+- To run as system daemon:
+    - Put the configuration file in `/etc/tamashii-agent-config.rb`. 
+    - Restart the agent by 
+    
+    ```
+    $ sudo systemctl restart tamashii-agent
+    ```
+
+- To execute Tamashii Agent as a usual ruby program
+    - Specify the path to the configuration file by `-C` option. 
+    - For example, to load the configuration file in `/path/to/tamashii-agent-config.rb`:
+
+    ```
+    $ sudo tamashii-agent -C /path/to/tamashii-agent-config.rb
+    ```
+
+> Note: many hardware operations on Raspberry PI require root permission to access the IO. Don't forget to use `sudo` to run the agent command.
+
+### Simple Example for Testing Tamashii Agent
+
+The following program is a simple server based on [Tamashii Manager](https://github.com/tamashii-io/tamashii-manager). In this example, the Agent will play a beep sound when swiping the RFID card on the reader. 
+
+> **Note**: you need to connect a RFID reader (either MFRC522 or PN532) and a DC buzzer to your Raspberry PI. Please refer to [this page](https://github.com/tamashii-io/tamashii-agent/tree/master/lib/tamashii/agent/device) about the setup details. 
+
+> **Note**: the code below requires Tamashii Manager correctly installed on your system. You may need to install some dependencies such as `redis`.
+
+```ruby
+class MyPacketHook  < Tamashii::Hook
+  def call(request_packet)
+    # we only cares about RFID NUMBER from agent
+    if request_packet.type == Tamashii::Type::RFID_NUMBER
+      # fetch client infomation from env
+      client = @env[:client]
+
+      # parse data in the packet (in json format)
+      json = JSON.parse(request_packet.body)
+      packet_id = json['id']
+      card_id = json['ev_body']
+
+      # build response in json format
+      type = Tamashii::Type::RFID_RESPONSE_JSON
+      body = { 
+        id: packet_id,
+        ev_body: {
+          auth: true # true for 1 beep, false for 3 beeps
+        }.to_json
+      }.to_json
+
+      # build packet
+      response_packet = Tamashii::Packet.new(
+        type, client.tag, body
+      )   
+      # send to client
+      client.send(response_packet.dump)
+      # return true means we have already handled this packet
+      return true
+    else
+      # return false so that the default handler can be executed
+      return false
+    end 
+  end 
+end
+
+Tamashii::Manager.config do |config|
+  config.port = 3000
+  # this pre-shared token can exclude the unwanted access
+  config.auth_type = :token
+  config.token = 'abc123'
+end
+
+Tamashii::Resolver.config do
+  # forward the packet to our hook
+  hook MyPacketHook
+end
+```
+
+Save the code above as `manager_config.rb`, then execute the following command to boot up Tamashii Manager.
+```
+$ tamashii-manager -C ./manager_config.rb
+```
+
+Now let's write a simple configuration for Tamashii Agent: 
+```ruby
+Tamashii::Agent.config do
+  # The token must be same as server's
+  auth_type :token
+  token "abc123"
+  # Remember to change to your Tamashii Manager's hostname or IP!
+  host "tamashii.manager.local"
+  port 3000
+
+  # components to use
+  # the buzzer to play 'beep' sound. Assume the PWM buzzer is connected at pin 19
+  add_component :buzzer, 'Buzzer', device: 'PwmBuzzer', pin: 19
+  
+  # card readers
+  # assume the PN532 NFC module is connected via UART interface
+  add_component :card_reader_felica, 'CardReader', device: 'Pn532Uart'
+  # uncomment following line if you are using MFRC522 via SPI interface
+  # add_component :card_reader_mfrc, 'CardReader', device: 'Mfrc522Spi'
+end
+```
+
+Save the code above as `agent_config.rb`, then execute following command to boot up Tamashii Agent.
+```
+$ sudo tamashii-agent -C ./agent_config.rb
+```
+
+Now you can swipe a card on the reader! You should  hear a beep sound if everything works fine.
+
+## Dummy Devices
+
+Although the Tamashii Agent is designed to run on Raspberry PI, if you need to develop applications on non-Raspberry PI platforms, you can use the **Dummy** devices. Dummy devices simulate the behavior of RFID readers and buzzers. To use them, you need to specify the `Dummy` devices in the configuration file. 
+
+For example, in the simple example mentioned above, you can change the configuration so that the example can run on non-Raspberry PI platforms:
+
+```ruby
+Tamashii::Agent.config do
+  # The token must be same as server's
+  auth_type :token
+  token "abc123"
+  # Remember to change to your Tamashii Manager's hostname or IP!
+  host "tamashii.manager.local"
+  port 3000
+
+  # dummy devices
+  add_component :buzzer, 'Buzzer', device: 'Dummy'
+  add_component :card_reader, 'CardReader', device: 'Dummy'
+end
+```
+
+The dummy buzzers will print the "beep sound" into the log file, while the dummy card reader generates random card uids periodically.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+To get the source code
+
+    $ git clone git@github.com:tamashii-io/tamashii-agent.git
+
+Initialize the development environment
+
+    $ ./bin/setup
+
+Run the spec
+
+    $ rspec
+
+Installation the version of development on localhost
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+    $ bundle exec rake install
 
-## Contributing
+## Contribution
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/lctseng/tamashii-agent.
+Please report to us on [Github](https://github.com/tamashii-io/tamashii-agent) if there is any bug or suggested modified.
 
-Contributed by [5xruby Inc.](https://5xruby.tw/)
+The project was developed by [5xruby Inc.](https://5xruby.tw/)
 

data/lib/tamashii/agent/common/loggable.rb

@@ -10,7 +10,11 @@ module Tamashii
         end
 
         def progname
-          @progname ||= ("%-10s" % self.class.to_s.split(":")[-1])
+          @progname ||= ("%-10s" % display_name)
+        end
+
+        def display_name
+          self.class.to_s.split(":")[-1]
         end
       end
     end

data/lib/tamashii/agent/component.rb

@@ -108,6 +108,10 @@ module Tamashii
       def get_device_class_name(device_name)
         raise NotImplementedError
       end
+
+      def display_name
+        @name
+      end
     end
   end
 end

data/lib/tamashii/agent/device/README.md

@@ -0,0 +1,101 @@
+Device Setup
+===
+
+This page describes the connection of hardware supported by Tamashii Agent.
+Following figure shows a typical Raspberry PI and pins on it. 
+
+![Raspberry Pins](https://tamashii.io/images/devices/rpi_pins.png)
+
+## Buzzers
+
+### PWM buzzer
+
+![PWM Buzzer](https://tamashii.io/images/devices/pwm_buzzer.jpg)
+
+- Connect positive wire (the red one) to the PWM GPIO pin
+    - Example in figure: pin 35 (GPIO 19)
+    - The **GPIO number** (not the pin number) should be specify in the configuration
+    ```ruby
+    add_component :buzzer, 'Buzzer', device: 'PwmBuzzer', pin: 19
+    ```
+- Connect the negative wire (the black one) to the GND pin
+    - Example in figure: pin 34 (GND)
+
+## Card Readers
+
+### MFRC522 via SPI
+
+![MFRC522 SPI](https://tamashii.io/images/devices/mfrc522_spi.jpg)
+- Connect corresponding pins from reader module to Raspberry PI
+    - reader NSS to pin 24 (SPI0 CS0)
+    - reader SCK to pin 23 (SPI0 SCLK)
+    - reader MOSI to pin 19 (MOSI)
+    - reader MISO to pin 21 (MISO)
+    - reader GND to pin 20 (GND)
+    - reader RST522 to pin 18 (GPIO 24)
+        - The RESET pin
+        - Could be changed in configuration
+        ```ruby
+        add_component :card_reader_mfrc, 'CardReader', device: 'Mfrc522Spi', reset_pin: 24
+        ```
+    - reader VIN to pin 4(5V PWR)
+
+### PN532 via UART
+
+![PN532 UART](https://tamashii.io/images/devices/pn532_uart.jpg)
+- Connect corresponding pins from reader module to Raspberry PI
+    - reader GND to pin 6 (GND)
+    - reader VIN to pin 1 (3.3V PWR)
+    - reader **TX** to pin 10 (UART0 **RX**)
+    - reader **RX** to pin 8 (UART0 **TX**)
+- On Raspberry 3 (Jessie), the Bluetooth module occupied the UART interface `/dev/ttyAMA0`. Before you using PN532 via UART, you need to disable Bluetooth first.
+    - Disable serial console and enable serial hardware using `rasp-config`
+        - `rasp-config` => `Interfacing Options` => `Serial`
+        - Disable serial login shell
+        - Enable serial port hardware
+    - Disable Bluetooth
+        - Add following line at the end of `/boot/config.txt`
+            - This will also make `/dev/serial0` points to `/dev/ttyAMA0`
+            ```
+            dtoverlay=pi3-disable-bt
+            ```
+        - Disable Bluetooth services
+            ```
+            sudo systemctl stop hciuart
+            sudo systemctl disable hciuart
+            ```
+    - Install `libnfc`, refer to [this page](https://www.raspberrypi.org/forums/viewtopic.php?t=78966)
+        - We do not need the extra steps after `sudo make install`
+    - Create or modify `libnfc` configuration file. Modify or create one of the following files:
+        - `/etc/nfc/libnfc.conf`
+            ```
+            device.name = "PN532 board via UART"
+            device.connstring = "pn532_uart:/dev/ttyAMA0"
+            ``` 
+        
+        - or `/etc/nfc/devices.d/pn53x_uart.conf`
+            ```
+            name = "PN532 board via UART"
+            connstring = pn532_uart:/dev/ttyAMA0
+            ```
+
+
+        
+    - Remove `console=serial0` from `/boot/cmdline.txt`, if any.
+    - Reboot
+ 
+
+## LCDs
+
+## LCM 1602 via I2C
+
+![LCM602 I2C](https://tamashii.io/images/devices/lcm1602_i2c.jpg)
+
+- Connect corresponding pins from lcd module to Raspberry PI
+    - lcd GND to pin 9 (GND)
+    - lcd VCC to pin 2 (5V PWR)
+    - lcd SDA to pin 3 (SDA)
+    - lcd SCL to pin 5 (SCL)
+- Enable I2C interface on your Raspberry PI
+    - Using `rasp-config` => `Interfacing Options` => `I2C`
+    - If successful, you should able to see `/dev/i2c-1` under `/dev` on Raspberry PI 

data/lib/tamashii/agent/device/buzzer/{gpio_buzzer.rb → pwm_buzzer.rb}

@@ -5,9 +5,8 @@ module Tamashii
   module Agent
     module Device
       module Buzzer
-        class GpioBuzzer < Base
+        class PwmBuzzer < Base
 
-          DEFAULT_PIN = 18
           SHORT_PLAY_TIME = 0.2
           LONG_PLAY_TIME = 0.5
           REPEAT_INTERVAL = 0.1
@@ -34,6 +33,10 @@ module Tamashii
             play_repeat_long(3)
           end
 
+          def default_pin
+            19
+          end
+
           private
 
           def stop
@@ -41,10 +44,7 @@ module Tamashii
           end
 
           def setup_pwm
-            unless pin = @options[:pin]
-              logger.warn "No GPIO pin given. Using default: #{DEFAULT_PIN}"
-              pin = DEFAULT_PIN
-            end
+            pin = fetch_option(:pin, default_pin)
             @pwm = PiPiper::Pwm.new pin: pin #, mode: :markspace
             @pwm.off
             @pwm.value = 1.0

data/lib/tamashii/agent/device/card_reader/mfrc522_spi.rb

@@ -9,7 +9,11 @@ module Tamashii
 
           def initialize(*args)
             super
-            @reader = MFRC522.new
+            @reader = MFRC522.new(fetch_option(:reset_pin, default_reset_pin))
+          end
+
+          def default_reset_pin
+            24
           end
 
           def poll_uid

data/lib/tamashii/agent/device/card_reader/pn532_uart.rb

@@ -9,7 +9,7 @@ module Tamashii
           def initialize(*args)
             super
             @ctx = NFC::Context.new
-            @dev = @ctx.open "pn532_uart:#{fetch_path}"
+            @dev = @ctx.open "pn532_uart:#{fetch_option(:path, default_path)}"
             @card_type = @options[:card_type] || :felica
             logger.info "Card type enabled: #{@card_type}"
           end
@@ -18,16 +18,6 @@ module Tamashii
             "/dev/ttyAMA0"
           end
 
-          def fetch_path
-            if @options.has_key?(:path)
-              path = @options[:path]
-            else
-              path = default_path
-              logger.warn "No path specified. Use default path: #{path}"
-            end
-            path
-          end
-
           def poll_uid
             tag = @dev.poll(@card_type)
             if tag && !tag.is_a?(Integer)

data/lib/tamashii/agent/device/device_base.rb

@@ -1,3 +1,4 @@
+require 'pi_piper'
 require 'tamashii/agent/common'
 
 module Tamashii
@@ -6,6 +7,8 @@ module Tamashii
       class DeviceBase
         include Common::Loggable
 
+        class OptionNotFoundError < RuntimeError; end
+
         def initialize(component, options = {})
           @component = component
           @options = options
@@ -14,6 +17,30 @@ module Tamashii
         def shutdown
           logger.warn "Device '#{self.class}' does not implement a shutdown method"
         end
+
+        def fetch_option(name, default_value)
+          fetch_option!(name)
+        rescue OptionNotFoundError => e
+          logger.warn "No #{name} specified in options. Use default #{name}: #{default_value}"
+          return default_value
+        end
+
+        def fetch_option!(name)
+          if @options.has_key?(name)
+            return @options[name]
+          else
+            raise OptionNotFoundError, "#{name} not found in option"
+          end
+        end
+
+        def unexport_pin(pin_number)
+          raise ArgumentErrorm, "pin number must be a integer" unless pin_number.is_a? Integer
+          if PiPiper::Platform.driver == PiPiper::Bcm2835
+            PiPiper::Platform.driver.unexport_pin(pin_number)
+          else
+            logger.warn "Underlying driver #{PiPiper::Platform.driver} does not support unexporting"
+          end
+        end
       end
     end
   end

data/lib/tamashii/agent/device/keyboard/base.rb

@@ -0,0 +1,159 @@
+require 'concurrent'
+require 'tamashii/agent/device/device_base'
+
+module Tamashii
+  module Agent
+    module Device
+      module Keyboard
+        class Base < DeviceBase
+
+          def initialize(*args)
+            super(*args)
+            initialize_hardware
+            @number_of_keys = fetch_option(:number_of_keys, default_number_of_keys)
+            @watcher_mode = fetch_option(:watch, default_watch)
+            @watcher_stopping = Concurrent::AtomicBoolean.new(false)
+            if @watcher_mode
+              initialize_watcher
+              start_watcher_thread
+            end
+          end
+
+          def default_number_of_keys
+            raise NotImplementedError
+          end
+
+          def default_watch
+            true
+          end
+
+          def polling_interval
+            0.1
+          end
+
+          def initialize_hardware
+            logger.warn "Device #{@name} does not implement hardware initialize code"
+          end
+
+          def finalize_hardware
+            logger.warn "Device #{@name} does not implement hardware finalize code"
+          end
+
+          def initialize_watcher
+            @last_keys_state = {}
+            @current_keys_state = {}
+            @current_key = Concurrent::AtomicFixnum.new(-1)
+            @callbacks = {}
+          end
+
+          def add_callback(event, callable)
+            if @watcher_mode
+              @callbacks[event] = callable
+            else
+              puts "Callbacks are only available in watcher mode!"
+            end
+          end
+
+          def on_key_down(callable = nil, &block)
+            add_callback(:down, callable || block)
+          end
+
+          def on_key_up(callable = nil, &block)
+            add_callback(:up, callable || block)
+          end
+
+          def on_key_pressed(callable = nil, &block)
+            add_callback(:pressed, callable || block)
+          end
+
+          def watcher_stopping?
+            @watcher_stopping.true?
+          end
+
+          def start_watcher_thread
+            @watcher_thread = Thread.new { watcher_loop }
+          end
+
+          def watcher_loop
+            puts "watcher started"
+            loop do
+              if watcher_stopping?
+                break
+              end
+              sleep polling_interval
+              record_key_state
+              read_key
+              process_callbacks
+            end
+            puts "watcher thread terminated normally"
+          end
+
+          def process_callbacks
+            @number_of_keys.times do |key|
+              if @current_keys_state[key]
+                if @last_keys_state[key]
+                  @callbacks[:pressed]&.call(key)
+                else
+                  @callbacks[:down]&.call(key)
+                end
+              else
+                if @last_keys_state[key]
+                  @callbacks[:up]&.call(key)
+                end
+              end
+            end
+          end
+
+          def record_key_state
+            @number_of_keys.times do |key|
+              @last_keys_state[key] = @current_keys_state[key]
+            end
+          end
+
+          def stop_watcher_thread
+            if !@watcher_thread.join(3)
+              @watcher_thread.exit
+              puts "watcher thread killed forcefully"
+            end
+          end
+
+          def poll_key
+            if @watcher_mode
+              @current_key.value >= 0 ? @current_key.value : nil
+            else
+              sleep polling_interval
+              read_key
+            end
+          end
+
+          def shutdown
+            @watcher_stopping.make_true
+            if @watcher_mode
+              stop_watcher_thread
+            end
+            finalize_hardware
+          end
+
+          def mark_key_up(key)
+            return unless @watcher_mode
+            if @current_key.value == key
+              # remove current key
+              @current_key.value = -1
+            end
+            @current_keys_state[key] = false
+          end
+
+          def mark_key_down(key)
+            return unless @watcher_mode
+            @current_key.value = key
+            @current_keys_state[key] = true
+          end
+
+          def read_key
+            raise NotImplementedError, "read_key"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tamashii/agent/device/keyboard/dummy.rb

@@ -0,0 +1,43 @@
+require 'pi_piper'
+require 'tamashii/agent/device/keyboard/base'
+
+module Tamashii
+  module Agent
+    module Device
+      module Keyboard
+        class Dummy < Base
+          def initialize_hardware
+            @last_report = Time.now
+            logger.debug "Initialized"
+          end
+          
+          def finalize_hardware
+            logger.debug "Finalized"
+          end
+          
+          def default_number_of_keys
+            8
+          end
+
+          def read_key
+            if (Time.now - @last_report) > (3 + rand)
+              @last_report = Time.now
+              key = rand(@number_of_keys)
+              logger.debug "Fake key generated: #{key}"
+              @number_of_keys.times do |testing_key|
+                if testing_key == key
+                  mark_key_down(testing_key)
+                else
+                  mark_key_up(testing_key)
+                end
+              end
+              return key
+            else
+              return nil
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tamashii/agent/device/keyboard/ttp229_serial.rb

@@ -0,0 +1,61 @@
+require 'pi_piper'
+require 'tamashii/agent/device/keyboard/base'
+
+module Tamashii
+  module Agent
+    module Device
+      module Keyboard
+        class TTP229Serial < Base
+
+          HALF_BIT_TIME=0.001
+
+          def initialize_hardware
+            @scl_pin = PiPiper::Pin.new(pin: fetch_option(:scl_pin, default_scl_pin), direction: :out)
+            @sdo_pin = PiPiper::Pin.new(pin: fetch_option(:sdo_pin, default_sdo_pin), direction: :in)
+            @scl_pin.on
+            sleep(HALF_BIT_TIME)
+          end
+
+          def polling_interval
+            10*HALF_BIT_TIME
+          end
+
+          def default_number_of_keys
+            8
+          end
+
+          def default_scl_pin
+            17
+          end
+
+          def default_sdo_pin
+            4
+          end
+          
+          def finalize_hardware
+            unexport_pin(fetch_option(:scl_pin, default_scl_pin))
+            unexport_pin(fetch_option(:sdo_pin, default_sdo_pin))
+          end
+
+          def read_key
+            current_key = nil
+            @number_of_keys.times do |key|
+              @scl_pin.off
+              sleep(HALF_BIT_TIME)
+              @sdo_pin.read
+              if @sdo_pin.off?
+                current_key = key
+                mark_key_down(key)
+              else
+                mark_key_up(key)
+              end
+              @scl_pin.on
+              sleep(HALF_BIT_TIME)
+            end
+            current_key
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tamashii/agent/device/lcd/lcm1602_i2c.rb

@@ -58,29 +58,9 @@ module Tamashii
 
           private
 
-          def fetch_address
-            if @options.has_key?(:address)
-              address = @options[:address]
-            else
-              address = default_address
-              logger.warn "No address specified. Use default address: #{address.to_s(16)}"
-            end
-            address
-          end
-
-          def fetch_path
-            if @options.has_key?(:path)
-              path = @options[:path]
-            else
-              path = default_path
-              logger.warn "No path specified. Use default path: #{path}"
-            end
-            path
-          end
-
           def initialize_lcd
-            @lcd = I2C.create(fetch_path)
-            @address = fetch_address
+            @lcd = I2C.create(fetch_option(:path, default_path))
+            @address = fetch_option(:address, default_address)
             @backlight = @options.fetch(:backlight, true)
 
             byte(0x33, OP_CMD)

data/lib/tamashii/agent/keyboard.rb

@@ -0,0 +1,37 @@
+require 'tamashii/agent/component'
+require 'tamashii/agent/event'
+
+module Tamashii
+  module Agent
+    class Keyboard < Component
+      def initialize(name, master, options = {})
+        options[:watch] = true # Force enable watch mode
+        super
+        @kb = initialize_device
+        @kb.on_key_down do |key|
+          logger.debug "Key down: #{key+1}"
+          @master.send_event(Event.new(Event::LCD_MESSAGE, "Key pressed: #{key+1} "))
+        end
+      end
+
+      def default_device_name
+        'Dummy'
+      end
+
+      def get_device_class_name(device_name)
+        "Keyboard::#{device_name}"
+      end
+
+      # override
+      def process_event(event)
+        # silent is gold
+      end
+
+      def clean_up
+        super
+        @kb.shutdown
+      end
+    end
+  end
+end
+

data/lib/tamashii/agent/master.rb

@@ -3,10 +3,9 @@ require 'tamashii/agent/networking'
 require 'tamashii/agent/lcd'
 require 'tamashii/agent/buzzer'
 require 'tamashii/agent/card_reader'
+require 'tamashii/agent/keyboard'
 require 'tamashii/agent/event'
 
-require 'thread'
-
 module Tamashii
   module Agent
     class Master < Component

data/lib/tamashii/agent/version.rb

@@ -1,5 +1,5 @@
 module Tamashii
   module Agent
-    VERSION = "0.3.1"
+    VERSION = "0.3.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tamashii-agent
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
 platform: ruby
 authors:
 - 蒼時弦也
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-11 00:00:00.000000000 Z
+date: 2017-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -292,14 +292,18 @@ files:
 - lib/tamashii/agent/common/loggable.rb
 - lib/tamashii/agent/component.rb
 - lib/tamashii/agent/config.rb
+- lib/tamashii/agent/device/README.md
 - lib/tamashii/agent/device/buzzer/base.rb
 - lib/tamashii/agent/device/buzzer/dummy.rb
-- lib/tamashii/agent/device/buzzer/gpio_buzzer.rb
+- lib/tamashii/agent/device/buzzer/pwm_buzzer.rb
 - lib/tamashii/agent/device/card_reader/base.rb
 - lib/tamashii/agent/device/card_reader/dummy.rb
 - lib/tamashii/agent/device/card_reader/mfrc522_spi.rb
 - lib/tamashii/agent/device/card_reader/pn532_uart.rb
 - lib/tamashii/agent/device/device_base.rb
+- lib/tamashii/agent/device/keyboard/base.rb
+- lib/tamashii/agent/device/keyboard/dummy.rb
+- lib/tamashii/agent/device/keyboard/ttp229_serial.rb
 - lib/tamashii/agent/device/lcd/base.rb
 - lib/tamashii/agent/device/lcd/dummy.rb
 - lib/tamashii/agent/device/lcd/lcm1602_i2c.rb
@@ -310,6 +314,7 @@ files:
 - lib/tamashii/agent/handler/lcd.rb
 - lib/tamashii/agent/handler/remote_response.rb
 - lib/tamashii/agent/handler/system.rb
+- lib/tamashii/agent/keyboard.rb
 - lib/tamashii/agent/lcd.rb
 - lib/tamashii/agent/master.rb
 - lib/tamashii/agent/networking.rb