Eric
44 lines
2.7 KiB
Markdown
44 lines
2.7 KiB
Markdown
# Pi Weather Station
|
|
|
|
This is a weather station designed to be used with a Raspberry Pi on the official 7" 800x480 touchscreen.
|
|
|
|
|
|
|
|
The weather station will require you to have API keys from [Mapbox](https://www.mapbox.com/) and [ClimaCell](https://www.climacell.co/). Optionally, you can use an API key from [LocationIQ](https://locationiq.com/) to preform reverse geocoding.
|
|
|
|
Weather maps are provided by the [RainViewer](https://www.rainviewer.com/) API, which generously does not require an [API key](https://www.rainviewer.com/api.html).
|
|
|
|
> Be mindful of the plan limits for your API keys and understand the terms of each provider, as scrolling around the map and selecting different locations will incur API calls for every location. Additionally, the weather station will periodically make additional api calls to get weather updates throughout the day.
|
|
|
|
## Setup
|
|
|
|
> You will need to have [Node.js](https://nodejs.org/) installed.
|
|
|
|
To install, clone the repo and run
|
|
|
|
$ npm install
|
|
|
|
Start the server with
|
|
|
|
$ npm start
|
|
|
|
Now set point your browser to `http://localhost:8080` and put it in full screen mode (`F11` in Chromium).
|
|
|
|
## Settings
|
|
|
|
- Your API keys are saved locally (in plain text) to `settings.json`.
|
|
- The server will attempt to get your default location, but if it cannot or you wish to choose a different default location, enter the latitude and longitude under `Custom Latitude` and `Custom Longitude` in settings, which can be accessed by tapping the gear button in the lower right hand corner.
|
|
- To hide the mouse cursor when using a touch screen, set `Hide Mouse` to `On`.
|
|
|
|
## License
|
|
|
|
The MIT License (MIT)
|
|
|
|
Copyright (c) 2020 Eric Lewin
|
|
|
|
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.
|