Fix I2C documentation (#14381)

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
Stefan Agner 2020-09-03 11:08:14 +02:00 committed by GitHub
parent 6521557c3c
commit 539c66a925
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,6 +1,6 @@
--- ---
title: "Enable I2C on the Home Assistant Operating System" title: "Enable I2C on the Home Assistant Operating System"
description: "Instructions on how to enable I2C on a Raspberry PI" description: "Instructions on how to enable I2C on a Raspberry Pi"
--- ---
Home Assistant using the Home Assistant Operating System is a managed environment, which means you can't use existing methods to enable the I2C bus on a Raspberry Pi. Home Assistant using the Home Assistant Operating System is a managed environment, which means you can't use existing methods to enable the I2C bus on a Raspberry Pi.
@ -11,35 +11,38 @@ If you're attempting to add an external sensor you will have to [enable the I2C
You will need: You will need:
- USB drive - SD card reader
- A way to add files to the USB drive - SD card with Home Assistant Operating System flashed on it
- A way to connect the drive to your Raspberry Pi
### Step 1 - Prepare the USB drive ### Step 1 - Access the Home Assistant OS boot partition
Connect the USB drive to a device capable of adding and editing files to the USB drive. Shutdown/turn-off your Home Assistant installation and unplug the SD card.
Plug the SD card into an SD card reader and find a drive/file system named
Format a USB stick with FAT32/EXT4/NTFS and name the drive `CONFIG` (uppercase). `hassos-boot`. The file system might be shown/mounted automatically. If not,
use your operating systems disk management utility to find the SD card reader
and make sure the first partition is available.
### Step 2 - Add files to enable I2C ### Step 2 - Add files to enable I2C
- In the root of the USB drive add a folder called `/modules`. - In the root of the `hassos-boot` partition, add a new folder called `CONFIG`.
- Inside that folder add a text file called `rpi-i2c.conf` with the following contents: - In the `CONFIG` folder, add another new folder called `modules`.
- Inside the `modules` folder add a text file called `rpi-i2c.conf` with the following content:
```txt ```txt
i2c-bcm2708
i2c-dev i2c-dev
``` ```
- In the root of the USB drive add a file called `config.txt` with the following contents: - In the root of the USB drive edit the file called `config.txt` add two lines
to it:
```txt ```txt
dtparam=i2c1=on dtparam=i2c_vc=on
dtparam=i2c_arm=on dtparam=i2c_arm=on
``` ```
### Step 3 - Load the new USB configuration ### Step 3 - Start with the new configuration
- Insert the USB drive into your Raspberry Pi. - Insert the SD card back into your Raspberry Pi.
- Now go to your Home Assistant web interface, in the sidebar click **Supervisor** > **System**. - On startup, the `hassos-config.service` will automatically pickup the new
- Now click `Import from USB`. `rpi-i2c.conf` configuration.
- This will restart your Home Assistant instance, and load the new USB configuration. - Another reboot might be necessary to make sure the just imported `rpi-i2c.conf` is
present at boot time.
When the service has restarted, you will have a working I2C interface. The I2C devices should now be present under /dev.