@airemad/node-acustic

Node.js Libary to collect, analyze and digest the Acustic Pollution in Madrid

About

Node.js Libary to collect, analyze and digest the Acustic Pollution in Madrid

❤️ Awesome Features:

• debug is supported 💪
• Out of the box simple Interface. 🔥
• Check report integrity against Json Schemas 🧐
• Includes context info like hash, timestamp, source... 🥷
• Easy to use and great test coverage ✅

Installation

npm install @airemad/node-acustic

Usage

const { getLastReport } = require('@airemad/node-acustic')

;(async () => {
    const {data, hash, source, timestamp} = await getLastReport()
    console.log(hash)      // 1369f90ec7205649da9abbbc98f63e35
    console.log(source)    // https://www.mambiente.madrid.es/opendata/ruido.txt
    console.log(timestamp) // 1651271749972
    console.log(data)
/*
[
    ...,
    {
        id: '86',
        uuid: '271a6e0a-9d62-49cd-a772-57c1b492441f',
        name: 'Tres Olivos',
        period: 'night',
        date: '2022-04-21',
        laeq: 47,
        las01: 58,
        las10: 51,
        las50: 39,
        las90: 36,
        las99: 36
    }
]
*/

})()

Built With

Development only:

• Standard - Linting propuses
• Husky - Git Hooks
• Commitlint - Linting commit messages
• Jest - Testing
• Standard - Linting
• Standard-version - Manage changelog and releases

Production only:

• @airemad/stations - Stations information
• node-fetch - HTTP Library to download reports
• debug - Manage debugging info
• ajv - Json Schemas
• ajv-formats - Extend Json Schemas

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Ulises Gascón - Initial work- - @ulisesGascon

See also the list of contributors who participated in this project.

License

This project is licensed under the GNU AGPL3.0 License - see the LICENSE.md file for details

Data sources

We use Madrid Datos Abiertos:

• Dataset: Contaminación acústica. Datos diarios