Get started with Minut Sensors

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

Overview

Seam provides a universal API to connect and control many brands of devices such as smart locks, thermostats, and sensors. This guide provides a rapid introduction to connecting and controlling your Minut sensors using the Seam API. To learn more about other brands of devices supported by Seam, head over to our integration page.

1. Install Seam SDK

Seam provides client libraries for many languages, such as JavaScript, Python, Ruby, PHP, and others, as well as a Postman collection and OpenAPI spec.

npm i seam

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 sensors can be connected. If you need to connect a real Minut sensor, use a non-sandbox workspace and API key.

To control your Minut sensor via the Seam API, you must first authorize your Seam workspace against your Minut account. To do so, Seam provides Connect Webviews: pre-built UX flows that walk you through authorizing your application to control your Minut sensor.

Create a Connect Webview

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: jane@example.com

  • 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:

updated_webview = seam.connect_webviews.get(
    webview.connect_webview_id
)

assert updated_webview.login_successful # true

3. Retrieve Minut Noise Sensors

Minut noise sensors appear with the device_type "minut_sensor". The Minut noise sensors report properties in addition to noise levels, namely temperature and humidity.

sensors = seam.devices.list(device_type="minut_sensor")

sensors[0]
# Device(
#   device_id='fd200f4b-3815-497a-8520-10725c597e0c',
#   device_type='minut_sensor',
#   location={
#     'timezone': 'America/Los_Angeles',
#     'location_name': "Jane's Test Home"
#   },
#   properties={
#     'online': True,
#     'manufacturer': 'minut',
#     'battery_level': 0.5,
#     'minut_metadata': {
#       'home_id': 'f53026ff7c5e314521f285f9',
#       'device_id': '5bb32b83525d243950a92ab8',
#       'home_name': "Jane's Test Home",
#       'device_name': 'Living Room',
#       'home_address': {
#         'city': 'San Francisco',
#         'notes': 'string',
#         'region': 'San Francisco County',
#         'country': 'US',
#         'post_code': '44210',
#         'street_name1': '2258 24th Street',
#         'street_name2': ''
#       },
#       'home_location': {
#         'latitude': 0,
#         'longitude': 0
#       },
#       'device_location': {
#         'latitude': 0,
#         'longitude': 0
#       },
#       'latest_sensor_values': {
#         'sound': {
#           'time': '1970-01-01T00:00:00.000Z',
#           'value': 47.7117919921875
#         },
#         'humidity': {
#           'time': '1970-01-01T00:00:00.000Z',
#           'value': 31.110000610351562
#         },
#         'pressure': {
#           'time': '1970-01-01T00:00:00.000Z',
#           'value': 101923
#         },
#         'temperature': {
#           'time': '1970-01-01T00:00:00.000Z',
#           'value': 21.270000457763672
#         },
#         'accelerometer_z': {
#           'time': '1970-01-01T00:00:00.000Z',
#           'value': -1.00390625
#         }
#       }
#     },
#     'name': 'Living Room',
#     'battery': {
#       'level': 0.5,
#       'status': 'good'
#     },
#     'image_url': 'https://connect.getseam.com/assets/images/devices/minut_gen-3_front.png',
#     'image_alt_text': 'Minut Sensor'
#   },
#   capabilities_supported=['noise_detection'],
#   errors=[]
# )

4. Receive Noise Events

Minut users can define noise thresholds at which noise alerts are sent.

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

@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 support@seam.co

Last updated

Logo

Š Seam Labs, Inc. All rights reserved.