chanshige/sesame

sesame smartlock api wrapper.

v2.1.1 2024-02-13 17:01 UTC

Requires

• php: ^8.3
• ext-crypto: *
• guzzlehttp/guzzle: ^7.8
• koriym/http-constants: ^1.1
• psr/http-message: ^1.0

Requires (Dev)

• doctrine/coding-standard: ^11.0
• mockery/mockery: ^1.6
• phpmd/phpmd: ^2.10
• phpmetrics/phpmetrics: ^2.8
• phpstan/phpstan: ^1.9
• phpstan/phpstan-mockery: ^1.1
• phpunit/phpunit: ^10.0
• psalm/plugin-mockery: ^1.1
• psalm/plugin-phpunit: ^0
• slevomat/coding-standard: ^8.14
• squizlabs/php_codesniffer: ^3.8
• vimeo/psalm: ^5.0

MIT

• Shigeki Tanaka

README

CandyHouseのSesameスマートロックAPIを利用するためのライブラリです。
This library is for using the sesame3/4/5 smart lock API.
※ OpenSSL Crypto library (ext-crypto) is required.

Installation

※準備中
$ composer require chanshige/sesame

Usage

<?php
// initialize
use Chanshige\SmartLock\Sesame\Action;
use Chanshige\SmartLock\Sesame\Client;
use Chanshige\SmartLock\Sesame\Device;

$sesame = Client::newInstance('sesame-api-key');

$device = new Device(
    uuid: '488ABAAB-164F-7A86-595F-DDD778CB86C3', // Sesameデバイス固有のID
    secretKey: 'a13d4b890111676ba8fb36ece7e94f7d', // デバイスを操作するための鍵
);
// ※ 2023/12現在、https://partners.candyhouse.co/login から取得可能でした。

Sesameの状態を取得

$response = $sesame(new Action\Status($device));

$response = >>>EOF
array (size=6)
  'batteryPercentage' => int 100 // バッテリー残量
  'batteryVoltage' => float 5.8627565982405 // バッテリー電圧(V)
  'position' => int 256 // 
  'CHSesame2Status' => string 'locked' // locked | unlocked | moved
  'timestamp' => int 1703000024 // Sesameの更新時間
  'wm2State' => boolean true // wifiモジュールの状態
EOF;

Sesameの履歴を取得

$response = $sesame(new Action\History($device, 1, 100));

Sesameの施解錠

APIリクエスト成功は200を返す。bodyは空。（狙い通りに施解錠できたかはStatusで確認する） WifiModuleが接続されていない場合は404エラーでThrowされます。

// 鍵をかける
$response = $sesame(new Action\Lock($device, 'chanshigeが鍵かけた'));

// 鍵をあける
$response = $sesame(new Action\UnLock($device, 'chanshigeが鍵あけた'));

// 鍵をひたすら回す
$response = $sesame(new Action\Toggle($device, 'chanshigeが操作した'));

Test

$ composer tests

Contributing

Feel free to create issues and submit pull requests. For any PR submitted, make sure it is covered by tests or include new tests.

Security

If you discover any security related issues, please email author email instead of using the issue tracker.

License

MIT

Author

chanshige