Overview

  1. Intro

    Introduction

    Introduction, Data Formats, REST HTTP API, Systems and Equipment, Appendix

  2. Core Concepts

  3. TagModel

    Tagging meta-model

    Metamodel, Entities, Tags, Id, Dis, Example

  4. Structure

    Core entities and structure

    Overview, Containment, Site, Equip, Point, Weather

  5. TimeZones

    Respresentation of timezones

    Overview, Concepts, Zoneinfo, Common TimeZones

  6. Units

    Respresentation of units of measurement

    Overview, Unit System, Database, Common Units

  7. Data Formats

  8. Grids

    Two-dimensional tabular representations of entities

    Overview, Structure, Example

  9. Filters

    Predicates for querying entity databases

    Overview, Usage, Grammar

  10. Zinc

    Zinc plain text format

    Overview, Literals, Syntax, Grammar, Notes, Version History

  11. Json

    JavaScript object notation format

    Overview, Type Mapping, Grid Format

  12. Trio

    Tag record I/O format

    Overview, Format

  13. Csv

    Comma separated value format

    Overview, Grid Format

  14. REST API

  15. Rest

    Rest API

    Overview, Authentication, URI Namespace, Requests, Responses, Error Handling, Error Grid, Content Negotiation, Watches

  16. Ops

    Rest API operations

    Overview, About, Ops, Formats, Read, Nav, WatchSub, WatchUnsub, WatchPoll, PointWrite, HisRead, HisWrite, Invoke Action

  17. Auth

    Authentication

    Overview, HTTP Authentication

  18. Systems and Equipment

  19. VFDs

    Variable Frequency Drives

    Overview, Points, Fans, Pumps

  20. Networks

    Devices, networks, and protocol connections

    Overview, Devices, Networks, Connections

  21. Energy

    Electricity and flow metering

    Overview, Meters, Meter Loads, Elec Meter, Flow Meters, Thermal Meters, Example Model

  22. Zones

    Zones points

    Overview, Zone Points

  23. AHUs

    Air Handler Units and Rooftop Units

    Overview, Tags, Sections, Points

  24. VAVs

    Variable Air Volume Units

    Overview, Tags, Sections, Points

  25. UnitaryEquips

    Unitary heating/cooling equipment

    Overview, Fan Coil Units, Units Ventilators, Heat Pumps

  26. Chillers

    Chillers and Chilled Water Plants

    Overview, Chilled Water Plants, Chillers, Cooling Towers, Heat Exchangers

  27. Boilers

    Boilers and Hot Water/Steam Plants

    Overview, Hot Water Plants, Steam Plants, Boilers, Heat Exchangers

  28. Tanks

    Storage vessels

    Overview, Tags, Points

  29. ElecPanels

    Electric panels and circuits

    Overview, Elec Panel, Circuit

  30. Lighting

    Lighting Systems

    Lighting Groups (Equip), Lighting Points

  31. Developer Notes

  32. Builds

    Rebuilding docs from source

    Overview, Setup, Organization, Design, Doc Format, Tag Format

  33. Bacnet

    Integration with BACnet

    Overview

  34. Appendix

  35. ChangeLog

    Version history

  36. License

    Academic Free License 3.0

    Academic Free License 3.0