ha-operating-system/Documentation/boards/README.md

63 lines
5.0 KiB
Markdown
Raw Permalink Normal View History

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 16:31:36 +02:00
# Boards
## Overview
The following boards/devices are supported:
- Nabu Casa
- [Home Assistant Green](https://www.home-assistant.io/green/)
- [Home Assistant Yellow](https://www.home-assistant.io/yellow/) (based custom carrier board and powered by a Raspberry Pi 4 Compute Module)
- [Home Assistant Blue](https://www.home-assistant.io/blue/) (based on ODROID-N2+)
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 16:31:36 +02:00
- Raspberry Pi
Initial Raspberry Pi 5 support (#2914) * Add initial Raspberry Pi 5 buildroot config * Add machine-id support via cmdline.txt * Add new entry if entry is missing * Don't overwrite cmdline.txt when adding machine-id Use sed to append the new cmdline parameter to the first line. * Skeleton script for RAUC custom bootloader interface * Deploy kernel/device-tree into a RAUC slot specific directory This allows us to use the os_prefix feature to switch between slot A and B. Compared to the boot_partition option, this option allows to use a shared config.txt and cmdline.txt, which makes it more like how HAOS currently works on other Raspberry Pis. * Deploy new kernel/device-tree to correct slot on installation * Increase boot size to 128MB This makes sure we can store up to three kernels (slot A, B and an temporary one while installing the OTA update). * Initial tryboot implementation using os_prefix * Make sure to delete the old slot completely * Add Busybox xargs for tryboot bootloader script * Compare tryboot bootloader file silently * Revert "Increase boot size to 128MB" This reverts commit 7f2c69b58f02f500d6aeee4f0a419046899b5e38. * Use compressed kernel * Address shellcheck * Address shellcheck issue in rauc-hook * Fix shellcheck for rpi-tryboot.sh * Do not follow source - it gets checked separately * Correctly set the slot to boot * Apply suggestions from code review Co-authored-by: Jan Čermák <sairon@users.noreply.github.com> * Drop serial console from default cmdline.txt * Resync rpi5_64_defconfig with rpi4_64_defconfig * Improve machine-id match Only match actual hexadecimal characters. * Deploy firmware overlays to OS prefix directory * Add Raspberry Pi 5 to documentation * Bump buildroot * buildroot fd1dc86f40...f13ad03408 (1): > linux: add in-tree device tree overlay support * Install device tree overlays from Kernel sources * Drop RPi RF modules for now No Raspberry Pi 5 specific device tree overlays are available, drop RPi RF mod for now. * Use Raspberry 5 specific identifiers for Supervisor/OS Agent * Bump buildroot * buildroot f13ad03408...07e08e01b2 (1): > linux: fix add in-tree device tree overlay support * Revert "Drop RPi RF modules for now" This reverts commit 46fc1701e4b66dab7367d8a0face79cfa3b98cbd. --------- Co-authored-by: Jan Čermák <sairon@users.noreply.github.com>
2023-12-12 13:19:26 +01:00
- Pi 5 ([4 GB](https://www.raspberrypi.com/products/raspberry-pi-5/?variant=raspberry-pi-5-4gb) and [8 GB](https://www.raspberrypi.com/products/raspberry-pi-5/?variant=raspberry-pi-5-8gb) model) 64-bit
- Pi 4 Model B ([1 GB](https://www.raspberrypi.com/products/raspberry-pi-4-model-b/?variant=raspberry-pi-4-model-b-1gb), [2 GB](https://www.raspberrypi.com/products/raspberry-pi-4-model-b/?variant=raspberry-pi-4-model-b-2gb), [4 GB](https://www.raspberrypi.com/products/raspberry-pi-4-model-b/?variant=raspberry-pi-4-model-b-4gb) and [8 GB](https://www.raspberrypi.com/products/raspberry-pi-4-model-b/?variant=raspberry-pi-4-model-b-8gb) model) 32-bit or 64-bit (recommended)
- [Pi 3 Model B](https://www.raspberrypi.com/products/raspberry-pi-3-model-b/) and [B+](https://www.raspberrypi.com/products/raspberry-pi-3-model-b-plus/) 32-bit or 64-bit (recommended)
- [Pi 2](https://www.raspberrypi.com/products/raspberry-pi-2-model-b/) (not recommended)
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 16:31:36 +02:00
- Hardkernel
- [ODROID-C2](https://www.hardkernel.com/shop/odroid-c2/) (discontinued)
- [ODROID-C4](https://www.hardkernel.com/shop/odroid-c4/)
- [ODROID-M1](https://www.hardkernel.com/shop/odroid-m1/)
- ODROID-M1S [4 GB](https://www.hardkernel.com/shop/odroid-m1s-with-4gbyte-ram/) or [8 GB](https://www.hardkernel.com/shop/odroid-m1s-with-8gbyte-ram/)
- [ODROID-N2](https://www.hardkernel.com/shop/odroid-n2/) (discontinued)
- ODROID-N2+ [2 GB](https://www.hardkernel.com/shop/odroid-n2-with-2gbyte-ram-2/) or [4 GB](https://www.hardkernel.com/shop/odroid-n2-with-4gbyte-ram-2/)
- [ODROID-XU4](https://www.hardkernel.com/shop/odroid-xu4-special-price/)
- Asus
- [Tinker Board](https://tinker-board.asus.com/product/tinker-board.html)
- Generic x86-64 (UEFI, not suited for virtualization)
- [Intel NUC5CPYH](https://www.intel.com/content/www/us/en/products/sku/85254/intel-nuc-kit-nuc5cpyh/specifications.html)
- [Intel NUC6CAYH](https://www.intel.com/content/www/us/en/products/sku/95062/intel-nuc-kit-nuc6cayh/specifications.html)
- [Intel NUC10I3FNK2](https://www.intel.com/content/www/us/en/products/sku/195503/intel-nuc-10-performance-kit-nuc10i3fnk/specifications.html)
- [Gigabyte GB-BPCE-3455](https://www.gigabyte.com/Mini-PcBarebone/GB-BPCE-3455-rev-10/sp#sp)
2021-08-05 18:32:15 +02:00
- Computers supporting x86-64 architecture and UEFI boot should generally work
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 16:31:36 +02:00
- Virtual appliance (x86_64/UEFI):
- VMDK
- OVA ?
- VHDX ?
- VDI ?
- QCOW2 ?
Notes:
- see ? above: are these currently supported? see ova documentation which explains issues with previous OVA distribution)
## Board specifics
|Board|Build|Config|Docs|
|-----|----|------|----|
|Green |`make green` |[green](../../buildroot-external/configs/green_defconfig)|-|
|Yellow |`make yellow` |[yellow](../../buildroot-external/configs/yellow_defconfig)|-|
Initial Raspberry Pi 5 support (#2914) * Add initial Raspberry Pi 5 buildroot config * Add machine-id support via cmdline.txt * Add new entry if entry is missing * Don't overwrite cmdline.txt when adding machine-id Use sed to append the new cmdline parameter to the first line. * Skeleton script for RAUC custom bootloader interface * Deploy kernel/device-tree into a RAUC slot specific directory This allows us to use the os_prefix feature to switch between slot A and B. Compared to the boot_partition option, this option allows to use a shared config.txt and cmdline.txt, which makes it more like how HAOS currently works on other Raspberry Pis. * Deploy new kernel/device-tree to correct slot on installation * Increase boot size to 128MB This makes sure we can store up to three kernels (slot A, B and an temporary one while installing the OTA update). * Initial tryboot implementation using os_prefix * Make sure to delete the old slot completely * Add Busybox xargs for tryboot bootloader script * Compare tryboot bootloader file silently * Revert "Increase boot size to 128MB" This reverts commit 7f2c69b58f02f500d6aeee4f0a419046899b5e38. * Use compressed kernel * Address shellcheck * Address shellcheck issue in rauc-hook * Fix shellcheck for rpi-tryboot.sh * Do not follow source - it gets checked separately * Correctly set the slot to boot * Apply suggestions from code review Co-authored-by: Jan Čermák <sairon@users.noreply.github.com> * Drop serial console from default cmdline.txt * Resync rpi5_64_defconfig with rpi4_64_defconfig * Improve machine-id match Only match actual hexadecimal characters. * Deploy firmware overlays to OS prefix directory * Add Raspberry Pi 5 to documentation * Bump buildroot * buildroot fd1dc86f40...f13ad03408 (1): > linux: add in-tree device tree overlay support * Install device tree overlays from Kernel sources * Drop RPi RF modules for now No Raspberry Pi 5 specific device tree overlays are available, drop RPi RF mod for now. * Use Raspberry 5 specific identifiers for Supervisor/OS Agent * Bump buildroot * buildroot f13ad03408...07e08e01b2 (1): > linux: fix add in-tree device tree overlay support * Revert "Drop RPi RF modules for now" This reverts commit 46fc1701e4b66dab7367d8a0face79cfa3b98cbd. --------- Co-authored-by: Jan Čermák <sairon@users.noreply.github.com>
2023-12-12 13:19:26 +01:00
|Pi5 64-bit |`make rpi5_64` |[rpi5_64](../../buildroot-external/configs/rpi5_64_defconfig)|[raspberrypi](./raspberrypi/)|
|Pi4B 64-bit |`make rpi4_64` |[rpi4_64](../../buildroot-external/configs/rpi4_64_defconfig)|[raspberrypi](./raspberrypi/)|
|Pi4B 32-bit |`make rpi4` |[rpi4](../../buildroot-external/configs/rpi4_defconfig)|[raspberrypi](./raspberrypi/)|
|Pi3B 64-bit |`make rpi3_64` |[rpi3_64](../../buildroot-external/configs/rpi3_64_defconfig)|[raspberrypi](./raspberrypi/)|
|Pi3B 32-bit |`make rpi3` |[rpi3](../../buildroot-external/configs/rpi3_defconfig)|[raspberrypi](./raspberrypi/)|
|Pi2 |`make rpi2` |[rpi2](../../buildroot-external/configs/rpi2_defconfig)|[raspberrypi](./raspberrypi/)|
|ODROID-C2 |`make odroid_c2` |[odroid_c2](../../buildroot-external/configs/odroid_c2_defconfig)|[hardkernel](./hardkernel/)|
|ODROID-C4 |`make odroid_c4` |[odroid_c4](../../buildroot-external/configs/odroid_c4_defconfig)|[hardkernel](./hardkernel/)|
|ODROID-M1 |`make odroid_m1` |[odroid_m1](../../buildroot-external/configs/odroid_m1_defconfig)|[hardkernel](./hardkernel/)|
|ODROID-M1S |`make odroid_m1s` |[odroid_m1s](../../buildroot-external/configs/odroid_m1s_defconfig)|[hardkernel](./hardkernel/)|
|ODROID-N2/N2+ |`make odroid_n2` |[odroid_n2](../../buildroot-external/configs/odroid_n2_defconfig)|[hardkernel](./hardkernel/)|
|ODROID-XU4 |`make odroid_xu4` |[odroid_xu4](../../buildroot-external/configs/odroid_xu4_defconfig)|[hardkernel](./hardkernel/)|
|Tinker Board |`make tinker` |[tinker](../../buildroot-external/configs/tinker_defconfig)|[asus](./asus/)|
|Generic x86-64|`make generic_x86_64`|[generic_x86_64](../../buildroot-external/configs/generic_x86_64_defconfig)|[generic-x86-64](./generic-x86-64/)|
|OVA |`make ova` |[ova](../../buildroot-external/configs/ova_defconfig)|[ova](./ova/)|