forked from paraimpu/cagliari-opendata
-
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.
Info about data added to README, new contributor, new README
- Loading branch information
pintux
committed
May 24, 2016
1 parent
906e31e
commit f81c4e8
Showing
3 changed files
with
142 additions
and
116 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
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,114 +1,140 @@ | ||
| Cagliari Open Data SDK for node.js | ||
| ================================== | ||
|
|
||
| [](https://nodei.co/npm/cagliari-opendata/) | ||
|
|
||
| About | ||
| ----- | ||
|
|
||
|
|
||
| Basic node.js libraries to use Cagliari Open Data API endpoints. | ||
|
|
||
|
|
||
| Supported Datasets and Endpoints | ||
| -------------------------------- | ||
|
|
||
| - Traffic | ||
|
|
||
| Installation | ||
| ------------ | ||
|
|
||
| `npm install cagliari-opendata` | ||
|
|
||
| Basic Example | ||
| ------------- | ||
|
|
||
| Getting all installed traffic monitoring stations: | ||
|
|
||
| ```js | ||
| var opendata = require('cagliari-opendata'); | ||
| var traffic = opendata.traffic; | ||
|
|
||
| traffic.getStations(function(err, stations){ | ||
|
|
||
| if(!err){ | ||
| console.log(stations); | ||
| } | ||
|
|
||
| }); | ||
| ``` | ||
|
|
||
| API | ||
| --- | ||
|
|
||
| All functions are asynchronous, thus a `callback(err, data)` is *mandatory* as the last parameter in a call. | ||
|
|
||
|
|
||
| * <a href="#getStations"><code>traffic.<b>getStations()</b></code></a> | ||
| * <a href="#getStation"><code>traffic.<b>getStation()</b></code></a> | ||
| * <a href="#getStationData"><code>traffic.<b>getStationData</b></code></a> | ||
| * <a href="#getSensorData"><code>traffic.<b>getSensorData()</b></code></a> | ||
|
|
||
| ---------------------------------------------------------- | ||
| <a name="getStations"></a> | ||
| ### getStations(cb) | ||
|
|
||
| Gets all available traffic stations installed in the city. | ||
|
|
||
| A JSON is returned. | ||
|
|
||
| ----------------------------------------------------------- | ||
| <a name="getStation"></a> | ||
| ### getStation(id, cb) | ||
| Gets info about a particular station given its `id`. | ||
|
|
||
| A JSON is returned. | ||
|
|
||
| - `id` is the numeric or String id of the station | ||
|
|
||
| ----------------------------------------------------------- | ||
| <a name="getStationData"></a> | ||
| ### getStationData(id, startDate, endDate, cb) | ||
| Gets measurement data from all the sensors in a station, given its `id`. | ||
|
|
||
| A JSON is returned. | ||
|
|
||
| - `id` is the numeric or string id of the station | ||
| - `startDate` a Date representing the start date/time for required measurements (mandatory) | ||
| - `endDate` a Date representing the end date/time for required measurements (optional) | ||
|
|
||
| ------------------------------------------------------------ | ||
| <a name="getSensorData"></a> | ||
| ### getSensorData(id, startDate, endDate, cb) | ||
| Gets measurement data from for a specific sensor, given its `id`. | ||
|
|
||
| A JSON is returned. | ||
|
|
||
| - `id` is the numeric or string id of the sensor | ||
| - `startDate` a Date representing the start date/time for required measurements (mandatory) | ||
| - `endDate` a Date representing the end date/time for required measurements (optional) | ||
|
|
||
|
|
||
| Links | ||
| ----- | ||
|
|
||
| - [Cagliari Open Data Portal](http://opendata.comune.cagliari.it/portale) | ||
|
|
||
| Contributors | ||
| ------------ | ||
|
|
||
| <table><tbody> | ||
| <tr><th align="left">Antonio Pintus</th><td><a href="https://github.com/pintux">GitHub/pintux</a></td><td><a href="https://twitter.com/apintux">Twitter/@apintux</a></td></tr> | ||
|
|
||
| </tbody></table> | ||
|
|
||
|
|
||
| License - "MIT License" | ||
| ----------------------- | ||
| Copyright (c) 2016 Antonio Pintus, http://www.pintux.it | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
| Cagliari Open Data SDK for node.js | ||
| ================================== | ||
|
|
||
| [](https://nodei.co/npm/cagliari-opendata/) | ||
|
|
||
| About | ||
| ----- | ||
|
|
||
|
|
||
| Basic node.js libraries to use Cagliari Open Data API endpoints. | ||
|
|
||
|
|
||
| Supported Datasets and Endpoints | ||
| -------------------------------- | ||
|
|
||
| - Traffic | ||
|
|
||
| Installation | ||
| ------------ | ||
|
|
||
| `npm install cagliari-opendata` | ||
|
|
||
| Basic Example | ||
| ------------- | ||
|
|
||
| Getting all installed traffic monitoring stations: | ||
|
|
||
| ```js | ||
| var opendata = require('cagliari-opendata'); | ||
| var traffic = opendata.traffic; | ||
|
|
||
| traffic.getStations(function(err, stations){ | ||
|
|
||
| if(!err){ | ||
| console.log(stations); | ||
| } | ||
|
|
||
| }); | ||
| ``` | ||
|
|
||
| API | ||
| --- | ||
|
|
||
| All functions are asynchronous, thus a `callback(err, data)` is *mandatory* as the last parameter in a call. | ||
|
|
||
|
|
||
| * <a href="#getStations"><code>traffic.<b>getStations()</b></code></a> | ||
| * <a href="#getStation"><code>traffic.<b>getStation()</b></code></a> | ||
| * <a href="#getStationData"><code>traffic.<b>getStationData</b></code></a> | ||
| * <a href="#getSensorData"><code>traffic.<b>getSensorData()</b></code></a> | ||
|
|
||
| All functions are asynchronous, thus a `callback(err, data)` is *mandatory* as the last parameter in a call. | ||
|
|
||
|
|
||
|
|
||
| Data Description | ||
| ---------------- | ||
| JSON representations returned by API calls contain the following data items. See descriptions for details. | ||
|
|
||
| JSON field | Descrizione (Italian) | Description (English) | | ||
| ------------ | ------------- | ------------- | | ||
| tipoApparato | 2 == Postazione con un sensore per ogni senso di marcia; 4 == Postazione con due spire | 2 == Station with a sensor per direction; 4 == Station with two loops | | ||
| classe: "Totali" | Totale di tutte le classi | Overall value of all classes | | ||
| classe: "X - Y m" | Lunghezza del veicolo da X metri a Y metri | Vehicle length from X to Y meters | | ||
| classe: "Oltre m" | Lunghezza del veivolo superiore a 22 metri | Vehicle length exceeding 22 meters | | ||
| tipoClassificazione | 0 == Flusso e velocità; 1 == Solo Flusso| 0 == Flow and Speed; 1 == Flow, only | | ||
| efficienza | 100 == Dati flusso e velocità; 0 == Dati di solo flusso | 100 == Flow and Speed data; 0 == Flow, only | | ||
| velocita | Velocità in Km/h | Speed in Km/h | | ||
| flusso | Veicoli per ora | Vehicles per hour | | ||
| tasso | Percentuale (%) | Percentage (%) | | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| ---------------------------------------------------------- | ||
| <a name="getStations"></a> | ||
| ### getStations(cb) | ||
|
|
||
| Gets all available traffic stations installed in the city. | ||
|
|
||
| A JSON is returned. | ||
|
|
||
| ----------------------------------------------------------- | ||
| <a name="getStation"></a> | ||
| ### getStation(id, cb) | ||
| Gets info about a particular station given its `id`. | ||
|
|
||
| A JSON is returned. | ||
|
|
||
| - `id` is the numeric or String id of the station | ||
|
|
||
| ----------------------------------------------------------- | ||
| <a name="getStationData"></a> | ||
| ### getStationData(id, startDate, endDate, cb) | ||
| Gets measurement data from all the sensors in a station, given its `id`. | ||
|
|
||
| A JSON is returned. | ||
|
|
||
| - `id` is the numeric or string id of the station | ||
| - `startDate` a Date representing the start date/time for required measurements (mandatory) | ||
| - `endDate` a Date representing the end date/time for required measurements (optional) | ||
|
|
||
| ------------------------------------------------------------ | ||
| <a name="getSensorData"></a> | ||
| ### getSensorData(id, startDate, endDate, cb) | ||
| Gets measurement data from for a specific sensor, given its `id`. | ||
|
|
||
| A JSON is returned. | ||
|
|
||
| - `id` is the numeric or string id of the sensor | ||
| - `startDate` a Date representing the start date/time for required measurements (mandatory) | ||
| - `endDate` a Date representing the end date/time for required measurements (optional) | ||
|
|
||
|
|
||
| Links | ||
| ----- | ||
|
|
||
| - [Cagliari Open Data Portal](http://opendata.comune.cagliari.it/portale) | ||
|
|
||
| Contributors | ||
| ------------ | ||
|
|
||
| <table><tbody> | ||
| <tr><th align="left">Antonio Pintus</th><td><a href="https://github.com/pintux">GitHub/pintux</a></td><td><a href="https://twitter.com/apintux">Twitter/@apintux</a></td></tr> | ||
| <tr><th align="left">Cristian Lai</th><td><a href="https://github.com/cristianlai">GitHub/cristianlai</a></td><td><a href="https://twitter.com/crlai">Twitter/@crlai</a></td></tr> | ||
| </tbody></table> | ||
|
|
||
|
|
||
| License - "MIT License" | ||
| ----------------------- | ||
| Copyright (c) 2016 Antonio Pintus (http://www.pintux.it), Cristian Lai | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
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