GrovePi v0.6.1 API Reference
Modules
This application lets you interact with the GrovePi+ and any connected sensors in Elixir. It will automatically start with your application an initiate a connection to the GrovePi+ board
Perform analog I/O using the GrovePi
Low-level interface for sending raw requests and receiving responses from a GrovePi hat. Create one of these first and then use one of the other GrovePi modules for interacting with a connected sensor, light, or actuator
Conveniences for working with a button
This is the default triggering mechanism for Button events. Events
are either pressed
or released
and include the trigger state.
The trigger state for the default trigger is a struct containing
a value
property
Control a Grove buzzer. While a buzzer can be controlled solely using
GrovePi.Digital
, this module provides some helpers
Conveniences for reading from a DHT sensor
This is the default triggering mechanism for DHT events. The
event is :changed
and includes the trigger state. The trigger state
for the default trigger is a struct containing temp
and humidity
properties
Write to and read digital I/O on the GrovePi. This module provides a low level API to digital sensors
Conveniences for working with an Infrared Reflective Sensor
This is the default triggering mechanism for IRReflective events. Events
are either close
or far
and include the trigger state.
The trigger state for the default trigger is a struct containing
a value
property
This module provides lower level functions to interact with the
PivotPi
through the GrovePi. Most users
should be able to obtain all needed functionality with GrovePi.PivotPi
A behaviour module for implementing polling on a pin
Conveniences for reading from a potentiometer or rotary angle sensor
This is the default triggering mechanism for Potentiometer events. The
event is :changed
and includes the trigger state. The trigger state
for the default trigger is a struct containing a value
property
Conveniences for controlling a RGB LCD Display. The display should be connected to the I2C-1 port
Module with struct to hold GrovePi.RGBLCD configuration
Conveniences for controlling a GrovePi Relay
Conveniences for working with a sound sensor
This is the default triggering mechanism for Sound events. Events
are either loud
or quiet
and include the trigger state. It
contains to thresholds a low_threshold
and a high_threshold
for
triggering loud
and quiet
events
This is the top level supervisor that is started by the grovepi application. You
can use this to start your own grovepi supervision tree by passing a prefix to the
start_link
function
The Trigger behaviour is used for implementing triggers for poller
behaviors such as GrovePi.Sound
and GrovePi.Button
Read distance from the Grove Ultrasonic sensor