Qoosky API + Raspberry Pi5 でLチカしてみた

1. python -m venv qoosky-test --system-site-packages: システムパッケージも利用可能な qoosky-test という名前のPython仮想環境を作成します。
2. . qoosky-test/bin/activate: 作成した仮想環境 qoosky-test を有効化し、以降のパッケージインストールを隔離します。
3. pip install gpiozero websocket-client: Raspberry PiのGPIO制御に必要な gpiozero と、Qoosky APIとのWebSocket通信に必要な websocket-client ライブラリを仮想環境にインストールします。

先ほどの qoosky_led.py の中身を、もう少し詳しく見ていきましょう。

# -*- coding: utf-8 -*-

これは、Pythonのコードの先頭によく書かれているおまじないのようなものです。簡単に言うと、「このファイルはUTF-8という文字コードで書かれていますよ」という宣言です。日本語などの文字を正しく表示するために必要になります。

import gpiozero
import websocket

import というのは、「このファイルの中で、これから gpiozero と websocket というライブラリを使いますよ」という宣言です。料理で例えるなら、「これからカレーを作るのに、カレールーとジャガイモを使いますよ」と宣言するようなものです。
さっき pip install でインストールした gpiozero と websocket-client がここで登場します。

ledPin = 26

ledPin という変数に 26 という数字を代入しています。これは、「LEDを接続するGPIOピンの番号は26番ですよ」という設定です。
この 26 という数字は、Raspberry Piの物理的なピンの番号ではなく、GPIOの番号なので注意してくださいね！

led = gpiozero.DigitalOutputDevice(ledPin)

gpiozero ライブラリを使って、LEDを制御するためのオブジェクトを作っています。
gpiozero.DigitalOutputDevice(ledPin) は、「ledPin (ここでは26) 番のGPIOピンを出力として使えるように設定して、それを led という名前で呼べるようにします」という意味です。
これで、led.on() と書けばLEDが点灯し、led.off() と書けばLEDが消灯するようになります。

def on_open(ws):
    print("Successfully connected to the API server.")
    ws.send('{"token":"AAAA-BBBB-CCCC-DDDD"}')
#自分で発行したトークンを入力してください↑

def on_open(ws): は、「on_open という名前の関数を定義しますよ」という意味です。関数というのは、一連の処理をまとめたもので、必要に応じて呼び出すことができます。
on_open 関数は、WebSocket接続が成功したときに自動的に呼ばれます。

• print("Successfully connected to the API server."): ターミナルに「APIサーバーに接続成功！」と表示します。
• ws.send('{"token":"AAAA-BBBB-CCCC-DDDD"}'): Qoosky APIに認証トークンを送ります。AAAA-BBBB-CCCC-DDDD の部分は、絶対に自分のトークンに置き換えてください！

def on_error(ws, error):
    print("An unexpected error has occurred: %s" % error)
    ws.close()

on_error 関数は、WebSocketでエラーが発生したときに自動的に呼ばれます。
エラーの内容をターミナルに表示して、WebSocket接続を閉じます。

def on_message(ws, message):
    print("received: %s" % message)
    ledOnMsg = 'buttonMiddle1'
    ledOffMsg = 'buttonMiddle2'
    if message == ledOnMsg:
        led.on()
        print("LED is on.")
    elif message == ledOffMsg:
        led.off()
        print("LED is off.")

on_message 関数は、Qoosky APIからメッセージを受信したときに自動的に呼ばれます。

• print("received: %s" % message): 受信したメッセージの内容をターミナルに表示します。
• ledOnMsg = 'buttonMiddle1' と ledOffMsg = 'buttonMiddle2': LEDを点灯・消灯するためのメッセージを定義しています。これらのメッセージは、Qoosky APIの設定で自由に設定できます。
• if message == ledOnMsg:: 受信したメッセージが ledOnMsg と同じなら、LEDを点灯させます。
  • led.on(): LEDを点灯させます。
  • print("LED is on."): ターミナルに「LED点灯！」と表示します。
• elif message == ledOffMsg:: 受信したメッセージが ledOffMsg と同じなら、LEDを消灯させます。
  • led.off(): LEDを消灯させます。
  • print("LED is off."): ターミナルに「LED消灯！」と表示します。

def on_close(ws):
    print("Connection closed.")
    led.off()
    led.close()

on_close 関数は、WebSocket接続が閉じられたときに自動的に呼ばれます。
LEDを消灯して、GPIOピンを解放します。

• led.off(): LEDを消灯します。
• led.close(): GPIOピンを解放します。解放することで、他のプログラムがGPIOピンを使えるようになります。

if __name__ == "__main__":
    try:
        websocket.enableTrace(False)
        ws = websocket.WebSocketApp(
            "ws://api.qoosky.dev/v1/websocket-relay-server/actuator/ws",
            on_open=on_open,
            on_error=on_error,
            on_message=on_message,
            on_close=on_close
        )
        ws.run_forever()

    except KeyboardInterrupt:
        print("KeyboardInterrupt")
        ws.close()
        led.off()
        led.close()
        exit()

if __name__ == "__main__": は、「このファイルを直接実行した場合にだけ、以下のコードを実行しますよ」という意味です。

• websocket.enableTrace(False): WebSocketのデバッグログを無効化します。デバッグログは、WebSocket通信の詳細な情報を表示するものですが、今回は必要ないので無効にしておきます。
• ws = websocket.WebSocketApp(...): websocket-client ライブラリを使って、Qoosky APIとのWebSocket接続を行うためのオブジェクトを作ります。
  • "ws://api.qoosky.dev/v1/websocket-relay-server/actuator/ws": Qoosky APIのWebSocketサーバーのURLです。
  • on_open=on_open, on_error=on_error, on_message=on_message, on_close=on_close: さっき定義した関数を、WebSocketのそれぞれのイベントに紐付けます。
• ws.run_forever(): WebSocket接続を開始し、Qoosky APIからのメッセージを待ち続けます。この関数は、プログラムが終了するまでずっと動き続けます。
• except KeyboardInterrupt:: Ctrl+C (キーボード割り込み) が押された場合に、プログラムを安全に終了するための処理です。
  • ws.close(): WebSocket接続を閉じます。
  • led.off(): LEDを消灯します。
  • led.close(): GPIOピンを解放します。
  • exit(): プログラムを終了します。