summaryrefslogtreecommitdiff
path: root/README.md
blob: b9a8163ecc2854b26fcdea0b8249bdd0078bfa85 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# The Morning Paper
The Morning Paper is a project that prints out different information to a
receipt printer in the morning. The project will include template modules for
today's calendar events, the weather, a quote, top news headlines, and the
national day.

## Modules
The modules provided are written in python and will use the [adafruit thermal
printer library](https://github.com/adafruit/Python-Thermal-Printer) to
interface with the
[adafruit thermal printer used](https://www.adafruit.com/product/600).

## TODO
- Add comments to all functions for better documentation
- Timer for the main function
- Stock Tracker
- Better error handling
- Test print page with ip address
- Web interface for settings
  ~~- Settings print out with qr code to ip address~~
- Fix the Phantom j
- Migrate to the RPI Pico W
  - Use their wireless packages to connect to internet
  - Decide how to handle storing wireless
  - Look into the [Circutpython Printer Library](https://learn.adafruit.com/mini-thermal-receipt-printer/circuitpython)

## Parts
- [Adafruit Thermal Printer](https://www.adafruit.com/product/600)
- Microcontroller (I used a raspberry pi 4 but a zero w will work as well)

## APIs used
- [Quotable](https://quotable.io)
- [National Weather Service](https://www.weather.gov/documentation/services-web-api)
- [News API](https://newsapi.org/)
- [National Day API](https://national-api-day.herokuapp.com)

## Setup
Rename Example.settings.json to settings.json and fill in the needed
information.