Skip to content

Commit

Permalink
bumps version
Browse files Browse the repository at this point in the history
  • Loading branch information
Marco Polita committed Feb 7, 2023
1 parent 8c80b80 commit 29c4d8f
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,15 @@ by adding `ccs811` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:ccs811, "~> <LATEST_VERSION>"}
{:ccs811, "~> 0.3.0"}
]
end
```

## Usage

### Standalone

```elixir
iex(1)> Ccs811.initialize
iex(2)> Ccs811.read_alg_result_data
Expand Down Expand Up @@ -49,7 +51,7 @@ Add to your application initialization
Ccs811.start_polling()
```

Which will set the driver to periodically execute a telemetry event named `[:ccs811, :read]`
Which will set the driver to periodically execute a telemetry event named `[:ccs811, :read]`
with a new data map containing values for eCO2 `:eco2` and TVOC `tvoc`

## Initialization
Expand All @@ -58,7 +60,8 @@ both `Ccs811.start_polling()` and `Ccs811.initialize()` supports additional conf

see `Ccs811.start_polling/1` and `Ccs811.initialize/1` for further details

### Missing features:
### Missing features

- Configuring humidity and temperature
- Interrupt based data reading instead of polling
- Configuration for Bus-name (currently it uses the first available I2C bus)
2 changes: 1 addition & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ defmodule Ccs811.MixProject do
use Mix.Project

@source_url "https://github.com/Efesto/ccs811"
@version "0.2.0"
@version "0.3.0"

def project do
[
Expand Down

0 comments on commit 29c4d8f

Please sign in to comment.