Niagara Developer Guide Index

Quick Links

Getting Started Instructions for getting the demo up and running quickly.
Changes 3.8 Text file listing changes in each 3.8 build.
Changes 3.7 Text file listing changes in each 3.7 build.
Changes 3.6 Text file listing changes in each 3.6 build.
Changes 3.5 Text file listing changes in each 3.5 build.
Changes 3.4 Text file listing changes in each 3.4 build.
Changes 3.3 Text file listing changes in each 3.3 build.
Changes 3.2 Text file listing changes in each 3.2 build.
Changes 3.1 Text file listing changes in each 3.1 build.
Changes 3.0 Text file listing historical changes in each 3.0 build.

Framework

Overview Provides a high level overview of the Niagara Framework and its problem space.
Architecture Provides a broad overview of the architecture and introduces key concepts such as station, workbench, daemon, fox, and modules.
API Information Provides an overview of API stability designation and public versus implementation APIs.
Modules Provides an introduction to modules which are the software deliverables in the Niagara Framework.
Object Model An introduction to the Niagara type system.
Component Model An introduction to the Niagara component model.
Building Simples Details for building simple Types.
Building Enums Details for building enum Types.
Building Complexes Details for building complex struct and component Types.
Registry The Niagara registry is used to query details about what is installed on a given system.
Naming The Niagara ord naming architecture and its APIs.
Links Discusses object links.
Execution Discusses the runtime execution environment.
Station Discusses station lifecycle.
Remote Programming Describes how the component model is programmed across the network.
Files Discusses how files are mapped into the Niagara object model.
Security Discusses the security model in the Niagara Framework.
Localization Discusses localization in the Niagara Framework.
Spy An overview of the Niagara diagnostics framework.
Licensing An overview of the Niagara licensing framework.
XML An overview of Niagara XML document model and parser APIs.
Bog Format Details of the Bog (Baja Object Graph) XML schema and APIs used to encode and decode component graphs.
Distributions An overview of Niagara Distributions.
Test How to use Niagara's test framework.
Virtual Components An overview of using transient, on-demand (virtual) components.

User Interface

Gx Provides an overview of gx graphic toolkit.
Bajaui Provides an overview of the widget component toolkit.
Workbench Overview of the workbench shell.
Web Overview of web APIs.
Hx Overview of Hx APIs.
Px Overview of Px technology.

Hx

Overview Overview of Hx Architecture
HxView Details of HxView
HxOp Details of HxOp
HxProfile Details of HxProfile
Events Detail of Events
Dialogs Details of Dialogs
Theming Details of Theming

Horizontal Applications

Control Overview of the control and automation module.
History Overview to the historical database module.
Alarm Overview to the alarming module.
Schedule Overview of the scheduling module.
Report Overview of the reporting module.

BQL

BQL Overview of the Baja Query Language.
BQL Expressions Details on BQL expressions.
BQL Examples Provides BQL examples.

Drivers

Driver Framework Overview of the driver framework.
PointDevicelet For reading and writing proxy points.
HistoryDevicelet For importing and exporting histories.
AlarmDevicelet For routing incoming and outgoing alarms.
ScheduleDevicelet Used to perform master/slave scheduling.
Basic Driver APIs for the basic driver framework
BACnet APIs for the BACnet driver
Lonworks APIs for the Lonworks driver
Lon Markup Language Specification for the lonml XML format

Development Tools

Build Documentation on using the build tool to compile and package software modules.
Deploying Help How to build and package help documentation with Niagara modules.
Slot-o-matic 2000 Documentation for the slot-o-matic tool used to aid in the generation of boiler plate code for slot definitions.

Architecture Diagrams

Software Stack Provides an illustration of the major software subsystems in Niagara AX.
Class Diagram Illustration of the class hierarchy.
Communication Illustrates Niagara's software processes and their protocols.
Remote Programming Provides an overview of programming with remote components over fox.
Driver Hierarchy Illustration of driver hierarchy.
ProxyExt Illustration of proxy point design.
Driver Learn Illustration of AbstractManager learn with discovery job.

Series Transforms

Series Schema Working with Graph Node Schema.
Graph Components Creating new graph components for inclusion in the transform graph.
Extending Aggregate Functions Extending functions for the Aggregate and Rollup graph nodes.

Auth Client Example

Scram Sha Auth Client Example Provides an example authentication client for a Niagara AX station.