Pysesame3

⚠️ Noticeable changes for `CognitoAuth` users

I don't think I have received any official notification yet, but it seems that users are now charged to use the Web API from CANDY HOUSE as pointed at https://github.com/mochipon/pysesame3/pull/79?w=1#issuecomment-1135619952 (comment).

Following their clear statement, we decided to use their official (Paid) API to operate the device. However, this library will continue to provide the ability to connect to AWS IoT Core and receive real-time device state changes. This is the only feature that this library implements that is not officially provided.

I have tried to maintain all backward compatibility, so you will be able to continue to use this library without any particular changes.

公式には発表されていないと思いますが、CANDY HOUSE は SESAME デバイスの Web API を有料化しました。

このライブラリでは `CognitoAuth` という認証方法を使うことで公式に提供されている Web API 以上の機能を利用することができましたが、その一環として非公式な API を活用していました。

しかし、CANDY HOUSE の利益に明確に反することは、このライブラリの意図するところではありません。そのため、このリリースから、デバイスを操作する全ての API は公式の (有料化された) Web API を利用することにしました。唯一、公式では提供されていないリアルタイムな鍵の状態変化を受け取る機能 (`subscribeMechStatus`) は、オープンソースで公開されている公式の SDK に基づいた (Web API を利用しない) 実装となっています。

後方互換性を維持するように努めているので、このライブラリを利用するユーザへの影響はありません。

What's Changed
* Drop Python 3.6 support and Bump dependencies by mochipon in https://github.com/mochipon/pysesame3/pull/80
* Fix typo: getBatteryPrecentage -> getBatteryPercentage by mochipon in https://github.com/mochipon/pysesame3/pull/81
* Update codecov/codecov-action action to v3 by renovate in https://github.com/mochipon/pysesame3/pull/75
* Update actions/setup-python action to v3 by renovate in https://github.com/mochipon/pysesame3/pull/73
* Update actions/checkout action to v3 by renovate in https://github.com/mochipon/pysesame3/pull/72
* set UUIDv4 as AWSIoT Client ID by konikoni428 in https://github.com/mochipon/pysesame3/pull/78
* Use official Web API to control SESAME devices by mochipon in https://github.com/mochipon/pysesame3/pull/82
* Use master site (GitHub) for flake8 by mochipon in https://github.com/mochipon/pysesame3/pull/85
* Update dependency mkdocstrings to ^0.19.0 by renovate in https://github.com/mochipon/pysesame3/pull/68
* Update dependency mkdocstrings-python to ^0.7.0 by renovate in https://github.com/mochipon/pysesame3/pull/84

New Contributors
* konikoni428 made their first contribution in https://github.com/mochipon/pysesame3/pull/78
* key made their first contribution in https://github.com/mochipon/pysesame3/pull/70

**Full Changelog**: https://github.com/mochipon/pysesame3/compare/v0.5.1...v0.6.0

⚠️ Warning

This is a pre-release version! By default, `pip` only finds stable versions. If you want to try this version, please use `pip install --pre pysesame3[cognito]`.

If you find any problem, kindly report it to me. Thank you!

