Here is an example of how to use the API with a Python script. The example illustrates how to send a request to the API to retrieve telemetry data for a specific device during a specified time period. The code example shows both a standard call and a call where the user has specified custom names for the data channels.
The response from the API is returned in JSON format. The user can easily save the data for further analysis or use it directly in their application to display the information.

import requests

def get_device_telemetry(device_id, start, stop, custom_names=None): base_url = 'http://127.0.0.1:5000//api/device' url = f"{base_url}/{device_id}/{start}/{stop}"

# Add query-parameters for custom channel names if custom_names: url += '?' + '&'.join([f"{key}={value}" for key, value in custom_names.items()])

response = requests.get(url)

if response.status_code == 200:
return response.json() # Return JSON-data if request fails else: return f"Error: {response.status_code}, {response.text}" # Handle errors

# Example of function
device_id = '3adc1ac0-6108-11ee-aacf-3b6bebd9d6ef'
start_date = '2023-11-28'
stop_date = '2023-11-29'

# Standard call
print(get_device_telemetry(device_id, start_date, stop_date))

# Call with custom channel names
custom_channel_names = {'ch1': 'temperature', 'ch5': 'humidity'} print(get_device_telemetry(device_id, start_date, stop_date, custom_channel_names))

The script or similar could be used together with a CRON-job for example, for retrieving telemtry data at a given interval, like once a day or more often.

Getting started guides

Quick-start guide for Delta Groundwater