bricktheworld / rhombus-api-examples-python

Welcome to Rhombus Systems

Rhombus Systems was built on a foundation of API-driven micro-services. As a result, a deep and comprehensive set of API endpoints exist and are made available to our customers. These API contracts are not an afterthought, but are actually used by internal Rhombus software. This means that anything that the system is capable of doing can also be done via the Rhombus API.

This Repository is home to Python based examples for many of the endpoints of Rhombus Systems' API, examples for other common languages can be found here.

To get started and explore the API's Documentation, Click Here!

For answers to Frequently Asked Questions, Click Here!

Examples in this Repository

example_Name.py

What does this example do?

API Endpoints

• Which endpoints does this example use?

Dependencies

• Does this example have any external dependencies?

add_or_remove_labels.py

This example batch modifies labels based on CLAs

API Endpoints

• face/addFaceLabel
• face/removeFaceLabel

climate_create_seekpoint.py

This example gets the rate of change of the temperature.

API Endpoints

• climate/getMinimalClimateStateList
• climate/getClimateEventsForSensor
• camera/getMinimalCameraStateList
• camera/createFootageSeekpoints

copy_footage_to_local_storage.py

This example pulls footage from a camera on LAN and stores it to the filesystem.

API Endpoints

• org/generateFederatedSessionToken
• camera/getMediaUris

door_report.py

This example gets a report of the recent door openings and closings.

API Endpoints

• location/getLocations
• door/getMinimalDoorStateList
• door/getDoorEventsForSensor

face_report.py

This example gets a report of the recent faces and downloads the pictures of each face.

API Endpoints

• proximity/getMinimalProximityStateList
• face/getRecentFaceEventsV2

get_frame.py

This example pulls a frame from a camera on LAN and saves it.

API Endpoints

• video/getExactFrameUri

licenseplate_report.py

This example gets a report of recent licenseplates and downloads the pictures of each one.

API Endpoints

• camera/getMinimalCameraStateList
• vehicle/getRecentVehicleEvents

tag_filter_stats.py

This example filters through tag movements and creates CSV file..

API Endpoints

• proximity/getMinimalProximityStateList
• location/getLocations
• proximity/getLocomotionEventsForTag

timelapse_saver.py

This example creates a timelapse and saves it in a file.

API Endpoints

• camera/getMinimalCameraStateList
• video/getTimelapseClips
• video/generateTimelapseClip

user_list.py

This example gets a report of all of the Users and their emails.

API Endpoints

• user/getUsersInOrg

video_clip_report.py

This example creates and downloads a clip and accompanying report.

API Endpoints

• camera/getMinimalCameraStateList
• video/spliceV2
• event/getClipsWithProgress
• event/getSavedClipDetails

webhook.py

This example creates a webhook in the Rhombus console and downloads video footage of notified alerts through the webhook.

API Endpoints

• org/generateFederatedSessionToken
• integrations/updateWebhookIntegration