sesame_ros

ROS API for Sesame smart lock made by CANDY HOUSE, Inc.

API key

You have to create your authorization token by logging into the CANDY HOUSE Dashboard: https://my.candyhouse.co/

Note that you must be the owner of your Sesame in order to use Web API.

Please make sure you can see the list of Sesames on CANDY HOUSE Dashboard.

Python Package Requirements

This package supports catkin_virtualenv.

So pip dependencies written in requirements.txt will be automatically installed into virtualenv during build.

Scripts in this package

• list_sesames.py

  A script for listing your Sesames.

  Arguments

  • auth_token (required): Your authorization token. Path to its file is also supported.

• sesame_server.py

  A node for controlling your Sesame.

  Parameters

  • ~auth_token (string, required): Your authorization token. Path to its file is also supported.

  • ~device_id (string, optional): UUID of your Sesame.

  • ~nickname (string, optional): Nickname of your Sesame.

  ~device_id and ~nickname are used for searching Sesame from your Sesame list.

  If neither of them matches or is specified, the first found Sesame will be used.

  • ~command_timeout (int or float, optional): Timeout for executing commands. Default is 60 [sec].

  Advertising services (See Usage section)

  • ~get_status (sesame_ros/Status)

  • ~lock (sesame_ros/Command)

  • ~unlock (sesame_ros/Command)

  • ~force_sync (sesame_ros/Command)

Defined service list

• sesame_ros/Status

---
string nickname
string serial
string device_id
int32 battery
bool locked
bool responsive

• sesame_ros/Command

---
string status
bool successful
string error

Usage

To list your Sesames:

Just run below.

$ rosrun sesame_ros list_sesames.py YOUR_AUTH_TOKEN

To controll your Sesame:

1. Start service server.

    $ roscore
    $ rosrun sesame_ros sesame_server.py _auth_token:=YOUR_AUTH_TOKEN _device_id:=YOUR_SESAME's_UUID
    

1. Call service.

   • To get your Sesame status:

        $ rosservice call /sesame_server/get_status
        

- To lock your Sesame:

        $ rosservice call /sesame_server/lock
        

- To unlock your Sesame:

        $ rosservice call /sesame_server/unlock
        

- To force the server to update your Sesame status:

        $ rosservice call /sesame_server/force_sync
        

Changelog for package sesame_ros

2.1.28 (2023-07-24)

2.1.27 (2023-06-24)

• fix package.xml/CMakeLists.txt to supress catkin_lint errors (#479)
• Contributors: Kei Okada

2.1.26 (2023-06-14)

• add LICENSE files (#476)
• Contributors: Kei Okada

2.1.25 (2023-06-08)

• add test to check if ros node is loadable (#463)
• Explicit python interpreter in catkin_virtualenv (#367)
• Contributors: Kei Okada, Shingo Kitagawa, Yoshiki Obinata

2.1.24 (2021-07-26)

2.1.23 (2021-07-21)

2.1.22 (2021-06-10)

2.1.21 (2020-08-19)

2.1.20 (2020-08-07)

2.1.19 (2020-07-21)

2.1.18 (2020-07-20)

• Fix for noetic (#200)
  • update sesame_ros/requirements.txt to pass https://github.com/locusrobotics/catkin_virtualenv/blob/master/README.md#locking-dependencies
• Contributors: Kei Okada

2.1.17 (2020-04-16)

• update pip modules for security reason (#196)
• add idna==2.7 to cloes ERROR: requests 2.20.0 has requirement idna<2.8,>=2.5, but you'll have idna 2.9 which is incompatible.
• Bump urllib3 from 1.22 to 1.24.2 in /sesame_ros Bumps [urllib3](https://github.com/urllib3/urllib3) from 1.22 to 1.24.2.
  • [Release notes](https://github.com/urllib3/urllib3/releases)
  • [Changelog](https://github.com/urllib3/urllib3/blob/master/CHANGES.rst)

  - [Commits](https://github.com/urllib3/urllib3/compare/1.22...1.24.2) Signed-off-by: dependabot[bot] <<support@github.com>>

• Bump requests from 2.19.1 to 2.20.0 in /sesame_ros Bumps [requests](https://github.com/psf/requests) from 2.19.1 to 2.20.0.
  • [Release notes](https://github.com/psf/requests/releases)
  • [Changelog](https://github.com/psf/requests/blob/master/HISTORY.md)

  - [Commits](https://github.com/psf/requests/compare/v2.19.1...v2.20.0) Signed-off-by: dependabot[bot] <<support@github.com>>

• Bump pyopenssl from 16.2.0 to 17.5.0 in /sesame_ros Bumps [pyopenssl](https://github.com/pyca/pyopenssl) from 16.2.0 to 17.5.0.
  • [Release notes](https://github.com/pyca/pyopenssl/releases)
  • [Changelog](https://github.com/pyca/pyopenssl/blob/master/CHANGELOG.rst)

  - [Commits](https://github.com/pyca/pyopenssl/compare/16.2.0...17.5.0) Signed-off-by: dependabot[bot] <<support@github.com>>

• Contributors: Kei Okada, dependabot[bot]

2.1.16 (2020-04-16)

• add i386 tests (#191)
• specify python module number, closes #190
• Contributors: Kei Okada

2.1.15 (2019-12-12)

• [sesame_ros] Add dependency for building cryptograpy (#180)
  • Add url of ROS wiki for sesame_ros
  • Add k-okada to maintainer of sesame_ros
  • Add libffi-dev and libssl-dev as dependencies of cryptography
• Contributors: Yuto Uchimi

2.1.14 (2019-11-21)

• Add sesame_ros package (#176)
• Contributors: Yuto Uchimi