Neowit developer docs
API referenceSupportKnowledge baseStatusApp
  • Overview
  • REST API
    • Introduction
    • Authentication
      • OAuth2
      • Basic Auth
    • Error codes
    • API reference
    • Coordinate systems
    • Query Language
      • Query Language Reference
  • Service Accounts
    • Introduction
    • Creating service accounts
  • Integrations
    • Introduction
    • MQTT
      • Native Sparkplug
      • Custom Starlark
  • Starlark
    • Introduction
    • Modules
      • time module
      • json module
      • math module
      • devices module
      • series module
      • sensors module
  • Tutorials
    • Introduction
    • Create users using API
Powered by GitBook
On this page
  • Introduction
  • Example
  • Functions
  • def publish(external_id: str, timestamp: int64, sensor: SensorType, value: number = None):
  1. Starlark
  2. Modules

series module

Previousdevices moduleNextsensors module

Last updated 11 months ago

Introduction

This modules enables publishing metrics towards the Neowit metrics store.

Example

This example defines and registers a new and then publishes a temperature sensor metric towards Neowit metrics store.

# defined the device and its attributes
device = devices.Device(
  external_id = id,
  name = "My temperature sensor in room 302",
  vendor = "Contoso Galactic",
  model = "HotHot",
  status = "STATUS_CONNECTED",
  status_reason = "OK"
)
# register or update the attributes of the device
devices.upsert(device)

# publish the new temperature metric
series.publish(device.external_id, time.now().unix, sensors.TEMP, 30.2)

Functions

def publish(external_id: str, timestamp: int64, sensor: , value: number = None):

Publishes a new metric value for the device with external_id that occured on the current time of execution with a sensor type of

devices.Device
SensorType
sensors.TEMP