# GrovePi
[](https://travis-ci.org/fhunleth/grovepi)
[](https://ebertapp.io/github/fhunleth/grovepi)
Use the [GrovePi][dexter] and sensors in Elixir
on a Raspberry Pi. If you have a Beaglebone Green or other port that has direct
access to sensors (rather than going through a GrovePi), take a look at
[nerves_grove](https://github.com/bendiken/nerves_grove). This library will
likely go through many changes in the coming months and possibly get merged into
`nerves_grove` should there be enough overlap.
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `grovepi` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:grovepi, "~> 0.1.0"}]
end
```
But for now, add this:
```elixir
def deps do
[{:grovepi, github: "fhunleth/grovepi", branch: "master"}]
end
```
GrovePi uses [elixir_ale][ale] for I2C communication.
On some platforms `elixir_ale` does not compile so you may need to
configure a stand in. Due to this limitation `elixir_ale` is not included
except in the production environment. If you need it outside of
production be sure to add it to your dependencies.
```elixir
def deps do
[
{:grovepi, "~> 0.1.0"},
{:elixir_ale, "~> 0.6"},
]
end
```
If you would like to use a stub in your tests you can configure
a module to be used for I2C in you configuration.
```elixir
config :grovepi, :i2c, MyI2C
```
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/grovepi][docs].
Contributions
=============
We welcome contributions to tackle issues in GrovePi.
## Setup
First fork the repository and fetch your own copy
~~~bash
mix deps.get
mix test
~~~
## Submitting a Pull Request
1. [Fork the repository.][fork]
2. [Create a topic branch.][branch]
3. Add tests for your unimplemented feature or bug fix.
4. Run `mix test`. If your tests pass, return to step 3.
5. Implement your feature or bug fix.
6. Run `mix test`. If your tests fail, return to step 5.
7. Commit, and push your changes.
8. [Submit a pull request.][pr]
## Running Tests
All tests can be run with `mix test` or a single test file can be run
with `mix test path/to/file_test.exs`.
[dexter]: https://www.dexterindustries.com/grovepi/
[ale]: https://hex.pm/packages/elixir_ale
[docs]: https://hexdocs.pm/grovepi
[fork]: https://help.github.com/fork-a-repo/
[branch]:
https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/
[pr]: https://help.github.com/articles/creating-a-pull-request/
