https://github.com/yktoo/infopi
InfoPi Information server application
https://github.com/yktoo/infopi
angular buienradar diy electron raspberry-pi smart-home smart-mirror train weather
Last synced: 9 months ago
JSON representation
InfoPi Information server application
- Host: GitHub
- URL: https://github.com/yktoo/infopi
- Owner: yktoo
- License: mit
- Created: 2016-04-24T15:09:19.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-06-12T08:21:23.000Z (over 1 year ago)
- Last Synced: 2024-10-25T09:21:45.859Z (over 1 year ago)
- Topics: angular, buienradar, diy, electron, raspberry-pi, smart-home, smart-mirror, train, weather
- Language: TypeScript
- Homepage: https://yktoo.com/en/software/infopi/
- Size: 3.97 MB
- Stars: 8
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## InfoPi Information server application
[](https://github.com/yktoo/infopi/actions/workflows/angular.yml)
**InfoPi** is a single-page web application that displays various live data, like weather forecast and train departure times. The application is developed with Angular and can be packaged with the Electron browser to make an all-in-one executable bundle.
My own implementation was crafted for Raspberry Pi running [Raspbian Bullseye](https://www.raspberrypi.com/software/) and a full HD monitor (1920×1080 pixels) in the portrait orientation, but it will (supposedly) run on any platform that Electron supports and properly adapt itself to a broad range of resolutions.
This is how the information page looks like:
## Dependencies
In order to build the package you will need:
* [Node 16+ and npm 7.x+](https://nodejs.org/)
* [Angular CLI](https://angular.io/cli)
## Getting started
1. Run in the terminal:
```bash
# Clone the git repository
git clone https://github.com/yktoo/infopi.git
# Install NPM modules
cd infopi
npm install
# Copy the sample configuration
cp src/environments/config.sample.ts src/environments/config.ts
```
2. If you plan to use train information, request an NS API key [here](https://apiportal.ns.nl/).
3. Edit the file `src/environments/config.ts` you copied on step `1` and update values in it. Also put the NS API key there if you have one.\
The file provides some sane initial values, like refresh intervals. You are encouraged to change stuff like the weather station or bus stop as you see fit.
4. Test the application:
```bash
npm run electron
```
You should see a new browser window started in the kiosk mode (use Ctrl+Q to exit or Ctrl+Shift+I to open Developer Tools and diagnose problems).
## Packaging
To create a `.deb` package for your current architecture run `npm run package`.
To create a package for Raspberry Pi run `npm run package:rpi`.
The packages will be created as `dist/installers/infopi_XXX_YYY.deb`
## Installing
Once you have a `.deb`, copy it onto your Raspberry Pi and install using:
```bash
sudo dpkg -i infopi_XXX_YYY.deb
```
To test your setup, run `infopi` from the command line or use the Application menu launcher created by the package.
## Finishing touch
In order to make InfoPi start at bootup, you can add the following commands to `~/.config/lxsession/LXDE-pi/autostart`:
```bash
# InfoPi app
infopi
```
License
=======
See [LICENSE](LICENSE).
Credits
=======
* [Angular](https://angular.io/)
* [Chart.js](https://www.chartjs.org/)
* [ng2-charts](https://valor-software.com/ng2-charts/)
* [xml-js](https://www.npmjs.com/package/xml-js)
* [Weather Icons](https://erikflowers.github.io/weather-icons/)
* [Electron](https://www.electronjs.org/), [electron-packager](https://github.com/electron/electron-packager) and [electron-installer-debian](https://github.com/electron-userland/electron-installer-debian)
Data providers
==============
* Weather info: [Buienradar.nl](http://buienradar.nl/)
* Train info: [Nederlandse Spoorwegen](http://www.ns.nl/)
* Bus info: [openOV](http://openov.nl/)
* News: [BBC](https://www.bbc.co.uk/)
* Sensors: home automation server instance of [OpenHAB](https://www.openhab.org/).