Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/m1ari/ruby-spi
Ruby SPI gem
https://github.com/m1ari/ruby-spi
chip gem raspberry-pi raspberrypi ruby spi
Last synced: 2 months ago
JSON representation
Ruby SPI gem
- Host: GitHub
- URL: https://github.com/m1ari/ruby-spi
- Owner: m1ari
- License: mit
- Created: 2017-03-15T17:30:02.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-07-30T15:36:52.000Z (over 6 years ago)
- Last Synced: 2024-10-02T05:02:10.542Z (3 months ago)
- Topics: chip, gem, raspberry-pi, raspberrypi, ruby, spi
- Language: Ruby
- Size: 10.7 KB
- Stars: 3
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# SPI
This gem aims to provide a Unified method of talking to SPI devices on a variety of hardware. This is mainly aimed at a range of Small Board Computers (SBCs) such as the Raspberry Pi and C.H.I.P. computers.
Currently only the Linux spidev kernel interface is implimented however the code is designed to make adding other drivers a simple process. It should then be possible to choose the correct driver for the hardware without having to re-write code.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'spi'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install spi
## Usage
You may need to enable the SPI device on your hardware and/or load the kernel module.
On the Raspberry Pi SPI can be enabled through raspi-cofig
On the C.H.I.P. SPI can be loaded by importing the SPI DTB
After doing this you should find one or more devices in /dev
```bash
user@device:~ $ ls /dev/spi*
/dev/spidev32766.0
```
To use the default (SPIdev) driver you can specify
```ruby
require "bundler/setup"
require "spi"
s=SPI.new(device: '/dev/spidev32766.0')
s.speed=500000
s.xfer(txdata: [0x10,0x00])
```
Currently SPIdev is the only driver.
Simple Testing of just the SPIdev Driver with an RFM69
```ruby
require "bundler/setup"
require "spi"
require 'spi/driver/spidev'
s=SPI::Driver::SPIdev.new(device: '/dev/spidev32766.0')
s.speed=500000
s.xfer(txdata: [0x10,0x00])
```
This should result in a 2 byte array with the 2nd value reporting 36 (0x24)
## Enabling SPI
### C.H.I.P.
https://bbs.nextthing.co/t/using-spi-on-chip-without-kernel-hack/15395
In simple terms (assuming a more recent (december 2016 or later 4.4 image)
```bash
sudo mkdir -p /sys/kernel/config/device-tree/overlays/spi
sudo cp /lib/firmware/nextthingco/chip/sample-spi.dtbo /sys/kernel/config/device-tree/overlays/spi/dtbo
```
### Raspberry Pi
## Development
After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
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).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/m1ari/ruby-spi.