{"id":25516199,"url":"https://github.com/efesto/ccs811","last_synced_at":"2025-04-10T20:43:20.713Z","repository":{"id":39751357,"uuid":"326424915","full_name":"Efesto/ccs811","owner":"Efesto","description":"Driver for CCS811 Ultra-Low Power Digital Gas Sensor for Monitoring Indoor Air Quality","archived":false,"fork":false,"pushed_at":"2023-12-11T15:05:37.000Z","size":51,"stargazers_count":2,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-24T18:12:57.265Z","etag":null,"topics":["elixir","i2c-sensors","nerves"],"latest_commit_sha":null,"homepage":"","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Efesto.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2021-01-03T14:23:22.000Z","updated_at":"2024-02-03T13:09:03.000Z","dependencies_parsed_at":"2023-10-04T03:02:42.467Z","dependency_job_id":null,"html_url":"https://github.com/Efesto/ccs811","commit_stats":{"total_commits":32,"total_committers":3,"mean_commits":"10.666666666666666","dds":0.5,"last_synced_commit":"ea3369a5ac93d15ab356a09ba9a9a6f4e318656c"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Efesto%2Fccs811","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Efesto%2Fccs811/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Efesto%2Fccs811/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Efesto%2Fccs811/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Efesto","download_url":"https://codeload.github.com/Efesto/ccs811/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248293908,"owners_count":21079750,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["elixir","i2c-sensors","nerves"],"created_at":"2025-02-19T14:18:21.369Z","updated_at":"2025-04-10T20:43:20.693Z","avatar_url":"https://github.com/Efesto.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ccs811\n\n![Elixir CI](https://github.com/Efesto/ccs811/workflows/Elixir%20CI/badge.svg)\n[![Hex pm](https://img.shields.io/hexpm/v/ccs811.svg?style=flat)](https://hex.pm/packages/ccs811)\n[![Hexdocs.pm](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/ccs811/)\n\nDriver for CCS811 Ultra-Low Power Digital Gas Sensor for Monitoring Indoor Air Quality\n\n[Datasheet](https://cdn.sparkfun.com/assets/learn_tutorials/1/4/3/CCS811_Datasheet-DS000459.pdf)\n\n## Installation\n\nThe package can be installed by adding `ccs811` to your list of dependencies in `mix.exs`:\n\n```elixir\ndef deps do\n  [\n    {:ccs811, \"~\u003e 0.3.0\"}\n  ]\nend\n```\n\n## Usage\n\n### Standalone\n\n```elixir\niex(1)\u003e Ccs811.initialize\niex(2)\u003e Ccs811.read_alg_result_data\n%{\n  eco2: 1529,\n  error_id: %{\n    heater_fault: false,\n    heater_supply: false,\n    max_resistance: false,\n    measmode_invalid: false,\n    red_reg_invalid: false,\n    write_reg_invalid: false\n  },\n  status: %{app_valid: true, data_ready: true, error: false, fw_mode: true},\n  tvoc: 191\n}\niex(23)\u003e Ccs811.read_status\n%{app_valid: true, data_ready: true, error: false, fw_mode: true}\n```\n\n### With Telemetry\n\nAdd to your application initialization\n\n```elixir\n  Ccs811.start_polling()\n```\n\nWhich will set the driver to periodically execute a telemetry event named `[:ccs811, :read]`\nwith a new data map containing values for eCO2 `:eco2` and TVOC `tvoc`\n\n## Initialization\n\nboth [`Ccs811.start_polling()`](https://hexdocs.pm/ccs811/Ccs811.html#initialize/1) and [`Ccs811.initialize()`](https://hexdocs.pm/ccs811/Ccs811.html#initialize/1) supports additional configuration parameters that can be passed as a keyword list\n\n### Missing features\n\n- Interrupt based data reading instead of polling\n- Configuration for Bus-name (currently it uses the first available I2C bus)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fefesto%2Fccs811","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fefesto%2Fccs811","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fefesto%2Fccs811/lists"}