{"id":16389432,"url":"https://github.com/mnishiguchi/scd4x","last_synced_at":"2025-08-16T19:11:30.248Z","repository":{"id":57546111,"uuid":"398691656","full_name":"mnishiguchi/scd4x","owner":"mnishiguchi","description":"Use Sensirion SCD4x CO2 sensors (SCD40 and SCD41) in Elixir","archived":false,"fork":false,"pushed_at":"2021-08-28T13:04:54.000Z","size":20,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-31T09:30:36.221Z","etag":null,"topics":["co2-sensor","elixir","elixir-lang","elixir-language","nerves","nerves-project","scd40","scd41","scd4x","scd4x-sensor","sensor","sensors"],"latest_commit_sha":null,"homepage":"","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mnishiguchi.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-08-22T01:46:59.000Z","updated_at":"2025-01-18T16:27:38.000Z","dependencies_parsed_at":"2022-09-26T18:30:37.371Z","dependency_job_id":null,"html_url":"https://github.com/mnishiguchi/scd4x","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/mnishiguchi/scd4x","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mnishiguchi%2Fscd4x","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mnishiguchi%2Fscd4x/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mnishiguchi%2Fscd4x/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mnishiguchi%2Fscd4x/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mnishiguchi","download_url":"https://codeload.github.com/mnishiguchi/scd4x/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mnishiguchi%2Fscd4x/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270758252,"owners_count":24640204,"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","status":"online","status_checked_at":"2025-08-16T02:00:11.002Z","response_time":91,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["co2-sensor","elixir","elixir-lang","elixir-language","nerves","nerves-project","scd40","scd41","scd4x","scd4x-sensor","sensor","sensors"],"created_at":"2024-10-11T04:32:57.742Z","updated_at":"2025-08-16T19:11:30.223Z","avatar_url":"https://github.com/mnishiguchi.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SCD4X\n\n[![Hex version](https://img.shields.io/hexpm/v/scd4x.svg 'Hex version')](https://hex.pm/packages/scd4x)\n[![API docs](https://img.shields.io/hexpm/v/scd4x.svg?label=docs 'API docs')](https://hexdocs.pm/scd4x)\n[![CI](https://github.com/mnishiguchi/scd4x/actions/workflows/ci.yml/badge.svg)](https://github.com/mnishiguchi/scd4x/actions/workflows/ci.yml)\n[![Publish](https://github.com/mnishiguchi/scd4x/actions/workflows/publish.yml/badge.svg)](https://github.com/mnishiguchi/scd4x/actions/workflows/publish.yml)\n\nUse [Sensirion SCD4X](https://www.sensirion.com/en/environmental-sensors/carbon-dioxide-sensors/carbon-dioxide-sensor-scd4x) [CO2](https://en.wikipedia.org/wiki/Carbon_dioxide) sensors (SCD40 and SCD41) in Elixir.\n\n## Usage\n\n### Start the sensor server\n\n```elixir\niex\u003e {:ok, scd} = SCD4X.start_link(bus_name: \"i2c-1\")\n{:ok, #PID\u003c0.1407.0\u003e}\n```\n\n### Periodic measurement\n\nThe sensor updates the measurement every 5 seconds once the periodic measurement is started.\n\n```elixir\niex\u003e SCD4X.start_periodic_measurement(scd)\n:ok\n\niex\u003e SCD4X.measure(scd)\n{:ok,\n %SCD4X.Measurement{\n   co2_ppm: 612,\n   humidity_rh: 59.07440185546875,\n   temperature_c: 30.331497192382812,\n   timestamp_ms: 620482\n }}\n\nSCD4X.stop_periodic_measurement(scd)\n:ok\n```\n\n### Single shot measurement\n\nThe measurement can be performed on demand without the periodic measurement.\n\n```elixir\niex\u003e SCD4X.measure(scd, :single_shot)\n{:ok,\n %SCD4X.Measurement{\n   co2_ppm: 638,\n   humidity_rh: 70.49713134765625,\n   temperature_c: 26.63848876953125,\n   timestamp_ms: 400768\n }}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmnishiguchi%2Fscd4x","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmnishiguchi%2Fscd4x","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmnishiguchi%2Fscd4x/lists"}