Getting Started¶
Welcome to Normal Framework! This guide will help you go from zero to a working deployment with data flowing from your building systems.
Choose Your Path¶
-
Evaluate NF
Want to see what NF can do? Get a demo license and deploy locally in under 30 minutes.
-
Plan a Production Deployment
Deploying to a real site? Start here for hardware sizing, network planning, and licensing.
-
Build an Integration
Already have NF running? Jump into the SDK and API to build applications and connect to external systems.
Typical Onboarding Journey¶
graph LR
A[Plan Deployment] --> B[Deploy NF]
B --> C[License & Log In]
C --> D[Create Site]
D --> E[Discover Devices]
E --> F[Configure Polling]
F --> G[Model & Integrate]
| Step | What You'll Do | Time Estimate |
|---|---|---|
| 1. Plan | Size hardware, prepare network, choose deployment method | 1--2 hours |
| 2. Deploy | Run NF via Docker or the NF Gateway appliance | 15--30 min |
| 3. License | Activate via the Normal Portal | 5 min |
| 4. Create Site | Set up your building with address and timezone | 2 min |
| 5. Discover | Scan BACnet, Modbus, or Fox networks for devices and objects | 5--30 min |
| 6. Poll | Configure data collection intervals for your points | 10 min |
| 7. Model | Normalize points using Brick/Haystack ontologies | Varies |
| 8. Integrate | Install apps, connect to cloud, export data | Varies |
Guides in This Section¶
- Planning a Deployment -- Hardware, network, licensing, and deployment options
- Quick Start -- Deploy and collect your first data in 30 minutes
- Management Console Tour -- Visual walkthrough of the NF user interface
- After You Deploy -- Next steps for a production system
Need Help?¶
- Normal Portal: portal.normal-online.net -- manage licenses, view your fleet
- SDK & Examples: github.com/normalframework/nf-sdk
- API Reference: See the Protobuf docs or the REST API