Patrick Schurig
b26274595c
Some checks failed
Build & Deploy docs / build-deploy (push) Failing after 10m17s
- Nouveau générateur scripts/gen_api_reference.py : 19 namespaces → docs/api/metier/ (10) + docs/api/systeme/ (9) + notifications.md + types.md (96 types · 55 enums · 4 flags) + SUMMARY.md literate-nav - Badges permissionScope (perm-none/control/configure/admin) dans extra.css - Guide docs/integrations/jsonrpc-api.md (connexion TCP/WS, auth, conventions énergie) - mkdocs.yml : Référence API dans la nav, REST→JsonRPC renommé - mkdocs build --strict : 0 warnings · --check idempotent Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
223 lines
4.3 KiB
Markdown
223 lines
4.3 KiB
Markdown
# AirConditioning
|
|
|
|
<!-- BEGIN GENERATED: __api_AirConditioning__ -->
|
|
## Méthodes
|
|
|
|
### AirConditioning.AddZone
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Create a zones.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `name` | `String` | |
|
|
| `indoorSensors` | `Uuid`[] | optionnel |
|
|
| `notifications` | `Uuid`[] | optionnel |
|
|
| `outdoorSensors` | `Uuid`[] | optionnel |
|
|
| `thermostats` | `Uuid`[] | optionnel |
|
|
| `windowSensors` | `Uuid`[] | optionnel |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `airConditioningError` | [AirConditioningError](../types.md#airconditioningerror) | |
|
|
| `zone` | [ZoneInfo](../types.md#zoneinfo) | optionnel |
|
|
|
|
---
|
|
|
|
### AirConditioning.GetZones
|
|
|
|
<span class="badge perm-control">CONTROL</span>
|
|
|
|
Get all Zones.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `zoneId` | `Uuid` | optionnel |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `airConditioningError` | [AirConditioningError](../types.md#airconditioningerror) | |
|
|
| `zones` | [ZoneInfos](../types.md#zoneinfos) | |
|
|
|
|
---
|
|
|
|
### AirConditioning.RemoveZone
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Remove a zone.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `zoneId` | `Uuid` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `airConditioningError` | [AirConditioningError](../types.md#airconditioningerror) | |
|
|
|
|
---
|
|
|
|
### AirConditioning.SetZoneName
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Set zone name.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `name` | `String` | |
|
|
| `zoneId` | `Uuid` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `airConditioningError` | [AirConditioningError](../types.md#airconditioningerror) | |
|
|
|
|
---
|
|
|
|
### AirConditioning.SetZoneSetpointOverride
|
|
|
|
<span class="badge perm-control">CONTROL</span>
|
|
|
|
Set zone setpoint override temperature. Parameter minutes gives the minutes until the setpoint should return to the standby/schedule.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `mode` | [SetpointOverrideMode](../types.md#setpointoverridemode) | |
|
|
| `minutes` | `Int` | optionnel |
|
|
| `setpointOverride` | `Double` | |
|
|
| `zoneId` | `Uuid` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `airConditioningError` | [AirConditioningError](../types.md#airconditioningerror) | |
|
|
|
|
---
|
|
|
|
### AirConditioning.SetZoneStandbySetpoint
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Set zone standby setpoint temperature.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `standbySetpoint` | `Double` | |
|
|
| `zoneId` | `Uuid` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `airConditioningError` | [AirConditioningError](../types.md#airconditioningerror) | |
|
|
|
|
---
|
|
|
|
### AirConditioning.SetZoneThings
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Set Zone things
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `indoorSensors` | `Uuid`[] | optionnel |
|
|
| `notifications` | `Uuid`[] | optionnel |
|
|
| `outdoorSensors` | `Uuid`[] | optionnel |
|
|
| `thermostats` | `Uuid`[] | optionnel |
|
|
| `windowSensors` | `Uuid`[] | optionnel |
|
|
| `zoneId` | `Uuid` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `airConditioningError` | [AirConditioningError](../types.md#airconditioningerror) | |
|
|
|
|
---
|
|
|
|
### AirConditioning.SetZoneWeekSchedule
|
|
|
|
<span class="badge perm-control">CONTROL</span>
|
|
|
|
Set the time schedule for a zone.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `weekSchedule` | [TemperatureWeekSchedule](../types.md#temperatureweekschedule) | |
|
|
| `zoneId` | `Uuid` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `airConditioningError` | [AirConditioningError](../types.md#airconditioningerror) | |
|
|
|
|
---
|
|
|
|
## Notifications
|
|
|
|
### AirConditioning.ZoneAdded
|
|
|
|
Emitted whenever a zone is added
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `zone` | [ZoneInfo](../types.md#zoneinfo) | |
|
|
|
|
---
|
|
|
|
### AirConditioning.ZoneChanged
|
|
|
|
Emitted whenever a zone changes
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `zone` | [ZoneInfo](../types.md#zoneinfo) | |
|
|
|
|
---
|
|
|
|
### AirConditioning.ZoneRemoved
|
|
|
|
Emitted whenever a zone is removed
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `zoneId` | `Uuid` | |
|
|
|
|
---
|
|
|
|
<!-- END GENERATED -->
|