The Common Menu Module
The Common Menu module provides access to asset-related metadata and linked timeseries through the Common Menu API.
This API queries the internal Ingenuity model database, and optionally data configured in a third party model (e.g. Cognite), if set in the driver
See also the Asset Model, which is a free-form API for browsing similar data.
What This Module Does
Section titled “What This Module Does”- Lists assets related to a given asset
- Retrieves measurements and timeseries metadata
- Retrieves events for an asset
Key Entry Point
Section titled “Key Entry Point”Use get_common_menu() to create a client:
from eigeningenuity import get_common_menu, EigenServer
ei = EigenServer("https://demo.eigen.co/")menu = get_common_menu(ei)Common Operations
Section titled “Common Operations”Related Assets
Section titled “Related Assets”related = menu.getRelatedAssets("System_01")Measurements
Section titled “Measurements”measurements = menu.getMeasurements("System_01", source="all")Events
Section titled “Events”events = menu.getEvents("System_01", start="24 hours ago", end="now")Output Formats
Section titled “Output Formats”Most calls support:
json(default)df(pandas DataFrame)raw(full API response)file(write JSON to disk)
Authentication
Section titled “Authentication”For secured environments, configure Azure auth before creating the client. See Authentication.