mpl3115a2/README.md
James Harton c8f232872e
All checks were successful
continuous-integration/drone/push Build is passing
chore: fix typo in readme
2024-03-08 14:46:26 +13:00

2.4 KiB

MPL3115A2

Build Status Hex.pm Hippocratic License HL3-FULL

Elixir driver for the MPL3115A2 barometric pressure, altitude and temperature sensor. I'm using Adafruit's breakout.

Usage

Add your device to your config like so:

config :mpl3115a2,
  devices: [%{bus: "i2c-1", address: 0x60}]

And start your application. Your devices will be reset with defaults and you will be able to take temperature and pressure or altitude readings. See MPL3115A2.Commands.initialize!/1 for more details on the default initialization.

This device is capable of much more advanced usage than the MPL3115A2.Device module makes use of. It was all that I needed at the time. For advanced usage you can use the MPL3115A2.Commands and MPL3115A2.Registers modules directly. Feel free to send PR's.

Installation

If available in Hex, the package can be installed by adding mpl3115a2 to your list of dependencies in mix.exs:

def deps do
  [
    {:mpl3115a2, "~> 1.0.1"}
  ]
end

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/mpl3115a2.

Github Mirror

This repository is mirrored on Github from it's primary location on my Forgejo instance. Feel free to raise issues and open PRs on Github.

License

This software is licensed under the terms of the HL3-FULL, see the LICENSE.md file included with this package for the terms.

This license actively proscribes this software being used by and for some industries, countries and activities. If your usage of this software doesn't comply with the terms of this license, then contact me with the details of your use-case to organise the purchase of a license - the cost of which may include a donation to a suitable charity or NGO.