Connect Freespace to KODE OS for occupancy, indoor environmental quality data integration
Overview
Use this integration to connect Freespace to KODE OS. You can discover areas and sensors (including file-assisted discovery where required), then pull snapshot occupancy and related indoor environmental quality points for utilization reporting.Supported Capabilities
- Discover Devices & Points
- Collect Sensor Data
- File Validation
Prerequisites
- An active account with Freespace and access to their API or developer portal
- OAuth client credentials (Client ID and Client Secret) from the Freespace developer portal
- KODE OS environment with access to Data Sources
Generate API Credentials
- Log in to the Freespace developer portal or admin console
- Navigate to the API or developer settings section
- Create a new API application or client
- Note the Client ID and Client Secret — you will need these when configuring the connector in KODE OS
- Note the Auth URL for OAuth token exchange
Configure Connector in KODE OS
- Navigate to Data Sources in your building
- Click API Catalog and search for Freespace
- Click + Add Datasource
- Fill in the fields below and complete the three-page setup flow
Discover Devices and Points
After configuring the connector, click Discover on the connector detail page. KODE OS will query the Freespace system and return a list of available devices and their data points. Review the discovered items and select the devices you want to register in KODE OS. For more details on the discovery process, see the Discovery guide.Devices and Points
When you discover devices from Freespace, KODE OS maps them to the following device types and data points:Presence / Occupancy Sensor
Canonical Type:presenceDetection
Air Quality Sensor
Canonical Type:airQuality
Traffic Counter
Canonical Type:trafficCounter
What Data You Get
Point History
Time-series readings including count, value, occupancyStatus, occupancyLevel, occupancyNow, pm10, vocIndexSGP40, co2SCD40, and 12 more, collected at regular intervals from connected devicesPolling Schedule
- Point History — Default polling: 1 minutes (min: 1 minutes, max: 1 hours)
Use Cases
Once connected, this integration enables you to:- Track real-time space utilization rates across floors and zones
- Optimize HVAC and lighting schedules based on actual occupancy patterns
- Generate utilization reports to inform space planning and real estate decisions
- Monitor air quality metrics (CO2, VOC, humidity, temperature) across all occupied spaces
Troubleshooting
Authentication or connection error
Authentication or connection error
Verify that the credentials are correct and have not expired. Check that the URL is reachable from the KODE OS environment. Ensure the Client ID and Client Secret match the values from the Freespace developer portal.
Discovery returns no devices
Discovery returns no devices
Verify the connector credentials have sufficient permissions in the Freespace system to list devices. Run a test connection first to confirm connectivity. Some systems require specific API scopes or roles for device enumeration.
Data collection stops or gaps appear
Data collection stops or gaps appear
Check the connector status on the Data Sources page. If the status shows an error, review the error logs on the connector detail page. Common causes include expired credentials, network changes, or rate limiting by the Freespace API.