Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mnishiguchi/i2c_server
Wrap an I2C device in a separate process
https://github.com/mnishiguchi/i2c_server
elixir i2c i2c-bus i2c-device nerves nerves-project
Last synced: about 2 months ago
JSON representation
Wrap an I2C device in a separate process
- Host: GitHub
- URL: https://github.com/mnishiguchi/i2c_server
- Owner: mnishiguchi
- License: mit
- Created: 2021-04-27T21:42:54.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-08-26T12:10:56.000Z (over 3 years ago)
- Last Synced: 2024-10-12T04:32:57.865Z (2 months ago)
- Topics: elixir, i2c, i2c-bus, i2c-device, nerves, nerves-project
- Language: Elixir
- Homepage:
- Size: 80.1 KB
- Stars: 9
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# I2C Server
[](https://hex.pm/packages/i2c_server)
[](https://hexdocs.pm/i2c_server)
[](https://github.com/mnishiguchi/i2c_server/actions/workflows/ci.yml)
I2C Server wraps [`Circuits.I2C`](https://hexdocs.pm/circuits_i2c/readme.html) [reference](http://erlang.org/documentation/doc-6.0/doc/reference_manual/data_types.html#id67235) in a [`GenServer`](https://hexdocs.pm/elixir/GenServer.html), creating a separate
process per [I2C](https://en.wikipedia.org/wiki/I%C2%B2C) bus. I2C bus processes are
identified with a bus name (e.g., `"i2c-1"`).
## Installation
Just add `i2c_server` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:i2c_server, "~> 0.2"}
]
end
```
## Usage
```elixir
# Get a PID for the device at the address 0x77 on the "i2c-1" bus
iex> {:ok, device} = I2cServer.start_link(bus_name: "i2c-1", bus_address: 0x77)
#PID<0.233.0>
# Write 0xff to the register 0x8A
iex> I2cServer.write(device, [0x8A, <<0xff>>])
:ok
# Read 3 bytes
iex> I2cServer.read(device, 3)
:ok
# Read 3 bytes from the register 0xE1
iex> I2cServer.write_read(device, 0xE1, 3)
{:ok, <<0, 0, 0>>}
# Do multiple operations sequentially blocking the bus worker process
iex> I2cServer.bulk(device, [
...> {:write, [0xBA]},
...> {:sleep, 10},
...> {:write, [0xAC, <<0x33, 0x00>>]},
...> {Process, :sleep, [10]},
...> fn(_) -> "something" end
...> ])
[:ok, :ok, :ok, :ok, "something"]
```
I2C bus processes will be created under `I2cServer.I2cBusSupervisor` dynamically.
## Configuration
You can change settings in your config file such as `config/config.exs` file.
### Registry module
By default, I2C bus processes are
stored in [`Registry`](https://hexdocs.pm/elixir/Registry.html), but you can alternatively use
[`:global`](http://erlang.org/doc/man/global.html).
```elixir
config :i2c_server,
bus_registry_module: :global
```