{"id":22958092,"url":"https://github.com/mochipon/pysesameos2","last_synced_at":"2025-05-07T05:51:03.424Z","repository":{"id":37035878,"uuid":"378947412","full_name":"mochipon/pysesameos2","owner":"mochipon","description":"Unofficial Python Library to control smart devices running Sesame OS2.","archived":false,"fork":false,"pushed_at":"2025-03-25T07:50:18.000Z","size":129,"stargazers_count":24,"open_issues_count":13,"forks_count":13,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-03T00:14:40.160Z","etag":null,"topics":["ble","bluetooth-devices","candy-house","python","sesame-lock","smart-lock","smarthome","smartlock"],"latest_commit_sha":null,"homepage":"https://pysesameos2.readthedocs.io/en/stable/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mochipon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-06-21T13:53:06.000Z","updated_at":"2025-04-17T08:59:27.000Z","dependencies_parsed_at":"2023-01-20T10:58:35.821Z","dependency_job_id":"442e9d0f-95af-4758-ad7a-8684165405ab","html_url":"https://github.com/mochipon/pysesameos2","commit_stats":{"total_commits":69,"total_committers":5,"mean_commits":13.8,"dds":"0.34782608695652173","last_synced_commit":"1b4752a92b8d9051fbf53dea1cab3a7ba5740cd9"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mochipon%2Fpysesameos2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mochipon%2Fpysesameos2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mochipon%2Fpysesameos2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mochipon%2Fpysesameos2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mochipon","download_url":"https://codeload.github.com/mochipon/pysesameos2/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252823693,"owners_count":21809709,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ble","bluetooth-devices","candy-house","python","sesame-lock","smart-lock","smarthome","smartlock"],"created_at":"2024-12-14T17:35:50.443Z","updated_at":"2025-05-07T05:51:03.400Z","avatar_url":"https://github.com/mochipon.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pysesameos2\n\n_Unofficial Python Library to communicate with SESAME products via Bluetooth._\n\n[![PyPI](https://img.shields.io/pypi/v/pysesameos2)](https://pypi.python.org/pypi/pysesameos2)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pysesameos2)\n![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/mochipon/pysesameos2/dev%20workflow/main)\n[![Documentation Status](https://readthedocs.org/projects/pysesameos2/badge/?version=latest)](https://pysesameos2.readthedocs.io/en/latest/?badge=latest)\n[![codecov](https://codecov.io/gh/mochipon/pysesameos2/branch/main/graph/badge.svg?token=EOkDeLXeG2)](https://codecov.io/gh/mochipon/pysesameos2)\n![PyPI - License](https://img.shields.io/pypi/l/pysesameos2)\n\n## Introduction\n\nThis project aims to control smart devices running **Sesame OS2** via **Bluetooth**. If you want to control them via the cloud service, please check [pysesame3](https://github.com/mochipon/pysesame3).\n\nTo be honest, this is my first time to use [`Bleak`](https://github.com/hbldh/bleak) which provides an asynchronous, cross-platform Bluetooth API. PRs are heavily welcome.\n\n* Free software: MIT license\n* Documentation: [https://pysesameos2.readthedocs.io](https://pysesameos2.readthedocs.io)\n\n## Tested Environments\n\n* macOS 10.15.7, Python 3.9.5\n* Raspberry Pi Zero W (Raspbian GNU/Linux 10, Raspberry Pi reference 2021-05-07), Python 3.7.3\n\n## Supported devices\n\n- [SESAME 3](https://jp.candyhouse.co/products/sesame3)\n- [SESAME 4](https://jp.candyhouse.co/products/sesame4)\n- [SESAME bot](https://jp.candyhouse.co/products/sesame3-bot)\n\n## Features\n\n* Scan all SESAME locks using BLE advertisements.\n* Receive state changes (locked, handle position, etc.) that are actively reported from the device.\n* Needless to say, locking and unlocking!\n\n## Consideration\n\n- The results of `pysesameos2` are merely from reverse engineering of [the official SDK](https://doc.candyhouse.co/). We have implemented just a small part of it, so you might run into some issues. Please do let me know if you find any problems!\n- `pysesameos2` only supports devices that have already been initially configured using the official app. That is, `pysesameos2` cannot configure the locking position of your device.\n- `pysesameos2` does not have, and will not have, any functionality related to the operation history of locks.  According to [the document](https://doc.candyhouse.co/ja/flow_charts#sesame-%E5%B1%A5%E6%AD%B4%E6%A9%9F%E8%83%BD), your lock's operation history is not stored in the lock itself, but on the cloud service. I personally recommend you to bring a Wi-Fi module to get the operation history uploaded and retrive it by [the API](https://doc.candyhouse.co/ja/SesameAPI#sesame%E3%81%AE%E5%B1%A5%E6%AD%B4%E3%82%92%E5%8F%96%E5%BE%97).\n\n## Usage\n\nPlease take a look at the [`example`](https://github.com/mochipon/pysesameos2/tree/main/example) directory.\n\n## Related Projects\n\n### Libraries\n| Name | Lang | Communication Method |\n----|----|----\n| [pysesame](https://github.com/trisk/pysesame) | Python | [Sesame API v1/v2](https://docs.candyhouse.co/v1.html)\n| [pysesame2](https://github.com/yagami-cerberus/pysesame2) | Python | [Sesame API v3](https://docs.candyhouse.co/)\n| [pysesame3](https://github.com/mochipon/pysesame3) | Python | [Web API](https://doc.candyhouse.co/ja/SesameAPI), [CognitoAuth (The official android SDK reverse-engineered)](https://doc.candyhouse.co/ja/android)\n| [pysesameos2](https://github.com/mochipon/pysesameos2) | Python | [Bluetooth](https://doc.candyhouse.co/ja/android)\n\n### Integrations\n| Name | Description | Communication Method |\n----|----|----\n| [doorman](https://github.com/jp7eph/doorman) | Control SESAME3 from Homebridge by MQTT | [Web API](https://doc.candyhouse.co/ja/SesameAPI)\n| [Doorlock](https://github.com/kishikawakatsumi/Doorlock) | iOS widget for Sesame 3 smart lock | [Web API](https://doc.candyhouse.co/ja/SesameAPI)\n| [gopy-sesame3](https://github.com/orangekame3/gopy-sesame3) | NFC (Felica) integration | [Web API](https://doc.candyhouse.co/ja/SesameAPI)\n| [homebridge-open-sesame](https://github.com/yasuoza/homebridge-open-sesame) | Homebridge plugin for SESAME3 | Cognito integration\n| [homebridge-sesame-os2](https://github.com/nzws/homebridge-sesame-os2) | Homebridge Plugin for SESAME OS2 (SESAME3) | [Web API](https://doc.candyhouse.co/ja/SesameAPI)\n| [sesame3-webhook](https://github.com/kunikada/sesame3-webhook) | Send SESAME3 status to specified url. (HTTP Post) | CognitoAuth (based on `pysesame3`)\n\n## Credits \u0026 Thanks\n\n* A huge thank you to all at [CANDY HOUSE](https://jp.candyhouse.co/) and their crowdfunding contributors!\n* Thanks to [@Chabiichi](https://github.com/Chabiichi)-san for [the offer](https://github.com/mochipon/pysesame3/issues/25) to get my SESAME bot!\n* Many thanks to [bleak](https://github.com/hbldh/bleak) and [pyzerproc](https://github.com/emlove/pyzerproc).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmochipon%2Fpysesameos2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmochipon%2Fpysesameos2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmochipon%2Fpysesameos2/lists"}