alenia / aqiduck Goto Github PK

Some errors should post a slack message

• If there are API issues when reporting for the first time, post a message (probably depends on the error code from PA)
• If the JSON has unknown fields, post a message
  Future:
• If there are repeated issues monitoring the same endpoint, post a message

Expect 50 to be squarely yellow! Reported on github rather than elbow on the couch by request from @alenia <3

Set up sensors when invited to a channel, stop monitoring when uninvited

Subtract 8 from the results when reporting them

We’ve found that a correction of 8°F correlates closely to the ambient temperature, while a 4% correction correlates closely to the ambient humidity

This should also ideally change the channel topic

Comands:

• monitor [SensorName] AQI 40-50 "OK I'll let you know if the [SensorName] AQI drops below 40 or above 50"
• add sensor NAME ID (defaults to purpleair)
• remove sensor NAME
• reload re-initializes all sensors from the JSON

Eventually have conversations like:

• add sensor "By ID or by zip code?" ID "What is the sensor ID?" 12345 "What do you want to call the sensor?" name "Alright we're now set up in this channel to read from sensor 12345" (changes channel topic)

Current implementation is working
TODO:

• write tests
• Add configuration setup to README

https://api.purpleair.com/

• get API key
• Use groups?

If I can't subscribe to channel topic change events, do this by responding to @aqiduck reload or a slash command or something

• On startup post https://api.purpleair.com/v1/groups with something like {name: "AQIDuck #{version} #{instance identifier}"} and save the group ID
• For each PA sensor post https://api.purpleair.com/v1/groups/:group_id/members with { "sensor_index": 12345 }
  • If I try to do this for the same sensor twice I get a 409 DuplicateGroupEntryError
• https://api.purpleair.com/v1/groups/:group_id/members?fields=pm2.5%2Cpm2.5_10minute%2Ctemperature%2Chumidity
  • note previously I was using temperature_a. The temperature field is averaged.
  • I probably also want name and something that will let me know if the sensor is offline

For example @aqiduck report should respond with the report at that time.

This involves setting up a server to listen to messages coming from slack

Basic: Set temperature thresholds to monitor
Advanced: Monitor comparison in temperature between two sensors.

I think right now that if the thresholds aren’t properly named (i.e. if the JSON keys are spelled wrong) the user won’t know that the bot isn’t monitoring anything. When config is loaded/reloaded, just announce what monitoring is going on