このバージョンは正式リリース前のリリース候補版です。もし問題を発見したら、どうか [Issue](https://github.com/mochipon/pysesame3/issues) として報告してください。

`pip` は標準でリリース版しかインストールしません。このリリース候補版をインストールするためには `pip install --pre pysesame3[cognito]` コマンドを実行してください。


⚠️ Noticeable changes for CognitoAuth users

I don't think I have received any official notification yet, but it seems that users are now charged to use the Web API from CANDY HOUSE as pointed at https://github.com/mochipon/pysesame3/pull/79?w=1#issuecomment-1135619952 (comment).

Following their clear statement, we decided to use their official (Paid) API to operate the device. However, this library will continue to provide the ability to connect to AWS IoT Core and receive real-time device state changes. This is the only feature that this library implements that is not officially provided.

I have tried to maintain all backward compatibility, so you will be able to continue to use this library without any particular changes.

公式には発表されていないと思いますが、CANDY HOUSE は SESAME デバイスの Web API を有料化しました。

このライブラリでは `CognitoAuth` という認証方法を使うことで公式に提供されている Web API 以上の機能を利用することができましたが、その一環として非公式な API を活用していました。

しかし、CANDY HOUSE の利益に明確に反することは、このライブラリの意図するところではありません。そのため、このリリースから、デバイスを操作する全ての API は公式の (有料化された) Web API を利用することにしました。唯一、公式では提供されていないリアルタイムな鍵の状態変化を受け取る機能 (`subscribeMechStatus`) は、オープンソースで公開されている公式の SDK に基づいた (Web API を利用しない) 実装となっています。

後方互換性を維持するように努めているので、このライブラリを利用するユーザへの影響はありません。

What's Changed
* Drop Python 3.6 support and Bump dependencies by mochipon in https://github.com/mochipon/pysesame3/pull/80
* Fix typo: getBatteryPrecentage -> getBatteryPercentage by mochipon in https://github.com/mochipon/pysesame3/pull/81
* Update codecov/codecov-action action to v3 by renovate in https://github.com/mochipon/pysesame3/pull/75
* Update actions/setup-python action to v3 by renovate in https://github.com/mochipon/pysesame3/pull/73
* Update actions/checkout action to v3 by renovate in https://github.com/mochipon/pysesame3/pull/72
* set UUIDv4 as AWSIoT Client ID by konikoni428 in https://github.com/mochipon/pysesame3/pull/78
* Use official Web API to control SESAME devices by mochipon in https://github.com/mochipon/pysesame3/pull/82

New Contributors
* konikoni428 made their first contribution in https://github.com/mochipon/pysesame3/pull/78
* key made their first contribution in https://github.com/mochipon/pysesame3/pull/70

**Full Changelog**: https://github.com/mochipon/pysesame3/compare/v0.5.1...v0.6.0-rc.1

Changelog

⚠️ Noticeable changes for `CognitoAuth` users

Candyhouse no longer issues a user-specific `CLIENT_ID`. It seems that we can continue to use the `CLIENT_ID`s that we have been using, but we no longer need to provide it to use `CognitoAuth`.

Old
python
auth = CognitoAuth(
apikey="API_KEY",
client_id="CLIENT_ID (like: `us-west-1:11111111-2222-3333-4444-555555555555`)",
)


New
python
auth = CognitoAuth(apikey="API_KEY")


[v0.5.1](https://github.com/mochipon/pysesame3/tree/v0.5.1) (2021-11-03)

**Implemented enhancements:**

- \[Request\]: CLIENT\_ID is no longer required for `CognitoAuth` [\64](https://github.com/mochipon/pysesame3/issues/64)

**Merged pull requests:**

- CLIENT\_ID is no longer required for `CognitoAuth` [\65](https://github.com/mochipon/pysesame3/pull/65) ([mochipon](https://github.com/mochipon))
- Update heinrichreimer/github-changelog-generator-action action to v2.3 [\63](https://github.com/mochipon/pysesame3/pull/63) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency pytest-cov to v3 [\60](https://github.com/mochipon/pysesame3/pull/60) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency mkdocs-autorefs to ^0.3.0 [\59](https://github.com/mochipon/pysesame3/pull/59) ([renovate[bot]](https://github.com/apps/renovate))
- Update dependency mkdocstrings to ^0.16.0 [\58](https://github.com/mochipon/pysesame3/pull/58) ([renovate[bot]](https://github.com/apps/renovate))
- SESAME4 support [\57](https://github.com/mochipon/pysesame3/pull/57) ([mochipon](https://github.com/mochipon))

Changelog

I sincerely apologize for the delay of this release. Also, I would like to express my deepest thanks to all those who have tested the pre-release versions ([v0.5.0-rc.1](https://github.com/mochipon/pysesame3/releases/tag/v0.5.0-rc.1), [v0.5.0-rc.2](https://github.com/mochipon/pysesame3/releases/tag/v0.5.0-rc.2)).

This release contains two major changes, the first is support for the SESAME BOT. Please refer to 45, 51, and [the updated docs](https://pysesame3.readthedocs.io/en/v0.5.0/usage/) for details. Also, note that the APIs provided by SESAME Cloud are not fully disclosed in detail. I asked them about [the documentation issues](https://github.com/CANDY-HOUSE/SesameSDK_Android_with_DemoApp/issues/20), but it has been left unanswered for over a month, and I decided to give up.

The second change affects all users who are using Cognito Auth. That is, we have moved the AWS IoT Device SDK from v1 to v2 at 41. This has significantly improved the stability of the connection to the cloud. In addition, it is now possible to connect to multiple locks simultaneously, which means that a door with two locks can be simply controlled (actually this is what I personally needed!).

If you find any problem, kindly report it to me. Thank you!

- - -

⚠️Warning

This is a pre-release version! By default, `pip` only finds stable versions. If you want to try this version, please use `pip install --pre pysesame3[cognito]`.

If you find any problem, kindly report it to me. Thank you!

このバージョンは正式リリース前のリリース候補版です。もし問題を発見したら、どうか [Issue](https://github.com/mochipon/pysesame3/issues) として報告してください。

`pip` は標準でリリース版しかインストールしません。このリリース候補版をインストールするためには `pip install --pre pysesame3[cognito]` コマンドを実行してください。

[v0.5.0-rc.2](https://github.com/mochipon/pysesame3/tree/v0.5.0-rc.2) (2021-07-27)

**Fixed bugs:**

- \[Bug\]: Missing the version menu on the docs site [\49](https://github.com/mochipon/pysesame3/issues/49)

**Merged pull requests:**

- Implement `CHSesameBotMechStatus` for SESAME bot [\51](https://github.com/mochipon/pysesame3/pull/51)
- Update dependency importlib-metadata to v4 [\48](https://github.com/mochipon/pysesame3/pull/48)

⚠️Warning

This is a pre-release version! By default, `pip` only finds stable versions. If you want to try this version, please use `pip install --pre pysesame3[cognito]`.

If you find any problem, kindly report it to me. Thank you!

このバージョンは正式リリース前のリリース候補版です。もし問題を発見したら、どうか [Issue](https://github.com/mochipon/pysesame3/issues) として報告してください。

`pip` は標準でリリース版しかインストールしません。このリリース候補版をインストールするためには `pip install --pre pysesame3[cognito]` コマンドを実行してください。

[v0.5.0-rc.1](https://github.com/mochipon/pysesame3/tree/v0.5.0-rc.1) (2021-07-20)



**Implemented enhancements:**

- \[Request\]: Support simultaneous subscriptions [\40](https://github.com/mochipon/pysesame3/issues/40)

**Merged pull requests:**

- Update codecov/codecov-action action to v2 [\46](https://github.com/mochipon/pysesame3/pull/46)
- 🎉 Support SESAME bot [\45](https://github.com/mochipon/pysesame3/pull/45)
- Doc update for AWS IoT Device SDK v2 [\44](https://github.com/mochipon/pysesame3/pull/44)
- Handle AWS\_ERROR\_MQTT\_ALREADY\_CONNECTED [\43](https://github.com/mochipon/pysesame3/pull/43)
- Enable logging [\42](https://github.com/mochipon/pysesame3/pull/42)
- Move from AWS IoT Device SDK v1 to v2 [\41](https://github.com/mochipon/pysesame3/pull/41)
- Update precommit hook pre-commit/mirrors-isort to v5.9.2 [\39](https://github.com/mochipon/pysesame3/pull/39)