Reference · built on requestConnectorBuilding management platforms

Distech Controls ECLYPSE

BACnet objects, trend logs, and event notifications from ECLYPSE controllers through the on-device REST API, with property writes.

About

ECLYPSE is Distech Controls' line of BACnet/IP controllers. Each controller serves a REST API at https://{deviceIP}/api/rest/v1 that reads and writes BACnet data on the local device and on remote devices it has discovered, exposes system, network, and user settings, and answers in JSON or XML. The API is at version 1, revision 6, and every resource can be browsed from a browser.

Through Fibric, an operator polls the objects and trend logs it cares about, watches the event notification list, and proposes a property write with a BACnet priority or a weekly schedule change. You approve. The write lands once and a receipt records what changed, why, and how to undo it.

This is a reference listing. It documents what Fibric would read from Distech Controls ECLYPSE and what it could propose, based on the vendor's published interfaces. Fibric builds it under a managed deployment when you request it; selecting it here installs nothing.

Inputs

  • Local BACnet objects and properties through GET /protocols/bacnet/local/objects/{objectType}/{objectInstance}/properties/{propertyName}
  • Trend log records of any BACnet object through GET .../{objectType}/{objectInstance}/trend, with start, stop, limit, and descending options
  • Event notifications for all BACnet objects through GET /protocols/bacnet/local/event-notifications, including EventType, FromState, ToState, and AckRequired
  • Objects with an active override through GET /protocols/bacnet/local/objects/overrides
  • Remote BACnet devices and their objects through /protocols/bacnet/remote/devices/{remoteDeviceId}/objects after start-discovery
  • Many properties in one round trip through POST /protocols/bacnet/local/objects/read-property-multiple
  • Device identity, network adapters, licenses, and extensions through GET /info and GET /system

Proposed actions

  • Target capability: propose a property write through POST .../properties/{propertyName} with a value and an optional BACnet priority query parameter
  • Target capability: propose several point writes in one request through POST /protocols/bacnet/local/objects/write-property-multiple
  • Target capability: propose a weekly-schedule or exception-schedule change through POST /protocols/bacnet/local/objects/schedule/{objectInstance}/properties/...
  • Target capability: propose a Scheduled Call through POST /scheduled-calls, triggered by a cronExpression, a bacnetCov, or a networkValue

Proposed actions are target capabilities. Every action runs propose-first and needs a validated deployment and the appropriate permissions.

What you can build

  • Catch a setpoint that walked away

    The operator reads present-value and setpoint properties on a cycle and compares them with the approved range. When one drifts, it proposes a write at the agreed priority and shows you the trend that justifies it.

    With Setpoint Drift

  • Find equipment running after hours

    Weekly schedules and binary outputs come from the same API. The operator flags outputs that are active outside the schedule and proposes an exception-schedule entry rather than a manual override.

    With After-Hours Audit

  • Start the plant later on mild mornings

    Trend logs give the warm-up curve for each zone. The operator proposes a later occupancy start when the curve allows it and leaves the original schedule in the receipt.

    With Optimal Start

Requirements

  • One or more ECLYPSE controllers reachable over HTTPS on the building network or through a managed tunnel
  • A controller user with the roles needed to read objects and, for writes, to change property values
  • The object type and instance numbers for the points you want, as configured in EC-gfxProgram or Envysion
  • Acceptance of the Distech Controls API license agreement linked from Distech's API documentation
Authentication
HTTP Basic authentication with an ECLYPSE user account; the first authorized request returns an ECLYPSERESTSESSIONID cookie that later requests carry in place of the Authorization header.

Limits

  • The API is per controller; a portfolio means one session per device and no site-level roll-up
  • Trend log frequency is set in the controller's configuration, not through the API; the API only reads what was logged
  • The event-notifications response is available in XML only
  • System query options such as $select and $expand apply only to resources that support them; the trend and write resources do not

Access and pricing

Reference listing. Fibric builds the connector under a managed deployment when you request it. Your quote covers the build, capabilities, usage, and support.

Request Distech Controls ECLYPSE ↗

Questions and answers

Does the ECLYPSE REST API push events, or do I have to poll?
Polling is the documented pattern. GET /protocols/bacnet/local/event-notifications lists current notifications, and the Scheduled Calls resource can run a request on a cron expression or on a BACnet change-of-value and send the result to a configured destination type such as iotHub.
How is a write priority set?
POST to a property resource and add the priority query parameter, for example priority=16. The write-property-multiple resource carries a Priority field per PropertyReference and expects every value as a string, even numbers.
Can one request read many points?
Yes. POST /protocols/bacnet/local/objects/read-property-multiple returns several properties at once, and POST /batch combines multiple sub-requests in one JSON body with an id per request. The batch reply uses 207 when sub-request statuses differ.
Ask about Distech Controls ECLYPSE

Ask about the capabilities and requirements in this listing.

For project-specific requirements, contact Fibric.