diff --git a/_config.yml b/_config.yml index 4b610b749b7..f7aab25882a 100644 --- a/_config.yml +++ b/_config.yml @@ -211,6 +211,8 @@ installation: key: "odroid-c4" - name: "ODROID-M1" key: "odroid-m1" + - name: "ODROID-M1S" + key: "odroid-m1s" raspberrypi: board: Raspberry Pi diff --git a/source/_includes/common-tasks/flashing_m1s_otg.md b/source/_includes/common-tasks/flashing_m1s_otg.md new file mode 100644 index 00000000000..132a4bb2667 --- /dev/null +++ b/source/_includes/common-tasks/flashing_m1s_otg.md @@ -0,0 +1,47 @@ +## Flashing an ODROID-M1S + +Home Assistant can be flashed to an ODROID-M1S by connecting the device directly to your computer via the USB-OTG connection on the front of the board. +Unlike other ODROID boards, the M1S does not have a socket for an optional eMMC module. It also does not have a separate flash chip that holds a dedicated bootloader. +Instead, the M1S has a build-in 64GB eMMC soldered directly on the board that holds a bootloader by default. This guide will show you how to install the Home Assistant Operating System to the built-in eMMC. + +**Warning: Installing Home Assistant OS replaces the firmware and SPL on the eMMC with the mainline version provided by the Home Assistant OS. As a result, it is not possible to use the SD card with the EMMC2UMS image anymore, because the mainline SPL is not compatible with U-Boot in the EMMC2UMS image at this time (February 2024). This does not pose any problem for standard use, just makes it more complicated in case you want to return to the Hardkernel-provided OS (see [HK Recovery](#hk-recovery)).** + +### What you will need + +To flash your eMMC using USB-OTG, you will need the following items: + +- A small SD card +- Another computer +- USB 2.0 to micro-USB cable +- the special Hardkernel eMMC-to-USB-mass-storage image + +### Boot into mass-storage mode + +(These steps are identical to the official [Hardkernel wiki](https://wiki.odroid.com/odroid-m1s/getting_started/os_installation_guide?redirect=1#install_over_usb_from_pc) page.) + +1. Download [ODROID-M1S_EMMC2UMS.img](https://dn.odroid.com/RK3566/ODROID-M1S/Installer/ODROID-M1S_EMMC2UMS.img). +2. Use [balena Etcher](https://www.balena.io/etcher/) or another tool to flash the UMS utility onto an SD card. + - Use **Flash from file**. **Flash from URL** does not work on all systems. + (balena Etcher will complain that something went wrong during flashing. You can ignore this message) +3. Plug-in that SD card to your ODROID-M1S and boot it. + +### Flashing Home Assistant M1S + +1. Download the latest stable version of Home Assistant OS for the [ODROID-M1S](https://github.com/home-assistant/operating-system/releases/download/{{site.data.version_data.hassos['odroid-m1s']}}/haos_odroid-m1s-{{site.data.version_data.hassos['odroid-m1s']}}.img.xz). +2. Apart from the HAOS image to flash (M1S instead of N2+ version), you can follow the N2+ step-by-step flashing guide [HERE](/common-tasks/os/#flashing-home-assistant). + + +#### _HK Recovery_ + +If you want to restore your M1S back into Hardkernel's initial state, you will have to restore the HK's bootloader. +A reliable way of reflashing the eMMC with an operating system of your choice is to use Home Assistant OS to flash the EMMC2UMS image which turns the ODROID-M1S into USB Mass Storage device. Once you have flashed the EMMC2UMS image, you can flash any OS again. You will need a micro USB cable to connect ODROID-M1S to PC. + +Note: This commands will render your current Home Assistant OS installation unbootable! + +Use the local terminal (HDMI/keyboard) to access the system console. On the Home Assistant CLI (command line), enter `login` to enter the root shell and use `curl` to download an image and `dd` it to the eMMC block device: + +```sh +curl https://dn.odroid.com/RK3566/ODROID-M1S/Installer/ODROID-M1S_EMMC2UMS.img | dd of=/dev/mmcblk0 +``` + +This way, the device will start in the UMS mode on the next boot with the SD card removed. Follow the [Install over USB from PC](https://wiki.odroid.com/odroid-m1s/getting_started/os_installation_guide#install_over_usb_from_pc) to install a different operating system. diff --git a/source/_includes/installation/operating_system.md b/source/_includes/installation/operating_system.md index 1ec96df004a..73f64578b7e 100644 --- a/source/_includes/installation/operating_system.md +++ b/source/_includes/installation/operating_system.md @@ -12,26 +12,26 @@ Follow this guide if you want to get started with Home Assistant easily or if yo You will need a few things to get started with installing Home Assistant. The links below lead to Ameridroid. If you’re not in the US, you should be able to find these items in web stores in your country. -To get started, we suggest the ODROID N2+, the board that powers our [Home Assistant Blue](/blue/), or the ODROID M1. +To get started, we suggest the ODROID-N2+, the board that powers our [Home Assistant Blue](/blue/), or the ODROID-M1. -If unavailable, we also recommend the [ODROID C4](https://ameridroid.com/products/odroid-c4?ref=eeb6nfw07e). +If unavailable, we also recommend the [ODROID-C4](https://ameridroid.com/products/odroid-c4?ref=eeb6nfw07e). Home Assistant bundles (US market): The bundles come with Home Assistant pre-installed. -- [ODROID N2+: 2 GB RAM / 16 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44748729286935?ref=eeb6nfw07e) -- [ODROID N2+: 4 GB RAM / 64 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44748729221399?ref=eeb6nfw07e) -- ODROID M1: 4 GB RAM / 256 GB NVMe / [16 GB µSD](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44929573028119?ref=eeb6nfw07e) or [16 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44994940567831?ref=eeb6nfw07e) -- ODROID M1: 8 GB RAM / 256 GB NVMe / [16 GB µSD](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44929573093655?ref=eeb6nfw07e) or [16 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44994940633367?ref=eeb6nfw07e) -- [ODROID M1: 8 GB RAM / 1 TB NVMe / 64 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44994940698903?ref=eeb6nfw07e) +- [ODROID-N2+: 2 GB RAM / 16 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44748729286935?ref=eeb6nfw07e) +- [ODROID-N2+: 4 GB RAM / 64 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44748729221399?ref=eeb6nfw07e) +- ODROID-M1: 4 GB RAM / 256 GB NVMe / [16 GB µSD](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44929573028119?ref=eeb6nfw07e) or [16 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44994940567831?ref=eeb6nfw07e) +- ODROID-M1: 8 GB RAM / 256 GB NVMe / [16 GB µSD](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44929573093655?ref=eeb6nfw07e) or [16 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44994940633367?ref=eeb6nfw07e) +- [ODROID-M1: 8 GB RAM / 1 TB NVMe / 64 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44994940698903?ref=eeb6nfw07e) Variants without pre-installed Home Assistant: -- ODROID N2+, [2 GB RAM](https://ameridroid.com/products/odroid-n2-plus?variant=40371828719650?ref=eeb6nfw07e) or [4 GB RAM](https://ameridroid.com/products/odroid-n2-plus?variant=40371828752418?ref=eeb6nfw07e) -- [ODROID C4](https://ameridroid.com/products/odroid-c4?ref=eeb6nfw07e) -- [ODROID M1](https://ameridroid.com/products/odroid-M1?ref=eeb6nfw07e) - +- ODROID-N2+, [2 GB RAM](https://ameridroid.com/products/odroid-n2-plus?variant=40371828719650?ref=eeb6nfw07e) or [4 GB RAM](https://ameridroid.com/products/odroid-n2-plus?variant=40371828752418?ref=eeb6nfw07e) +- [ODROID-C4](https://ameridroid.com/products/odroid-c4?ref=eeb6nfw07e) +- [ODROID-M1](https://ameridroid.com/products/odroid-M1?ref=eeb6nfw07e) +- ODROID-M1S, [4 GB RAM](https://ameridroid.com/products/odroid-m1s?variant=47425396474135?ref=eeb6nfw07e) or [8 GB RAM](https://ameridroid.com/products/odroid-m1s?variant=47425396506903?ref=eeb6nfw07e) - [Power Supply](https://ameridroid.com/products/12v-2a-power-supply-plug?ref=eeb6nfw07e) - [CR2032 Coin Cell](https://ameridroid.com/products/rtc-bios-battery?ref=eeb6nfw07e) - [eMMC Module](https://ameridroid.com/products/emmc-module-n2-linux-red-dot?ref=eeb6nfw07e) @@ -162,9 +162,11 @@ Use this method only if Method 1 does not work for you. - Back up your data before continuing with the next step. 2. Attach the Home Assistant boot medium ({{site.installation.types[page.installation_type].installation_media}}) to your computer. {% if page.installation_type == 'odroid' %} - If you are using ODROID M1, note that booting from NVMe is not supported. If you want to boot from eMMC, [update the firmware](https://github.com/home-assistant/operating-system/blob/dev/Documentation/boards/hardkernel/odroid-m1.md) before installing the image. + If you are using ODROID-M1, note that booting from NVMe is not supported. If you want to boot from eMMC, [update the firmware](https://github.com/home-assistant/operating-system/blob/dev/Documentation/boards/hardkernel/odroid-m1.md) before installing the image. - If you are using a [Home Assistant Blue](/blue) or ODROID N2+, you can [attach your device directly](/common-tasks/os/#flashing-an-odroid-n2). + If you are using a [Home Assistant Blue](/blue) or ODROID-N2+, you can [attach your device directly](/common-tasks/os/#flashing-an-odroid-n2). + + If you are using an ODROID-M1S, you need to follow this guide to [boot your device into UMS mode](/common-tasks/os/#flashing-an-odroid-m1s). {% endif %} 3. Download and start Balena Etcher. You may need to run it with administrator privileges on Windows. 4. Download the image to your computer. @@ -182,7 +184,9 @@ Use this method only if Method 1 does not work for you. ``` {% if variant.key == "odroid-n2" %} - [Guide: Flashing Odroid-N2 using OTG-USB](/hassio/flashing_n2_otg/) + [Guide: Flashing ODROID-N2 using OTG-USB](/hassio/flashing_n2_otg/) + {% elsif variant.key == "odroid-m1s" %} + [Guide: Flashing ODROID-M1S using OTG-USB](/hassio/flashing_m1s_otg/) {% elsif variant.key == "rpi4" or variant.key == "rpi3" %} *(64-bit is recommended)* {% endif %} @@ -212,7 +216,7 @@ Use this method only if Method 1 does not work for you. 9. Select **Flash!** to start writing the image. - If the operation fails, decompress the .xz file and try again. ![Screenshot of the Etcher software showing the Flash button highlighted.](/images/installation/etcher5.png) -1. When Balena Etcher has finished writing the image, you will see a confirmation. + - When Balena Etcher has finished writing the image, you will see a confirmation. ![Screenshot of the Etcher software showing that the installation has completed.](/images/installation/etcher6.png) ### Start up your {{site.installation.types[page.installation_type].board}} diff --git a/source/common-tasks/os.markdown b/source/common-tasks/os.markdown index 73be58794e5..f8303d89533 100644 --- a/source/common-tasks/os.markdown +++ b/source/common-tasks/os.markdown @@ -19,5 +19,6 @@ This section will provide guides to some common tasks and information which you {% include common-tasks/third-party-addons.md %} {% include common-tasks/data_disk.md %} {% include common-tasks/flashing_n2_otg.md %} +{% include common-tasks/flashing_m1s_otg.md %} {% include common-tasks/enable_i2c.md %}