Current section
Files
Jump to
Current section
Files
y2kb040buzzer
README.md
README.md
# Y2KB040Buzzer
Elixir/Nerves driver for the Y2KB-040 I2C buzzer/melody module.
Board: [switch-science product page](https://www.switch-science.com/products/8904).
Target machine: [BeagleBone Green](https://www.beagleboard.org/boards/seeedstudio-beaglebone-green).
## Installation
The package can be installed by adding `y2kb040buzzer` to your list of
dependencies in `mix.exs`:
```elixir
def deps do
[
{:y2kb040buzzer, "~> 0.1.0"}
]
end
```
## Usage
```elixir
{:ok, ref} = Y2KB040Buzzer.open()
Y2KB040Buzzer.beep(ref, 4, 1, 2)
Y2KB040Buzzer.close(ref)
```
Documentation is generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm) at
<https://hexdocs.pm/y2kb040buzzer>.