gomalock 1.0.1

A library for controlling Sesame smart locks via BLE.

gomalock

Sesame スマートロックをPythonからBluetooth Low Energy (BLE)経由で操作するためのライブラリ。

機能説明

• Sesame 5 (Pro)をBluetooth経由で施錠、開錠などの操作
• 施錠状態、電池残量などの変化をリアルタイムで受信
• Sesame Touchの電池電圧、残量の変化をリアルタイムで受信
• 周囲のSesameデバイスをスキャンして情報を取得
• 新規Sesameデバイスの登録
• 施錠、開錠角度の設定
• オートロック秒数の設定
• 鍵の共有用QRコードの作成

インストール

最新のソースからインストール

pip install git+https://github.com/meronepy/gomalock.git

特定のバージョンをインストール(v0.0.0の部分を任意のバージョンに書き換えてください)

pip install git+https://github.com/meronepy/gomalock.git@v0.0.0

使用方法

開錠例

import asyncio

from gomalock.sesame5 import Sesame5

MAC_ADDRESS = "XX:XX:XX:XX:XX:XX"
SECRET_KEY = "1234567890abcdef1234567890abcdef"


async def main():
    async with Sesame5(MAC_ADDRESS, SECRET_KEY) as sesame5:
        await sesame5.unlock("gomalock")


if __name__ == "__main__":
    asyncio.run(main())

• MAC_ADDRESSはdiscover.pyを使用して周囲のSesameをスキャンして取得できます。
• SECRET_KEYはmochipon様作成のQR Code Reader for SESAMEを使用して、マネージャー権限以上のQRコードから抽出できます。
• 詳細な使用方法はexamplesおよびdocsをご覧ください。

MQTTとブリッジするサンプルコード

https://github.com/meronepy/ssm2mqtt

注意事項

• Linuxで動作させる場合、 BlueZ 5.82以降を強く推奨します。 Raspberry Pi OS Bookwormにインストール済みのBlueZ 5.66では、バグによってSesame 5のGATT Serviceが取得できず正常に動作しません。
• 履歴機能は公式アプリやクラウドとの連携が困難であるため実装しておりません。
• 非公式のライブラリです。動作保証はありません。自己責任でご使用ください。

テスト環境

• Windows 11 24H2, Python 3.13.3
• Raspberry Pi Zero 2W, Raspberry Pi OS Trixie (64bit), Python 3.13.3
• Sesame 5, 3.0-5-18a8e4
• Sesame 5 Pro, 3.0-7-848a2d

対応機種

対応状況	機種
✅	Sesame 5
✅	Sesame 5 Pro
⚠️	Sesame 5 USA
❌	Sesame 4以前

Sesame 5 USAは恐らく動作しますが、動作未確認です。
Sesame 4以前はOSが違うため動作しません。対応予定もありません。

対応状況	機種
✅	Sesame Touch
⚠️	Sesame Touch Pro
❌	Sesame Face
❌	Sesame Face Pro

Sesame Touch Proは恐らく動作しますが、動作未確認です。
Sesame Faceシリーズは簡単な改修で対応できるはずなので、手に入れたら将来的に対応する予定です。

対応環境

OS

対応状況	OS
✅	Windows 10 version 16299 以降
✅	Linux with BlueZ 5.82 以降
⚠️	macOS 10.13 以降(動作未確認)

内部で使用しているbleakライブラリに準じますが、macOS環境は動作未確認です。
Linux環境では前述のバグが原因で、BlueZ 5.82以降が必要です。

Python

Python 3.12以降が必要です。