IT Setup & Commissioning
The IT setup flow guides administrators through the process of connecting a property to external smart device platforms. This includes credential management, OAuth flows, and device discovery.
Commissioning Flow
┌─────────────┐ ┌───────────────────┐ ┌────────────────┐
│ Pending │────▶│ SmartThings Setup │────▶│ Yale Validated │
└─────────────┘ └───────────────────┘ └────────────────┘
│
┌─────────────────┐ ┌───────────────┐ │
│ Commissioned │◀────│ Commissioning │◀───────────┘
└─────────────────┘ └───────────────┘
Platform Integration
Each property connects to multiple smart device platforms:
| Platform | Auth Method | Required? | Purpose |
|---|---|---|---|
| SmartThings | API Key + Site ID | Baseline | Hub, sensors, locks, appliances |
| Yale | OAuth 2.0 | Baseline | Smart locks, alarm system |
| Hive | Generated email + password | Optional (device-driven) | Heating controls |
| Daikin | OAuth 2.0 (per-property app) | Optional (device-driven) | Altherma heat pump / hot water |
Hive and Daikin are optional: they are only surfaced and connected when the property contains a matching device. See optional-credentials.md for the full primitive.
Credential Generation
The system generates deterministic credentials for each platform:
Email: service+{service_short}.{env}.{hash}@it.broadfordlife.com
Password: [16 chars, mixed case + numbers + symbols]
This approach:
- Avoids storing raw credentials
- Enables credential regeneration if needed
- Provides audit trail via email naming
- Separates environments (dev, staging, prod)
IT Admin Responsibilities
The IT Admin role handles:
- Initial Setup: Enter SmartThings Site ID and API key
- Credential Creation: Generate platform-specific accounts
- OAuth Flows: Complete Yale and Hive authorization
- Device Discovery: Trigger device scanning and pairing
- ID Mapping: Associate external device IDs with internal records
- Cloud Transfer: Finalize handoff to property management
Documentation in This Section
- it-setup-flow.md - Step-by-step commissioning process
- credential-management.md - Secure credential generation and storage
- optional-credentials.md - Device-driven optional credentials, OAuth vs generated, adding a new credential type