Browse Source

Update hardware docs and main readme

master
KemoNine 1 year ago
parent
commit
af9f871cfa
  1. 16
      README.md
  2. 13
      hardware.md

16
README.md

@ -1,12 +1,12 @@
# PiFrame
This repo contains everything you need to build a digital Photo Frame using a Raspberry Pi
This repo contains everything you need to build a high resolution digital Photo Frame using a Raspberry Pi.
# Project Status
This is very much a Work In Progress project. Early prototype builds based on rough documenation (see [notes.txt](notes.txt) and [docs/](docs/) are online and being tested.
The project is currently well into beta territory, borderline release candidate. We are still reviewing LCD hardware selections but the core software and non-LCD hardware is stable.
Additional tuning, documentation and integrations will be added to the repo over time.
If you have an existing LCD or don't mind sourcing one and configuring it you can put together a very stable photo frame today.
# IMPORTANT CONSIDERATIONS
@ -14,7 +14,7 @@ Additional tuning, documentation and integrations will be added to the repo over
The PiFrame project does **NOT** use SSL for anything unless it's a default setting for a given service. We have optimized the project to be managed via a trusted LAN and/or VPN solution (for multiple frames).
Use acme.sh + vhosts + nginx if you really want SSL. There is plenty of great information online how to set up acme.sh + nginx + vhosts + SSL if you want to go this route.
You can use acme.sh + vhosts + nginx if you really want SSL. There is plenty of great information online how to set up acme.sh + nginx + vhosts + SSL if you want to go this route.
We will not discuss, entertain or bother debating our decision regarding SSL. It's an additional layer of complexity and not strictly required for the purposes of this project.
@ -22,6 +22,14 @@ We will not discuss, entertain or bother debating our decision regarding SSL. It
Please see [hardware.md](hardware.md) for details regarding hardware selection and requirements.
# Remixes
We provide documentation on how to build a photo frame with high resolution display backed by a Raspberry Pi 4. Nothing stops you from applying this information to other boards, screens and hardware.
*However*, we will *NOT* support hardware and configuration deviations from the information provided in this repository. We've spent a lot of time ensuring everything works well together and is stable.
If you would like to submit ideas based on a remix or similar, please reach out and let us know via a ticket in this repo. We aren't opposed to improving our PiFrames but we want to be sure stability and accessibility come first.
# Licensing
Unless otherwise stated all source code is licensed under the [Apache 2 License](LICENSE-APACHE-2.0.txt).

13
hardware.md

@ -7,21 +7,18 @@ This is a surprisingly straight forward project that has minimal in the way of h
* **Please note: RAM usage is significantly affected by source image resolution /and/ panel size. 2Gb of RAM should be enough for a 2k screen and 20Mpx source images. If you're not sure get a 4Gb Raspberry Pi.**
* HDMI Monitor (Verified Working)
* Please note: **these are the panels we KNOW WORK** ; do not deviate unless you want to fiddle with a lot of boot loader configuration
* [CONFU 5.5" 2k (1440x2560)](https://www.alibaba.com/product-detail/CONFU-HDMI-to-MIPI-5-5_62010868927.html)
* This section is currently being overhauled. We found a supplier on Alibaba (see wisecoco below) that has panels in 2k and 4k resolution ranging in size from 6 inches to 15.6 inches. We will be contacting them for samples and LCDs for testing and verification. Others have used this supplier with great success and we plan on working with them for PiFrame panel sourcing as appropriate. We will update this section of the docs after we've had a chance to get feedback from the supplier.
* HDMI Monitor (TESTING)
* Please note: **these are the panels we are TESTING** ; do not use these unless you'd like to help us sort the settings needed for use
* [Generic 5.5" 1080p panel](https://www.alibaba.com/product-detail/Low-price-5-5-inch-Sharp_62399659373.html)
* [wisecoco panels](https://wisecoco.en.alibaba.com/)
* [Geekworm Armor Case](https://geekworm.com/products/raspberry-pi-4-model-b-armor-aluminum-alloy-case-protective-shell)
* If you would like an always on fan, select the model with the integrated fan option
* [Pimoroni Fan SHIM](https://shop.pimoroni.com/products/fan-shim)
* This has better cooling as well as on/off support
* You probably want this instead of the Geekworm armor case with fans
* This has better cooling than a heat sink as well as on/off support
* You probably want this instead of the more common heat sink cases and similar
* This will **NOT** require soldering to use but assumes you have room to slip the fan all the way down on the main header
* USB to Serial adapter
* There are a lot of options, choose one you know that will work well
* Mini HDMI to HDMI adapter
* HDMI cable
* Adafruit and SparkFun are good choices for serial to usb adapters
* HDMI cable that will work with your panel and the Raspberry Pi. You can use an adapter if needed.
* USB disk (thumb drive / ssd) for storing pictures
* This is optional but will help prevent micro sd card wear if regularly changing photos or running backups
* The Sandisk Ultra Fit USB disks are great options and work well with the Raspberry Pi boards

Loading…
Cancel
Save