Ansibleロール zigbee2mqtt

説明

このロールは、Raspberry Pi 上で zigbee2mqtt をインストールおよび設定するためのものです。RaspbianのLiteまたはフルバージョンで動作します。他のDebianディストリビューションでも動作するはずです。

構成やデバイスデータベースをバックアップおよび復元するためのスクリプト /usr/local/bin/zigbee2mqtt-backup を提供します。

このロールは igami.zigbee2mqtt を基にしています。

要件

SSHが有効なRaspberry Piと、CC2531 USBスニファーが必要です。

新しい「ヘッドレス」Raspberry Piサーバーにインストールする場合は、SDカードのブートディレクトリに 'ssh'という名前の空のファイルを追加して、リモートSSHアクセスを有効にします。

ロール変数

変数名	タイプ	デフォルト	コメント
zigbee_user	文字列	zigbee	zigbee2mqttを実行するユーザー。
zigbee_user_groups	文字列	tty,dialout	zigbeeユーザーがシリアルポートにアクセスするために必要なグループ。
zigbee_user_append	真偽値	false	trueの場合、指定されたzigbee_user_groupsのグループにユーザーを追加します。 falseの場合、ユーザーは指定されたグループにのみ追加され、他のすべてのグループからは削除されます。
zigbee_dir	文字列	/opt/zigbee2mqtt	zigbee2mqttのインストールディレクトリ。
zigbee_repository	文字列	https://github.com/Koenkk/zigbee2mqtt.git	インストールに使用するzigbee2mqttのgitリポジトリのURL。
zigbee_version	文字列	HEAD	インストールするバージョン（コミットハッシュ、ブランチ名、またはタグ名）。
zigbee_permit_join	真偽値	false	新しいデバイスの参加を許可するかどうか。
zigbee_mqtt	オブジェクト		MQTT設定（zigbee_mqtt参照）。
zigbee_advanced	オブジェクト		アダプターやその他のものを設定するためのzigbee2mqttの高度な設定（zigbee_advanced参照）。
zigbee_serial	オブジェクト		シリアルポート設定（zigbee_serial参照）。
zigbee_frontend	オブジェクト/真偽値		falseの場合、フロントエンドが無効になります。オブジェクトはフロントエンドの設定を構成します（zigbee_frontend参照）。
zigbee_ota	オブジェクト		OTAデバイスのファームウェア更新設定（zigbee_ota参照）。
zigbee_device_options	オブジェクト		デバイスオプション設定（デバイスとグループの設定ガイド参照）。
zigbee_blocklist	オブジェクト		デバイスブロックリスト（デバイスブロックリスト/パスリストの設定ガイド参照）。
zigbee_passlist	オブジェクト		デバイスパスリスト（デバイスブロックリスト/パスリストの設定ガイド参照）。
zigbee_external_converters	オブジェクトのリスト		外部コンバーターの設定（外部コンバーター参照）。
zigbee_map_options	オブジェクト		ネットワークマップ設定（ネットワークマップの設定ガイド参照）。
zigbee_availability	オブジェクト		デバイスの可用性機能設定（デバイス可用性の設定ガイド参照）。 定義されていない場合、デバイス可用性機能は無効になります。
zigbee_homeassistant	オブジェクト		Home Assistant統合設定（Home Assistant統合の設定ガイド参照）。 定義されていない場合、Home Assistant統合は無効になります。
zigbee_generate_new_network_key	真偽値	false	trueの場合、新しいネットワークキーを生成します（zigbee_advanced.network_keyにネットワークキーが指定されていない場合のみ）。

zigbee_mqtt

すべての設定の詳細は、MQTTの設定ガイドで確認できます。

変数名	タイプ	デフォルト	コメント
base_topic	文字列	zigbee2mqtt	zigbee2mqtt MQTTメッセージの基本トピック。
server	文字列	mqtt://localhost	MQTTサーバーに接続するためのURL。
user	文字列		MQTTサーバーに接続するユーザー名。
password	文字列		MQTTサーバーに接続するためのパスワード。

zigbee_advanced

すべての設定の詳細は以下を参照してください：

• アダプター設定のガイド
• zigbeeネットワークの設定ガイド
• ログの設定ガイド

変数名	タイプ	デフォルト	コメント
pan_id	16進数	0x1a62	ZigBeeのPAN ID。
ext_pan_id	配列	[0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD, 0xDD]	ZigBeeの拡張PAN ID。
channel	整数	11	ZigBeeのチャンネル（注：問題を避けるためにZLLチャンネル（11, 15, 20, 25）を使用してください）。 注意：変更にはすべてのデバイスの再ペアリングが必要です。
network_key	文字列	'!network_key network_key'	ネットワークの暗号化キー、セキュリティを向上させます。 注意：変更にはすべてのデバイスの再ペアリングが必要です。

zigbee_serial

すべての設定の詳細は、アダプター設定のガイドで確認できます。

変数名	タイプ	デフォルト	コメント
port	文字列	/dev/ttyACM0	Zigbee USBアダプターの位置。
baudrate	整数	115200	シリアルポートのボーレート速度。
rtscts	真偽値	false	シリアルポートのRTS / CTSハードウェアフロー制御。

zigbee_frontend

すべてのフロントエンド設定の詳細は、フロントエンド設定ガイドで確認できます。

変数名	タイプ	デフォルト	コメント
port	整数	8080	フロントエンドが待機するポート。

zigbee_ota

すべての設定の詳細は、OTAデバイスのファームウェア更新設定ガイドで確認できます。

変数名	タイプ	デフォルト	コメント
ikea_ota_use_test_url	真偽値	false	IKEA TRADFRI OTAテストサーバーを使用します。
update_check_interval	整数	1440	OTA更新チェックの最小時間。
disable_automatic_update_check	真偽値	false	自動更新チェックを無効にします。

zigbee_external_converters

外部コンバーターの設定。

変数名	タイプ	デフォルト	コメント
name	文字列		外部コンバーターの名前。
script	文字列		外部コンバーターのスクリプト。
state	文字列	present	presentは外部コンバーターを作成または更新します。 absentは既存の外部コンバーターを削除します。

依存関係

• git
• npm >=5.8
• nodejs >=10

例のプレイブック

デフォルトのシリアルポートでzigbee2mqttをインストールするには：

    - name: zigbee2mqtt octoprint on raspbian
      hosts: ip_address_of_rpi
      become: true

      roles:
      - finalgene.zigbee2mqtt

カスタムシリアルポートでzigbee2mqttをインストールするには：

    - name: zigbee2mqtt octoprint on raspbian
      hosts: ip_address_of_rpi
      become: true

      roles:
      - role: finalgene.zigbee2mqtt
        vars: 
          zigbee_serial:
            port: /dev/serial/by-id/usb-Texas_Instruments_TI_CC2531_USB_CDC___0X00124B0018ED3DDF-if00

デフォルトのシリアルポートとMQTT認証でzigbee2mqttをインストールするには：

    - name: zigbee2mqtt octoprint on raspbian
      hosts: ip_address_of_rpi
      become: true

      roles:
      - role: finalgene.zigbee2mqtt
        vars:
          zigbee_mqtt:
            user: mqtt_user
            password: mqtt_password

ライセンス

BSD

作者情報

• igami
• Frank Giesecke