Air Quality Sensor (Vaisala - XWeather) Websocket Connection Help
Trying to connect websocket in ArcGIS Velocity for Vaisala Air Quality sensors, hosted with XWeather. I'm getting an error in ArcGIS Velocity for the first step - just adding in the URI. I do need to incorporate the api key, so I'm wondering if I'm getting the error because there is not a place to add in an api-key header parameters on the first step?
The company confirmed websocket is external and has given me Python to try to make sure my API key is good, but I've never used Python so not really sure how to use that. Ultimately, I really just want to connect to the sensor in ArcGIS Velocity and not worry about python!
Websocket: wss://ws-api.eu.platform.xweather.com
URI to call a specific sensor (I think?):
wss://ws-api.eu.platform.xweather.com/measurement-stream?sensor-id=urn:dev:ops:16961AQT530-V0810232
But gives error in ArcGIS Velocity. Would this be because the api-key is not in the URL? Is there a way to add this into the URL? Or should I be able to connect to the base uri without the parameters?
##
#
# Copyright (c) Vaisala Oyj. All rights reserved.
#
##
import asyncio
import pathlib
import ssl
import websocketsbase_uri = "wss://ws-api.eu.platform.xweather.com"
endpoint = "/measurement-stream"
api_key = "" # Place api-key here
sensor_id = "urn:dev:ops:16961-AQT530-V0810232"
uri = f"{base_uri}{endpoint}?sensor-id={sensor_id}"
headers = {"x-api-key": api_key,}
async with websockets.connect(uri, extra_headers=headers) as websocket:
print("WebSocket connection established")
# Receive data once
response = await websocket.recv()
print(f"{response}")
if __name__ == "__main__":
asyncio.get_event_loop().run_until_complete(connect_websocket())
Hi @PeterNasuti or @JeffSilberberg ! Glad to see the Velocity update! I'm trying out connecting to my two websocket sensors, got past adding the header parameter with the API key, yay! But am having a bit of trouble with deriving the schema. Vaisala's documentation says it's using JSON but it's got two or three pieces that are nested and Velocity isn't detecting it automatically. Think you could take a look and give me advice on how to set up the schema? This would be my first time really working with JSON where the schema wasn't auto-detected. How would I use the Flatten options? Which is the root node? I did see this documentation: https://doc.arcgis.com/en/iot/ingest/configure-input-data.htm#ESRI_SECTION1_65F4CA586A08486CA1675BD2...
Thanks!!
This is an example payload they provided in their API documentation (there would be probably 4 or 5 measurementType but below is just one for AIR_PRESSURE):
[
{
"observedTime": "2023-05-12T14:49:00Z",
"value": 1021.1,
"sourceId": "urn:dev:ops:16961-WXT530-S4131016",
"quality": {
"qualityValue": 8500,
"checkLevel": 1,
"checkedAt": "2023-05-12T14:49:00Z",
"qualityReasons": [
{
"name": "Level0.Unknown",
"description": "ACCEPTED by the measurement device."
}
]
},
"measurementType": {
"parameter": "AIR_PRESSURE",
"unit": "HECTOPASCALS",
"statistics": "MEAN",
"period": "PT1M",
"height": 2,
"dataLevel": "LEVEL_TWO"
}
}
]
