Publishing API for Dylos and Shinyei sensors

Note. The content on this page is outdated.
For the most recent upload API document, go to https://aqicn.org/data-feed/upload-api/

If you have a Dylos or Shinyei sensor, and you would like to publish its data on the World Air Quality Index, then this page is for you. One of the easiest solution for uploading the Dylos data is to use the ready made scripts available on github. But if you need to brew your own system, or upload data from the Shinyei sensor, then you can use the APIs described on this page.

Note that this API specification is not final, but still on-going work, so if you meet any difficulty with the integration, just contact us to get the support.


--

API Endpoint

http://sensor.aqicn.org/

API Method: Uploading data

post /sensor/upload
Parameters
  • id: Sensor ID, eg dylos.test-sensor-id
  • key: Sensor password - optional, only if the sensor ID is 'locked'.
  • time: Sensor time, with timezone information, in ISO 8601 format- eg 2014/10/08 18:03:45 +0800
  • location: Sensor position (latitude, longitude) - optional only if correlation with BAM sensor is requested

  • data: Array, containing all the raw readings
    • type: Sensor data type. For now, can be "dylos-0.5", "dylos-2.5", "shinyei-pdp42ns-2.5u" or "shinyei-pdp42ns-1u".
    • unit: Sensor data unit. For now, can be "pc" (particule count) or "lpo" (low pulse occupancy).
    • value: Sensor data reading. eg 94948 or 0.374

    Notes
    1. The above parameters are encapsulated within the argument 'postdata' of the post request.
    2. The LPO value must be between 0 and 1. 0 Means transparent, 1 Opaque. For more information on how to extrac the LPO from the Shinyei sensor, please refer to this page: api/shinyei.
Example:
...
Return value:
  • result: Can be either ok or error.

    In case of ok result, the returned value will contain the sensor id as well as the upload data ids (for information purpose only).
    ...

    In case of error, the returned value will contain a description (field msg) and an error code (field ecode) which can be one of the following:

    • 101: There are missing arugments from the posted data. Minimum arguments are id, time and data.
    • 102: Key is not valid - the sensor is protected by password and the provided password is not correct.
    • 103: No data posted (i.e empty array or data is not an array).
    • 104: Unit, type of value information not available from the data field.
    • 105: Sensor type is unknown.
    • 106: The field value is not numeric.
    • 107: Time string can not be decode (is it ISO 8601 complaiant?)
    • 108: SQL query failed.
    ...

Example

 $ curl -i "http://sensor.aqicn.org/sensor/upload/" -d 'postdata={id:"dylos.test-sensor-id",time:"2014-10-16T19:20:31+08:00",data:[{type:"dylos-2.5",value:88,unit:"pc"}]}'

HTTP/1.1 200 OK
Date: Sun, 09 Nov 2014 08:28:34 GMT
Server: Apache/2.2.15 (CentOS)
X-Powered-By: PHP/5.3.3
Vary: Accept-Encoding
Connection: close
Transfer-Encoding: chunked
Content-Type: text/json; charset=utf-8

{"result":"ok","sensorID":"588","dataids":[2825275]}


API Method: Getting the raw sensor data

get /sensor/download
Parameters
  • id: Sensor ID, eg dylos.test-sensor-id
  • callback: Optional JsonP callback (eg "foo").
Example :
 http://sensor.aqicn.org/sensor/download/?id=dylos.test-sensor-id&callback=foo 

Return value:
...

Example

 $ curl -i "http://sensor.aqicn.org/sensor/download/?id=dylos.test-sensor-id&callback=foo"

HTTP/1.1 200 OK
Date: Sun, 09 Nov 2014 08:42:12 GMT
Server: Apache/2.2.15 (CentOS)
X-Powered-By: PHP/5.3.3
Vary: Accept-Encoding
Connection: close
Transfer-Encoding: chunked
Content-Type: text/json; charset=utf-8

{"id":"dylos.test-sensor-id","data":{"dylos-0.5":[{"time":"1413458432","value":"89"}],"dylos-2.5":[{"time":"1413458432","value":"89"},{"time":"1413458431","value":"88"}]}}


Sobre a medição da aualidade do ar e poluição

Sobre os níveis de qualidade do ar

- Valores do Índice de Qualidade do Ar (AQI)Níveis de preocupação de saúde
0 - 50 Boa 0-50: Boa - A qualidade do ar é considerada satisfatória, a poluição do ar representa pouco ou nenhum risco
51 -100 Moderado 50-100: Moderado - A qualidade do ar é aceitável; No entanto, para alguns poluentes pode haver um problema de saúde moderada para um número muito pequeno de pessoas que são mais sensíveis à poluição do ar.
101-150 Não Saudável para Grupos Sensíveis Membros de grupos sensíveis podem ter efeitos na a saúde. O público em geral não é susceptível de ser afetado.
151-200 Não saudável 150-200: Insalubre - Toda a população pode começar a sentir os efeitos na saúde; membros de grupos sensíveis podem apresentar efeitos mais sérios de saúde.
201-300 Muito Prejudical à Saúde 200-300: Muito Insalubre - As advertências de saúde de situações de emergência. Toda a população é mais susceptível de ser afectada.
300+ Perigoso 300+: Perigoso - alerta de saúde: todos podem experimentar efeitos mais graves para a saúde

Para saber mais sobre Qualidade do Ar e Poluição, verifique o wikipedia Qualidade do Ar tópico ou o guia AIRNow a Qualidade do Ar e sua saúde.

Para informações sobre saúde muito úteis em Pequim, procure Doutor Richard Saint Cyr MD, consulte www.myhealthbeijing.com blogue.


Aviso de uso: Todos os dados da Qualidade do Ar não são validados no momento da publicação e, devido à garantia de qualidade, esses dados podem ser alterados, sem aviso prévio, a qualquer momento. O projeto Índice de Qualidade do Ar Mundial exerceu todas as habilidades e cuidados razoáveis na compilação do conteúdo desta informação e sob nenhuma circunstância o A equipe do projeto World Air Quality Index ou seus agentes podem ser responsabilizados em contrato, responsabilidade civil ou de outra forma por qualquer perda, lesão ou dano decorrente direta ou indiretamente do fornecimento desses dados.



Configurações


Configurações de Idioma:


Temperature unit:
Celcius