SunFounder Addon for Home assistant

• SunFounder Addon for Home assistant
  • Pironman Addon
    • Tutorial
      • Setup config.txt
      • Install the Addon
        • Click the button below to install the addon
        • Or install it manually:
      • Setup
      • Configure
  • Development
    • Cleanup image cache
    • Login the running addon container for debgging
    • Run the image if it's not running as error occurred
    • Home Assistant Supervisor log
    • App Armor
  • 准备工作
    • 安装 Docker Buildx
    • 安装 QEMU 仿真器
  • Publish
    • 登录
    • 编译并上传

Pironman Addon

Tutorial

Setup config.txt

You need to setup config.txt to enable I2C and SPI for Pironman.

This only works for Home Assistant OS, running on Raspberry Pi. Not for Home Assistant Container.

You will need:

• SD card reader
• SD card with Home Assistant Operating System flashed on it

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 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.

• In the root of the hassos-boot partition, add a new folder called CONFIG.
• 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:

  i2c-dev
  

• In the root of the hassos-boot partition, edit the file called config.txt add four lines to the bottom:

  dtparam=i2c_vc=on
  dtparam=i2c_arm=on
  dtoverlay=gpio-poweroff,gpio_pin=26,active_low=0
  dtoverlay=gpio-ir,gpio_pin=13
  

• To enable RGB, selected one driver and make sure you set up the main board respectivly. continue editing the config.txt file:

  Earlier version of pironman only have one driver, PWM(GPIO12).

  • For PWM(GPIO12), it use audio to drive the led, so turn off the audio.

    dtparam=audio=off
    

  • For SPI(GPIO10), it use spi to drive the led, so turn on the spi, set core freq to 500. Enable audio if you need it.

    dtparam=spi=on
    core_freq=500
    core_freq_min=500
    # Enable audio if you need it.
    dtparam=audio=on
    

  • For PCM(GPIO21), it use PCM to drive the led, it doesn't need to set anything. But it will interfer with I2S device, so make sure you disable them, like hifiberry-dac or i2s-mmap. Enable audio if you need it.

    # Enable audio if you need it.
    dtparam=audio=on
    # Comment out the i2s device.
    # dtoverlay=hifiberry-dac
    # dtoverlay=i2s-mmap
    

• Eject the SD card and plug it back into your Raspberry Pi and boot it up.

Install the Addon

Click the button below to install the addon

Or install it manually:

1. On Home Assistant, navigator to Configuration -> Addons -> Addon Store
2. Click the top right corner button to open the menu, select Repositories
3. Type in the repository url: https://github.com/sunfounder/home-assistant-addon, click Add
4. After SunFounder repository added, close the popup window
5. Click the top right corner button again to open the menu, select Reload
6. Wait a few seconds, the SunFounder repository will show up in the addon store with Pironman following. If not, try to refresh the page.
7. Click on Pironman, then click Install.

Setup

Currently, you need to disable protection mode to allow the addon to access hardware informations.

To do so, in Pironman addon page, (Configuration -> Addons -> Pironman). Find Protection Mode, and turn it off. Then, restart the addon.

Change to the Log tab, and see if there's any error. If not, you can continue to the next step.

Configure

You can change the configuration in the Configuration tab. Navigate to Configuration tab, and change the settings.

Development

Development instruction for addon developer.

Cleanup image cache

Image may not be updated after rebuild. To force rebuild, you need to clean up the image cache. uninstall the addon first, then run the following command to clean up the image cache.

docker image prune -af

Login the running addon container for debgging

Find the container name

docker ps

replace the <container_name> in the following command

docker exec -it <container_name> /bin/bash

Run the image if it's not running as error occurred

# List all images
docker images

# Run the image
docker run -it <image_name>:<tag> /bin/bash

Home Assistant Supervisor log

See supervisor log for appon reflash and install errors

docker logs hassio_supervisor -f

App Armor

Check if complain enabled

docker inspect addon_local_pironman | grep "AppArmorProfile"

准备工作

如果你需要在windows 要在 x86_64 架构的 Linux 主机上编译 aarch64（ARM64）架构的 Docker 镜像，需要使用 Docker Buildx 和 QEMU 跨架构仿真技术。以下是详细的操作步骤：

安装 Docker Buildx

首先，确保你的 Linux 主机上已经安装了 Docker。如果没有安装，可以参考 Docker 官方文档进行安装。

安装 Docker Buildx 插件：

# 启用 Buildx
docker buildx install

# 创建并使用支持多架构的 builder
docker buildx create --name multiarch --use

安装 QEMU 仿真器

QEMU 是一个开源的虚拟机模拟器，可以用于在 x86_64 架构的 Linux 主机上运行 ARM64 架构的虚拟机。

# 安装 QEMU 静态二进制文件
docker run --rm --privileged multiarch/qemu-user-static --reset -p yes

Publish

可以在Windows下执行，但是需要安装Docker Desktop, 然后打开软件，登录，看到左下角显示Engine running.

登录

登录docker。如果在Windows下，在Docker Desktop上登录，可以省略这一步。

docker login

编译并上传

进入需要编译的插件根目录下，执行以下命令： 注意修改名称和版本号。注意确认基础镜像的版本号。

docker buildx build --platform linux/arm64/v8 --build-arg BUILD_FROM=ghcr.io/hassio-addons/ubuntu-base/aarch64:10.0.5 -t sunfounder/aarch64-pironman5:1.2.12 --push .
docker buildx build --platform linux/arm64/v8 --build-arg BUILD_FROM=ghcr.io/hassio-addons/ubuntu-base/aarch64:10.0.5 -t sunfounder/aarch64-pi-config-wizard:1.0.3 --push .

Warning

如果报错：

ERROR: error during connect: this error may indicate that the docker daemon is not running: Head "http://%2F%2F.%2Fpipe%2Fdocker_engine/_ping": open //./pipe/docker_engine: The system cannot find the file specified.

请先启动docker desktop，然后再执行上面的命令。

Warning

如果报错：

denied: requested access to the resource is denied

请检查是否登录成功, Windows 下打开 Docker Desktop。 如果是Linux下运行命令登录：

docker login

登录成功后，再执行上面的命令。