mirror of https://github.com/home-assistant/operating-system.git synced 2025-11-09 10:58:36 +00:00

Files

Adam Griffiths a2accd3129 Documentation (#769 )

* spelling correction

* Restuctured, added "features", "supported hardware", intro for developers and links to the developer documentation.

* Spelling correction

* URL correction

* Documentation restructure

* Moving developer documentation index from top level README to Documentation directory README

* fixing URLS

* Restructuring and adding to board config

* Improving navigation of docs oon github

* New line after first heading

(https://github.com/home-assistant/operating-system/pull/768#discussion_r453336692)

Co-authored-by: Franck Nijhof <frenck@frenck.nl>

* Update README.md

https://github.com/home-assistant/operating-system/pull/768#discussion_r453336871

Co-authored-by: Franck Nijhof <frenck@frenck.nl>

* Update README.md

(https://github.com/home-assistant/operating-system/pull/768#discussion_r453336999)
- Surround headings with newlines
- ODROID
- Use dashes for unordered lists

Co-authored-by: Franck Nijhof <frenck@frenck.nl>

* Update README.md

- new line after heading
(https://github.com/home-assistant/operating-system/pull/768#discussion_r453337043)

Co-authored-by: Franck Nijhof <frenck@frenck.nl>

* Update README.md

- \- for unordered lists
- new line after heading
(https://github.com/home-assistant/operating-system/pull/768#discussion_r453337101)

Co-authored-by: Franck Nijhof <frenck@frenck.nl>

* Update README.md

- new line after heading
- \- for unordered lists
(https://github.com/home-assistant/operating-system/pull/768#discussion_r453337183)

Co-authored-by: Franck Nijhof <frenck@frenck.nl>

* Spelling correction, to ensure /Dpcumentation/kernel.mdhas the correct spelling

* capitalisation

* using - for unordered lists

* Adding links to config files

* fixing links to _defconfig files

* fixing link for rpi0_w

* fixing link for rpi3_64 and rpi4_64

* making the ova README consistent with the others

* formmating

* fixing numbered list

* fixing indent for sub-bullets

* questions regarding Tinker S and OVA support

* resolving PR comment from fabaff

* resolving PR comment from fabaff

* https://github.com/home-assistant/operating-system/pull/769\#discussion_r456774209

* Changing uBoot to U-Boot (https://github.com/home-assistant/operating-system/pull/769#discussion_r456774290)

* s/boot sector/eMMC boot partition/ (See https://github.com/home-assistant/operating-system/pull/769#discussion_r456774329)

* As per comments here:
https://github.com/home-assistant/operating-system/pull/769#discussion_r456791491
https://github.com/home-assistant/operating-system/pull/769#discussion_r456791580

* HassOS is no longer the official name (https://github.com/home-assistant/operating-system/pull/769#discussion_r456791863)

* Should be Home Assistant Operating System (or OS) (see https://community.home-assistant.io/t/changing-the-home-assistant-brand/167500/16). See also commennts here https://github.com/home-assistant/operating-system/pull/769#discussion_r456793030, taken in to account along with previous comments about this paragraph.

* s/HassOS/Home Assistant Operating System/

* 8Gb Pi 4 will be supported soon (see comment https://github.com/home-assistant/operating-system/pull/769#discussion_r459768349)

* resolving conflict with main dev branch.

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
Co-authored-by: Pascal Vizeli <pvizeli@syshack.ch>

2020-08-03 14:44:32 +00:00

README.md

Documentation (#769 )

2020-08-03 14:44:32 +00:00

README.md

Raspberry PI

Supported Hardware

Device	Release Date	Support	Config
Raspberry Pi B/B+/A+	2012/2014/2014	not recommended	rpi
Raspberry Pi 2 B	2015	not recommended	rpi2
Raspberry Pi Zero	2015	not recommended	rpi
Raspberry Pi Zero W	2017	not recommended	rpi0_w
Raspberry Pi 3 B/B+	2016/2018	yes	rpi3 / rpi3_64
Raspberry Pi 4 B	2019	yes*	rpi4 / rpi4_64

*1,2 and 4 GiB versions of the Raspberry Pi 4 B are supported. Support for the 8 GiB version is coming soon is part of #740.

Limitation 64bit

The 64bit version is under development by RPi-Team. It work very nice but it could have some impacts. Actual we see that the SDcard access with ext4 are a bit slower than on 32bit.

Serial console

For access to terminal over serial console, add console=ttyAMA0,115200 to cmdline.txt and enable_uart=1, dtoverlay=pi3-disable-bt into config.txt. GPIO pins are: 6 = GND / 8 = UART TXD / 10 = UART RXD.

I2C

Add dtparam=i2c1=on and dtparam=i2c_arm=on to config.txt. After that we create a module file on host with config usb stick or direct into /etc/modules-load.d.

rpi-i2c.conf:

i2c-dev
i2c-bcm2708

USB Boot

USB mass storage boot is available on Raspberry Pi 3B, 3B+, 3A+, and 2B v1.2. To enable USB boot, add program_usb_boot_mode=1 into config.txt. Note that this permanently alters the one-time programmable memory of the device.

For more information see RaspberryPi.

Caveats

All bootable SD cards must be removed.
Boot time can be significantly longer with USB. This is due to the boot process first attempting to boot from SD card, failing, and resorting to USB.
Many USB drives simply do not work for boot. This is likely due to minimal driver support in uboot and will not be fixed. If you can't get it to boot on one drive, try a different brand/model. SanDisk Cruzer drives seem to have a higher rate of issues.

Tweaks

If you don't need bluetooth, disabled it with add dtoverlay=pi3-disable-bt into config.txt.