RPiOS Lite(bookworm)でPirate Audioを使う

# Pirate Audioってなんだ

https://shop.pimoroni.com/collections/pirate-audio

　[英国Pimoroni社](https://shop.pimoroni.com/)のpHAT(RPi用のアドオンボード)です。DAC・2.7インチディスプレイ・ちょっとしたボタン、がひとまとめになっていて、RPiZeroのボードプロファイルに合わせたサイズ。　[スピーカーアンプ付き](https://shop.pimoroni.com/products/pirate-audio-3w-stereo-amp?)や[マイク付き](https://shop.pimoroni.com/products/pirate-audio-dual-mic?)などいくつか種類がありますが、[LINE出力の](https://shop.pimoroni.com/products/pirate-audio-line-out?)を選んでしまうとふだん遊ぶのに音声接続がめんどくさいことになりそうで、[ヘッドホンアンプ付き](https://shop.pimoroni.com/products/pirate-audio-headphone-amp?)のものにしました。[スピーカー付き](https://shop.pimoroni.com/products/pirate-audio-mini-speaker?)のもあるので、音響機器につなぐことを考えなければそれも手軽でいいかもしれません。
　当初は音声出力端子のないZeroで開発を始めたので、そんなに高価でもないし、というんでまずはこれからやってみることにしました。[Pythonのライブラリ](https://github.com/pimoroni/pirate-audio)や[サンプル](https://github.com/pimoroni/st7789-python/tree/master/examples)も用意されていてとっつきやすい…と思われたのですが、bookwormで使うときにはかなり注意が必要になっています。
　ディスプレイやボタンをもっと大きくしたいならPirate Audio以外の選択肢も考えてみてください。

# Pirate Audioの準備
　メーカーからPirate Audioの自動インストールが提供されていますが、bookwormに対応していないので`config.txt`を直接編集します。 

~~~shell:command
sudo nano /boot/firmware/config.txt
~~~

:::note warn
bullseye以前では`/boot/config.txt`でしたが、bookwormでは場所が変わっていますので注意してください。
:::

　`[all]`の下に以下4行を追加します。`dtparam=audio`については`[all]`より前(先頭から10行目ぐらい)にもともと`dtparam=audio=on`の記述があるので、それをコメントアウトしておくべきでしょう。
~~~conf:config.txt
dtparam=spi=on
dtparam=audio=off
dtoverlay=hifiberry-dac
gpio=25=op,dh
~~~
　dtなんちゃらというのはデバイスツリーに対する設定で、`dtparam`は存在しているデバイスにパラメータを与える、`dtoverlay`は上からかぶせてデバイスを追加する、と筆者は捉えています。2〜3行目は「オンボードのオーディオインターフェイスを無効にして、Pirate AudioのDACを追加するよ」という意味合いです。

### 音声出力関係
　bookwormではオーディオサブシステムがPulseAudioからPipeWireへ変更された、という話ですが、RPiOS LiteではPipeWireどころかPulseAudioすら入っていませんでした。入れておきます。
~~~shell:command
sudo apt update
sudo apt install -y pulseaudio
~~~

### 画像処理関係のインストール
~~~shell:command
sudo apt install -y python3-spidev python3-pil python3-numpy
~~~
　PILは画像表示のための処理に、numpyは画像の回転用途に入れています。
　gpiozeroも使いますが、もともと入っています。

# pythonでコントロール
## LCD表示
　[pimoroniのgithub](https://github.com/pimoroni/st7789-python)で公開されているST7789向けのライブラリをpipで入れることができますが、導入したバージョン1.0.1では筆者の環境では動作に若干難がありました。
　問題になるのはGPIOの操作部分のようで、そこをシェルコマンドで代替している例も見かけましたが、ここでは以前使っていたバージョン0.0.4に戻した上で、gpiozeroに置き換えてみました。

<details><summary><b>----------------------------------------<br>&nbsp;&nbsp;&nbsp;ソースコードを表示（折りたたみ）<br>&nbsp;------------------------------------------</b></summary>

~~~python:st7789kai.py
# Copyright (c) 2014 Adafruit Industries
# Author: Tony DiCola
# gpiozero test version 2024 by Atsushi Nishihata

# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
import numbers
import time
import numpy as np

import spidev
# import RPi.GPIO as GPIO
from gpiozero import DigitalOutputDevice

__version__ = '0.0.4'

BG_SPI_CS_BACK = 0
BG_SPI_CS_FRONT = 1

SPI_CLOCK_HZ = 16000000

ST7789_NOP = 0x00
ST7789_SWRESET = 0x01
ST7789_RDDID = 0x04
ST7789_RDDST = 0x09

ST7789_SLPIN = 0x10
ST7789_SLPOUT = 0x11
ST7789_PTLON = 0x12
ST7789_NORON = 0x13

ST7789_INVOFF = 0x20
ST7789_INVON = 0x21
ST7789_DISPOFF = 0x28
ST7789_DISPON = 0x29

ST7789_CASET = 0x2A
ST7789_RASET = 0x2B
ST7789_RAMWR = 0x2C
ST7789_RAMRD = 0x2E

ST7789_PTLAR = 0x30
ST7789_MADCTL = 0x36
ST7789_COLMOD = 0x3A

ST7789_FRMCTR1 = 0xB1
ST7789_FRMCTR2 = 0xB2
ST7789_FRMCTR3 = 0xB3
ST7789_INVCTR = 0xB4
ST7789_DISSET5 = 0xB6

ST7789_GCTRL = 0xB7
ST7789_GTADJ = 0xB8
ST7789_VCOMS = 0xBB

ST7789_LCMCTRL = 0xC0
ST7789_IDSET = 0xC1
ST7789_VDVVRHEN = 0xC2
ST7789_VRHS = 0xC3
ST7789_VDVS = 0xC4
ST7789_VMCTR1 = 0xC5
ST7789_FRCTRL2 = 0xC6
ST7789_CABCCTRL = 0xC7

ST7789_RDID1 = 0xDA
ST7789_RDID2 = 0xDB
ST7789_RDID3 = 0xDC
ST7789_RDID4 = 0xDD

ST7789_GMCTRP1 = 0xE0
ST7789_GMCTRN1 = 0xE1

ST7789_PWCTR6 = 0xFC


class ST7789(object):
    """Representation of an ST7789 TFT LCD."""

    def __init__(self, port, cs, dc, backlight=None, rst=None, width=240,
                 height=240, rotation=90, invert=True, spi_speed_hz=4000000,
                 offset_left=0,
                 offset_top=0):
        """Create an instance of the display using SPI communication.

        Must provide the GPIO pin number for the D/C pin and the SPI driver.

        Can optionally provide the GPIO pin number for the reset pin as the rst parameter.

        :param port: SPI port number
        :param cs: SPI chip-select number (0 or 1 for BCM
        :param backlight: Pin for controlling backlight
        :param rst: Reset pin for ST7789
        :param width: Width of display connected to ST7789
        :param height: Height of display connected to ST7789
        :param rotation: Rotation of display connected to ST7789
        :param invert: Invert display
        :param spi_speed_hz: SPI speed (in Hz)

        """
        if rotation not in [0, 90, 180, 270]:
            raise ValueError("Invalid rotation {}".format(rotation))

        if width != height and rotation in [90, 270]:
            raise ValueError("Invalid rotation {} for {}x{} resolution".format(rotation, width, height))

        # GPIO.setwarnings(False)
        # GPIO.setmode(GPIO.BCM)

        self._spi = spidev.SpiDev(port, cs)
        self._spi.mode = 0
        self._spi.lsbfirst = False
        self._spi.max_speed_hz = spi_speed_hz

        # self._dc = dc
        # self._rst = rst
        self._width = width
        self._height = height
        self._rotation = rotation
        self._invert = invert

        self._offset_left = offset_left
        self._offset_top = offset_top

        # Set DC as output.
        # GPIO.setup(dc, GPIO.OUT)
        self._dc = DigitalOutputDevice(dc, active_high=True, initial_value=False)

        # Setup backlight as output (if provided).
        # self._backlight = backlight
        if backlight is not None:
            # GPIO.setup(backlight, GPIO.OUT)
            self._backlight = DigitalOutputDevice(backlight, active_high=True, initial_value=False)
            self._backlight.off()   # GPIO.output(backlight, GPIO.LOW)
            time.sleep(0.1)
            self._backlight.on()    # GPIO.output(backlight, GPIO.HIGH)

        # Setup reset as output (if provided).
        if rst is not None:
            # GPIO.setup(rst, GPIO.OUT)
            self._rst = DigitalOutputDevice(rst, active_high=True, initial_value=False)
            self.reset()
        else:
            self._rst = None
        self._initcommand()

    def send(self, data, is_data=True, chunk_size=4096):
        """Write a byte or array of bytes to the display. Is_data parameter
        controls if byte should be interpreted as display data (True) or command
        data (False).  Chunk_size is an optional size of bytes to write in a
        single SPI transaction, with a default of 4096.
        """
        # Set DC low for command, high for data.
        # GPIO.output(self._dc, is_data)
        if is_data: self._dc.on()
        else:       self._dc.off()

        # Convert scalar argument to list so either can be passed as parameter.
        if isinstance(data, numbers.Number):
            data = [data & 0xFF]
        # Write data a chunk at a time.
        for start in range(0, len(data), chunk_size):
            end = min(start + chunk_size, len(data))
            self._spi.xfer(data[start:end])

    def set_backlight(self, value):
        """Set the backlight on/off."""
        if self._backlight is not None:
            # GPIO.output(self._backlight, value)
            if value:
                self._backlight.on()
            else:
                self._backlight.off()

    @property
    def width(self):
        return self._width if self._rotation == 0 or self._rotation == 180 else self._height

    @property
    def height(self):
        return self._height if self._rotation == 0 or self._rotation == 180 else self._width

    def command(self, data):
        """Write a byte or array of bytes to the display as command data."""
        self.send(data, False)

    def data(self, data):
        """Write a byte or array of bytes to the display as display data."""
        self.send(data, True)

    def reset(self):
        """Reset the display, if reset pin is connected."""
        if self._rst is not None:
            self._rst.on()  # GPIO.output(self._rst, 1)
            time.sleep(0.500)
            self._rst.off() # GPIO.output(self._rst, 0)
            time.sleep(0.500)
            self._rst.on()  # GPIO.output(self._rst, 1)
            time.sleep(0.500)

    def _initcommand(self):
        # Initialize the display.

        self.command(ST7789_SWRESET)    # Software reset
        time.sleep(0.150)               # delay 150 ms

        self.command(ST7789_MADCTL)
        self.data(0x70)

        self.command(ST7789_FRMCTR2)    # Frame rate ctrl - idle mode
        self.data(0x0C)
        self.data(0x0C)
        self.data(0x00)
        self.data(0x33)
        self.data(0x33)

        self.command(ST7789_COLMOD)
        self.data(0x05)

        self.command(ST7789_GCTRL)
        self.data(0x14)

        self.command(ST7789_VCOMS)
        self.data(0x37)

        self.command(ST7789_LCMCTRL)    # Power control
        self.data(0x2C)

        self.command(ST7789_VDVVRHEN)   # Power control
        self.data(0x01)

        self.command(ST7789_VRHS)       # Power control
        self.data(0x12)

        self.command(ST7789_VDVS)       # Power control
        self.data(0x20)

        self.command(0xD0)
        self.data(0xA4)
        self.data(0xA1)

        self.command(ST7789_FRCTRL2)
        self.data(0x0F)

        self.command(ST7789_GMCTRP1)    # Set Gamma
        self.data(0xD0)
        self.data(0x04)
        self.data(0x0D)
        self.data(0x11)
        self.data(0x13)
        self.data(0x2B)
        self.data(0x3F)
        self.data(0x54)
        self.data(0x4C)
        self.data(0x18)
        self.data(0x0D)
        self.data(0x0B)
        self.data(0x1F)
        self.data(0x23)

        self.command(ST7789_GMCTRN1)    # Set Gamma
        self.data(0xD0)
        self.data(0x04)
        self.data(0x0C)
        self.data(0x11)
        self.data(0x13)
        self.data(0x2C)
        self.data(0x3F)
        self.data(0x44)
        self.data(0x51)
        self.data(0x2F)
        self.data(0x1F)
        self.data(0x1F)
        self.data(0x20)
        self.data(0x23)

        if self._invert:
            self.command(ST7789_INVON)   # Invert display
        else:
            self.command(ST7789_INVOFF)  # Don't invert display

        self.command(ST7789_SLPOUT)

        self.command(ST7789_DISPON)     # Display on
        time.sleep(0.100)               # 100 ms

    def begin(self):
        """Set up the display

        Deprecated. Included in __init__.

        """
        pass

    def set_window(self, x0=0, y0=0, x1=None, y1=None):
        """Set the pixel address window for proceeding drawing commands. x0 and
        x1 should define the minimum and maximum x pixel bounds.  y0 and y1
        should define the minimum and maximum y pixel bound.  If no parameters
        are specified the default will be to update the entire display from 0,0
        to width-1,height-1.
        """
        if x1 is None:
            x1 = self._width - 1

        if y1 is None:
            y1 = self._height - 1

        y0 += self._offset_top
        y1 += self._offset_top

        x0 += self._offset_left
        x1 += self._offset_left

        self.command(ST7789_CASET)       # Column addr set
        self.data(x0 >> 8)
        self.data(x0 & 0xFF)             # XSTART
        self.data(x1 >> 8)
        self.data(x1 & 0xFF)             # XEND
        self.command(ST7789_RASET)       # Row addr set
        self.data(y0 >> 8)
        self.data(y0 & 0xFF)             # YSTART
        self.data(y1 >> 8)
        self.data(y1 & 0xFF)             # YEND
        self.command(ST7789_RAMWR)       # write to RAM

    def display(self, image):
        """Write the provided image to the hardware.

        :param image: Should be RGB format and the same dimensions as the display hardware.

        """
        # Set address bounds to entire display.
        self.set_window()

        # Convert image to 16bit RGB565 format and
        # flatten into bytes.
        pixelbytes = self.image_to_data(image, self._rotation)

        # Write data to hardware.
        for i in range(0, len(pixelbytes), 4096):
            self.data(pixelbytes[i:i + 4096])

    def image_to_data(self, image, rotation=0):
        if not isinstance(image, np.ndarray):
            image = np.array(image.convert('RGB'))

        # Rotate the image
        pb = np.rot90(image, rotation // 90).astype('uint16')

        # Mask and shift the 888 RGB into 565 RGB
        red   = (pb[..., [0]] & 0xf8) << 8
        green = (pb[..., [1]] & 0xfc) << 3
        blue  = (pb[..., [2]] & 0xf8) >> 3

        # Stick 'em together
        result = red | green | blue

        # Output the raw bytes
        return result.byteswap().tobytes()
~~~
</details>

### 表示サンプル
　以下は前述の改造ライブラリで進めますので、`st7899kai.py`を同じディレクトリに置いてください。
　公式のライブラリを利用される場合は`from st7789kai import ST7789`を`from st7789 import ST7789`に読み替えてください。

#### 画像ファイルの表示
　[公式サンプル](https://github.com/pimoroni/st7789-python/tree/master/examples)を参考に、少し手を加えています。
~~~image.py
from PIL import Image
from st7789kai import ST7789
 
IMAGE_FILE = "/home/pi/img.png"

disp = ST7789(
    port=0,
    rotation=0,
    cs=1,
    dc=9,
    backlight=14,
    spi_speed_hz=80 * 1000 * 1000
)
image = Image.open(IMAGE_FILE)
disp.display(image)
~~~

::: note warn
`image_file`に指定する画像は240x240pxのものでないと、エラーが返ってきます。numpyで自動縮尺できそうな気もしますが、ここでは触れません。
:::

::: note info
公式サンプルなどで`disp.begin()`を入れているものがありますが、結構早い段階で`begin`は`__init__`に吸収されていて、ただ`pass`を投げているだけなので、ここでは記述していません。
:::

#### 文字出し
　シャットダウンするとき、画面に文字を出したいと思って作ったものです。バックを黒塗りして、画面中央に文字を表示するようにしています。
~~~spitext_bye.py
from PIL import Image, ImageDraw, ImageFont
from st7789kai import ST7789

MESSAGE  = "Bye"
FONTFILE = "/usr/share/fonts/truetype/dejavu/DejaVuSans-Bold.ttf"

disp = ST7789(
    port=0,
    rotation=0,
    cs=ST7789.BG_SPI_CS_FRONT,
    dc=9,
    backlight=19,
    spi_speed_hz=80 * 1000 * 1000
)
disp.begin()

WIDTH = disp.width
HEIGHT = disp.height
img = Image.new('RGB', (WIDTH, HEIGHT), color=(0, 0, 0))
draw = ImageDraw.Draw(img)

font = ImageFont.truetype(FONTFILE, 30)
size_x, size_y = draw.textsize(MESSAGE, font)
text_x = (disp.width -size_x) // 2
text_y = (disp.height - size_y) // 2
draw.text((text_x, text_y), MESSAGE, font=font, fill=(64, 64, 64))
disp.display(img)
~~~

## ボタンの検知
　Pirate AudioボタンはGPIOピンに割り当てられているので、そのオンオフを検知すればどのボタンが押されたかがわかります。
　エンベデッド運用するなら自分でシャットダウンできる必要もあるから、とこちらのページで紹介されている方法を参考にしてみました。

https://qiita.com/clses/items/e701c1cb6490751a6040

　Pimoroni社の[On/Off SHIM](https://shop.pimoroni.com/products/onoff-shim?variant=41102600138)に付いているソフトウェアも同じやり方ですね。

　ただ、ここのやり方ではボタンが押されるのを0.1秒単位でずっと監視していることになります。どこかで「そんなお大尽な」という話を見て気になったのと、他に実装したいもの関係もあり、コールバックで処理するようにしてみました。gpiozeroだとたったこれだけ、実装がとても簡単です。
　検知対象はXボタンです。`spitext_bye`は先に挙げた文字出しサンプルです。

~~~shutdownd.py
import os
import time
from gpiozero import Button

def held(btn):
    import spitext_bye
    os.system("sudo shutdown -h now")

btn = Button(pin=PIN, bounce_time=0.5)
btn.when_held = held
while True:
    time.sleep(60 * 60 * 24)
~~~
~~~/etc/systemd/system/shutdownbuttond.service
[Unit]
Description=Shutdown Daemon
 
[Service]
ExecStart =/home/pi/shutdownd.py
Restart=always
Type=simple
 
[Install]
WantedBy=multi-user.target
~~~
~~~bash:command
sudo chmod 755 /home/pi/shutdownd.py
sudo systemctl enable shutdownbuttond
~~~

:::note
　単にシャットダウンさせたいだけなら[こんな方法](https://qiita.com/ryo-a/items/2edabbbe2b67654e29c9)や[こんな方法](https://ict.red/raspberry-pi-%E3%81%AB%E5%81%9C%E6%AD%A2%E3%81%A8%E8%B5%B7%E5%8B%95%E3%81%AE%E3%83%9C%E3%82%BF%E3%83%B3%E3%82%92%E5%AE%9F%E8%A3%85%E3%81%97%E3%82%88%E3%81%86/)もあるそうです。
:::

## ログイン時自動実行の設定
　daemon化もいいけどpath関係などいろいろ面倒になる場合もあるので、自動ログインさせ、その際に自動起動するように設定してみるのもいいでしょう。

~~~shell:command
crontab -e
~~~
で再起動時のみ実行する設定を追加します。

　以下を最終行に追加、保存します。`image.py`はホームディレクトリにある前提です。ログを`/tmp/log.txt`に掃いています。
~~~conf:crontab
@reboot /bin/python image.py > /tmp/log.txt 2>&1
~~~
:::note warn
行末に改行が必要なのは要注意点です。
:::
:::note info
　crontab -e の実行が初めての場合、エディタの選択画面が表示されます。
~~~
no crontab for pi - using an empty one

Select an editor.  To change later, run 'select-editor'.
  1. /bin/nano        <---- easiest
  2. /usr/bin/vim.tiny
  3. /bin/ed

Choose 1-3 [1]: 
~~~
　一番かんたんなのは1ですよ、ということで、nanoにしています。次回からは覚えていてくれます。
:::

　あとは起動時に自動ログインさせればOK。
~~~shell:command
sudo raspi-config nonint do_boot_behaviour B2
~~~