-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7b91717
commit 0fd1af0
Showing
1 changed file
with
25 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,28 +1,40 @@ | ||
| # Project Noisemeter Device | ||
| # tRacket: Community-Driven Urban Noise Monitoring | ||
|
|
||
| [Civic Tech TO](https://civictech.ca/) | ||
| This repository contains all source code and hardware design files for the [tRacket](https://tracket.info/) noise sensor. | ||
|
|
||
| ## Overview | ||
|
|
||
| This repo contains all source code and design files for the Project Noisemeter Data-Gathering Devices, which are being developed by a group of volunteers at Civic Tech Toronto. The purpose of the device is to gather data about urban noise levels and upload that data to the cloud, whereupon the data can be made available to citizens, activists and lawmakers to help inform public policy around noise bylaws. | ||
| Environmental noise, especially in urban settings, is a [known public health concern](https://www.toronto.ca/wp-content/uploads/2017/11/8f98-tph-How-Loud-is-Too-Loud-Health-Impacts-Environmental-Noise.pdf): | ||
|
|
||
| The first-generation device is based around an arduino microcontroller and a MEMS microphone module, which sends audio data over I2S protocol. The device is to be hosted by volunteers at their home or place of work, where it will stay, long-term, to gather noise data and upload it. Currently, the device requires USB power and a WiFi connection in order to operate. Future devices may differ in both respects. | ||
| > The growing body of evidence indicates that exposure to excessive environmental | ||
| noise does not only impact quality of life and cause hearing loss but also has other health impacts, such as cardiovascular effects, cognitive impacts, sleep disturbance and mental health effects. | ||
|
|
||
| We will try to maintain up-to-date documentation within each hardware/version folder so that volunteers can more easily help out with the project. | ||
| The tRacket noise sensor continuous monitors ambient sound levels (in [decibels](https://en.wikipedia.org/wiki/Decibel), dBA) and sends these measurements to an [online dashboard](https://dashboard.tracket.info/locations) ([also on GitHub](https://github.com/CivicTechTO/tRacket-dashboard)). Our goal is to help local communities better understand the sound levels and extreme noise events that they experience day to day. | ||
|
|
||
| The project has been started and is maintained by volunteers from the [CivicTech Toronto](http://www.civictech.ca) community. | ||
|
|
||
| ## Privacy | ||
|
|
||
| We followed Privacy by Design principles in setting up the data collection. | ||
|
|
||
| 1. The sound meter devices are deployed on private properties in residential areas at different locations in the city. We are **not publishing exact device locations**. | ||
| 2. The devices **do not record sound** only sound levels in A-weighted decibel levels (dBA)(https://en.wikipedia.org/wiki/Decibel). | ||
| 3. We calculate minimum and maximum sound levels at 5 minute intervals on the device and **only broadcast these aggregate values** (along wiht the device ID) to a database. | ||
|
|
||
| ## Source Code | ||
|
|
||
| The [noisemeter-device](/noisemeter-device) folder contains the device's source code. The code can be built with the Arduino IDE or PlatformIO, and supports two ESP32 targets: a "breadboard" target for the early prototype, and a "pcb" target for the official circuit boards. See the source code's [BUILD.md](/noisemeter-device/BUILD.md) file for build instructions. The source code is released under the [GNU GPL v3 license](/noisemeter-device/LICENSE). | ||
| The [noisemeter-device](/noisemeter-device) folder contains the device's source code, which is written in C++ and can be built using [PlatformIO](https://platformio.org/). Build instructions are available [in the online documentation](https://civictechto.github.io/proj-noisemeter-device/md_noisemeter_device_BUILD.html). | ||
|
|
||
| The source code is released under the [GNU GPL v3 license](/noisemeter-device/LICENSE). | ||
|
|
||
| ## Hardware Files | ||
|
|
||
| The [hardware](/hardware) folder contains design files and documentation for each iteration of the noisemeter hardware. The PCBs are made using [KiCAD](https://www.kicad.org/) and are released under an [open hardware license](/hardware/pcb-rev2/LICENSE). | ||
| The [hardware](/hardware) folder contains design files and documentation for each iteration of the noisemeter hardware. The PCBs are designed using [KiCAD](https://www.kicad.org/). | ||
|
|
||
| The hardware design files are released under an [open hardware license](/hardware/pcb-rev2/LICENSE). | ||
|
|
||
| ## Current Points of Contact for the project: | ||
| ## For Developers | ||
|
|
||
| (May be subject to change) | ||
| * Check out the [Issues page](https://github.com/CivicTechTO/proj-noisemeter-device/issues) to see current bugs and feature requests. Any contributions are welcome! | ||
| * Online documentation of the firmware [is available here](https://civictechto.github.io/proj-noisemeter-device/). | ||
|
|
||
| - Gabe Sawnhey (Project Lead) | ||
| - Nick Barnard (Arduino) | ||
| - Clyne Sullivan (Arduino) | ||
| - Mitch Bechtel (API & Cloud DB) |