Get started with Minut

Learn how to connect and control your Minut monitors sensors with the Seam API

Overview
The Minut integration is still in beta, some details of this guide may change as the integration reaches stability.
1. Install Seam SDK
Seam provides client libraries for many languages such as Javascript, Python, Ruby, and PHP, as well as a Postman collection and OpenAPI spec.
Javascript: npm i seamapi (npm, github)
Python: pip install seamapi (pip, github)
Ruby: bundle add seamapi (rubygem, github)
PHP: composer require seamapi/seam (packagist, github)
Once installed, sign-up for Seam to get your API key, and export it as an environment variable:
$ export SEAM_API_KEY=seam_test2ZTo_0mEYQW2TvNDCxG5Atpj85Ffw
This guide uses a Sandbox Workspace. Only virtual devices can be connected. If you need to connect a real August Lock, use a non-sandbox workspace and API key.
2. Link Minut Account with Seam
To control your August lock via the Seam API, you must first authorize your Seam workspace against your August account. To do so, Seam provides Connect Webviews: pre-built UX flows that walk you through authorizing your application to control your August lock.
Create a Connect Webview
Python
from seamapi import Seam
seam = Seam()
​
webview = seam.connect_webviews.create(accepted_providers=["minut"])
​
assert webview.login_successful is False
​
# Send this webview url to your user!
print(webview.url)
Authorize Your Workspace
Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the Minut sandbox test accounts credentials below:
email: [email protected]
password: 1234
Get the New Webview
After you complete the login above, you'll get an event for connected_account.createdif you set up a webhook handler. Otherwise you can just poll for the webview until it's status changes, as shown below:
Python
updated_webview = seam.connect_webviews.get(
    webview.connect_webview_id
)
​
assert updated_webview.login_successful # true
3. Retrieve Minut Noise Monitors
Minut noise monitors appear with the device_type "minut_noise_monitor". The Minut noise sensors report properties in addition to noise levels, namely temperature and humidity.
Python
sensors = seam.devices.list(device_type="minut_noise_monitor")
​
sensors[0]
# Device(
#   device_type="minut_noise_monitor",
#   location=None,
#   properties={
#     "online": True,
#     "last_reported_noise_level_decibels": 40,
#     "temperature_celsius": 20,
#     "temperature_fahrenheit": 68,
#     "humidity": 0.78,     
#   }
# )
4. Receive Noise Events
Minut users can define noise thresholds at which 
You'll get an event for noise_threshold.noise_threshold_triggered when you set up a webhook handler. You can also poll for events.
Minut has a builtin threshold that can be triggered multiple times. Each Minut notice will trigger a noise_threshold_triggered event with the minut_metadata.event_name containing the Minut event name, which can be any of the following:
disturbance_first_notice
disturbance_second_notice
disturbance_third_notice
disturbance_ended
Python
@app.route("/my_webhook_endpoint", methods=["POST"])
def endpoint():
    event = request.json["event"]
    # {
    #    noise_threshold_id: "...",
    #    noise_threshold_name: "builtin_disturbance"
    #    minut_metadata: {
    #       "event_name": "disturbance_first_notice",
    #    },
    #    device_id: "...";
    #    noise_level_decibels: 40,
    #    created_at: "2023-03-14T05:00:35.451Z"
    # }
        
Next Steps
Now that you've completed this guide, you can try to connect a real Minut device. To do so, make sure to switch to a non-sandbox workspace and API key as real devices cannot be connected to sandbox workspaces.
If you have any questions or want to report an issue, email us at [email protected]
​

Device Guides - Previous

Get started with Salto Locks

Next - Device Guides

Get started with SmartThings Hubs + Smart Locks

Last modified 13d ago