openapi: 3.2.0
info:
  title: Smart Lighting Controller Lighting Service API
  version: 1.0.0
servers:
- url: https://cloud-rest.rach.io
security:
- bearerAuth: []
tags:
- name: LightingService
paths:
  /lighting/activateLightingScene/{id}:
    put:
      tags:
      - LightingService
      operationId: LightingService_ActivateLightingScene
      description: Activates a lighting scene
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActivateLightingSceneResponse'
      summary: Lighting service activate lighting scene
      x-summary-source: derived
  /lighting/createLightingProgram:
    post:
      tags:
      - LightingService
      operationId: LightingService_CreateLightingProgram
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLightingProgramRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateLightingProgramResponse'
      summary: Lighting service create lighting program
      x-summary-source: derived
  /lighting/createLightingScene:
    post:
      tags:
      - LightingService
      operationId: LightingService_CreateLightingScene
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLightingSceneRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateLightingSceneResponse'
      summary: Lighting service create lighting scene
      x-summary-source: derived
  /lighting/createLightingZoneGroup:
    post:
      tags:
      - LightingService
      operationId: LightingService_CreateLightingZoneGroup
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLightingZoneGroupRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateLightingZoneGroupResponse'
      summary: Lighting service create lighting zone group
      x-summary-source: derived
  /lighting/deactivateLightingScene/{id}:
    put:
      tags:
      - LightingService
      operationId: LightingService_DeactivateLightingScene
      description: Deactivates a lighting scene. This turns off all zones in the scene.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeactivateLightingSceneResponse'
      summary: Lighting service deactivate lighting scene
      x-summary-source: derived
  /lighting/deleteLightingProgram/{id}:
    delete:
      tags:
      - LightingService
      operationId: LightingService_DeleteLightingProgram
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteLightingProgramResponse'
      summary: Lighting service delete lighting program
      x-summary-source: derived
  /lighting/deleteLightingScene/{id}:
    delete:
      tags:
      - LightingService
      operationId: LightingService_DeleteLightingScene
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteLightingSceneResponse'
      summary: Lighting service delete lighting scene
      x-summary-source: derived
  /lighting/deleteLightingZoneGroup/{id}:
    delete:
      tags:
      - LightingService
      operationId: LightingService_DeleteLightingZoneGroup
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteLightingZoneGroupResponse'
      summary: Lighting service delete lighting zone group
      x-summary-source: derived
  /lighting/getLightingArea/{id}:
    get:
      tags:
      - LightingService
      operationId: LightingService_GetLightingArea
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLightingAreaResponse'
      summary: Lighting service get lighting area
      x-summary-source: derived
  /lighting/getLightingController/{id}:
    get:
      tags:
      - LightingService
      operationId: LightingService_GetLightingController
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLightingControllerResponse'
      summary: Lighting service get lighting controller
      x-summary-source: derived
  /lighting/getLightingProgram/{id}:
    get:
      tags:
      - LightingService
      operationId: LightingService_GetLightingProgram
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLightingProgramResponse'
      summary: Lighting service get lighting program
      x-summary-source: derived
  /lighting/getLightingScene/{id}:
    get:
      tags:
      - LightingService
      operationId: LightingService_GetLightingScene
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLightingSceneResponse'
      summary: Lighting service get lighting scene
      x-summary-source: derived
  /lighting/getLightingZone/{id}:
    get:
      tags:
      - LightingService
      operationId: LightingService_GetLightingZone
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLightingZoneResponse'
      summary: Lighting service get lighting zone
      x-summary-source: derived
  /lighting/getLightingZoneGroup/{id}:
    get:
      tags:
      - LightingService
      operationId: LightingService_GetLightingZoneGroup
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLightingZoneGroupResponse'
      summary: Lighting service get lighting zone group
      x-summary-source: derived
  /lighting/listLightingAreas/{user_id}:
    get:
      tags:
      - LightingService
      operationId: LightingService_ListLightingAreas
      parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLightingAreasResponse'
      summary: Lighting service list lighting areas
      x-summary-source: derived
  /lighting/listLightingControllers/{lighting_area_id}:
    get:
      tags:
      - LightingService
      operationId: LightingService_ListLightingControllers
      parameters:
      - name: lighting_area_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLightingControllersResponse'
      summary: Lighting service list lighting controllers
      x-summary-source: derived
  /lighting/listLightingPrograms:
    get:
      tags:
      - LightingService
      operationId: LightingService_ListLightingPrograms
      parameters:
      - name: lighting_area_id
        in: query
        schema:
          type: string
      - name: lighting_zone_id
        in: query
        schema:
          type: string
      - name: lighting_zone_group_id
        in: query
        schema:
          type: string
      - name: lighting_scene_id
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLightingProgramsResponse'
      summary: Lighting service list lighting programs
      x-summary-source: derived
  /lighting/listLightingScenes/{lighting_area_id}:
    get:
      tags:
      - LightingService
      operationId: LightingService_ListLightingScenes
      parameters:
      - name: lighting_area_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLightingScenesResponse'
      summary: Lighting service list lighting scenes
      x-summary-source: derived
  /lighting/listLightingZoneGroups/{lighting_area_id}:
    get:
      tags:
      - LightingService
      operationId: LightingService_ListLightingZoneGroups
      parameters:
      - name: lighting_area_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLightingZoneGroupsResponse'
      summary: Lighting service list lighting zone groups
      x-summary-source: derived
  /lighting/listLightingZones:
    get:
      tags:
      - LightingService
      operationId: LightingService_ListLightingZones
      parameters:
      - name: lighting_controller_id
        in: query
        schema:
          type: string
      - name: lighting_area_id
        in: query
        schema:
          type: string
      - name: lighting_zone_group_id
        in: query
        schema:
          type: string
      - name: lighting_scene_id
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLightingZonesResponse'
      summary: Lighting service list lighting zones
      x-summary-source: derived
  /lighting/setLightingZoneDesiredDimmingSettings:
    put:
      tags:
      - LightingService
      operationId: LightingService_SetLightingZoneDesiredDimmingSettings
      description: Set a lighting zone's calibration settings. Controller firmware scales all dimming levels to within the min and max range.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetLightingZoneDesiredDimmingSettingsRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetLightingZoneDesiredDimmingSettingsResponse'
      summary: Lighting service set lighting zone desired dimming settings
      x-summary-source: derived
  /lighting/setLightingZoneDimmingLevels:
    put:
      tags:
      - LightingService
      operationId: LightingService_SetLightingZoneDimmingLevels
      description: Set zones to the specified dimming level. This will turn a zone on if it is currently off. Input dimming percentage is automatically scaled by the firmware to within the calibrated dimming range.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetLightingZoneDimmingLevelsRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetLightingZoneDimmingLevelsResponse'
      summary: Lighting service set lighting zone dimming levels
      x-summary-source: derived
  /lighting/setLightingZoneStates:
    put:
      tags:
      - LightingService
      operationId: LightingService_SetLightingZoneStates
      description: Turn zones on or off. Zones turn on to their default dimming percentage.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetLightingZoneStatesRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetLightingZoneStatesResponse'
      summary: Lighting service set lighting zone states
      x-summary-source: derived
  /lighting/updateLightingController:
    put:
      tags:
      - LightingService
      operationId: LightingService_UpdateLightingController
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLightingControllerRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateLightingControllerResponse'
      summary: Lighting service update lighting controller
      x-summary-source: derived
  /lighting/updateLightingProgram:
    put:
      tags:
      - LightingService
      operationId: LightingService_UpdateLightingProgram
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLightingProgramRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateLightingProgramResponse'
      summary: Lighting service update lighting program
      x-summary-source: derived
  /lighting/updateLightingScene:
    put:
      tags:
      - LightingService
      operationId: LightingService_UpdateLightingScene
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLightingSceneRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateLightingSceneResponse'
      summary: Lighting service update lighting scene
      x-summary-source: derived
  /lighting/updateLightingZone:
    put:
      tags:
      - LightingService
      operationId: LightingService_UpdateLightingZone
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLightingZoneRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateLightingZoneResponse'
      summary: Lighting service update lighting zone
      x-summary-source: derived
  /lighting/updateLightingZoneGroup:
    put:
      tags:
      - LightingService
      operationId: LightingService_UpdateLightingZoneGroup
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLightingZoneGroupRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateLightingZoneGroupResponse'
      summary: Lighting service update lighting zone group
      x-summary-source: derived
components:
  schemas:
    LightingZoneReportedState:
      type: object
      description: The last reported state of the zone
      properties:
        state:
          enum:
          - ERROR
          - 'ON'
          - 'OFF'
          type: string
          format: enum
        dimming_settings:
          $ref: '#/components/schemas/LightingZoneReportedDimmingSettings'
        current_wattage:
          type: integer
          format: int32
        max_wattage_reported:
          $ref: '#/components/schemas/WattageMeasurement'
    SetLightingZoneDimmingLevelsRequest:
      type: object
      properties:
        id:
          type: array
          items:
            type: string
        dimming_percent:
          type: integer
          format: uint32
    LightingControllerReportedState:
      type: object
      description: The last reported state of the controller
      properties:
        connected:
          type: boolean
        firmware_version:
          type: string
        state:
          enum:
          - ERROR
          - NORMAL
          - OTA_IN_PROGRESS
          type: string
          format: enum
        log_level:
          enum:
          - INFO
          - WARN
          - ERROR
          - DEBUG
          - TRACE
          type: string
          format: enum
        current_total_wattage:
          type: integer
          format: int32
        last_state_update:
          type: string
          format: date-time
        program_configuration_hash:
          type: string
        rssi:
          type: integer
          format: int32
        rssi_signal_strength:
          enum:
          - NONE
          - POOR
          - STRONG
          type: string
          format: enum
        matter_configuration:
          $ref: '#/components/schemas/LightingControllerReportedMatterConfiguration'
        max_wattage_reported:
          $ref: '#/components/schemas/WattageMeasurement'
    DeactivateLightingSceneResponse:
      type: object
      properties: {}
    UpdateLightingSceneResponse:
      type: object
      properties:
        lighting_scene:
          $ref: '#/components/schemas/LightingScene'
    LightingZoneGroup:
      type: object
      description: A set of lighting zones.
      properties:
        id:
          type: string
        lighting_area_id:
          type: string
        name:
          type: string
        lighting_zone_ids:
          type: array
          items:
            type: string
        order:
          type: integer
          format: uint32
    LightingZoneDesiredDimmingSettings:
      type: object
      description: Desired calibration settings for a zone. Percentage fields are integers [0,100]
      properties:
        min_dimming_percent:
          type: integer
          format: int32
        max_dimming_percent:
          type: integer
          format: int32
        default_dimming_percent:
          type: integer
          format: int32
    DeleteLightingZoneGroupResponse:
      type: object
      properties: {}
    LightingTime:
      type: object
      properties:
        fixed_time:
          $ref: '#/components/schemas/FixedTime'
        sun_position_based_time:
          $ref: '#/components/schemas/SunPositionBasedTime'
    FixedTime:
      type: object
      properties:
        time:
          $ref: '#/components/schemas/Time'
    CreateLightingSceneResponse:
      type: object
      properties:
        lighting_scene:
          $ref: '#/components/schemas/LightingScene'
    ListLightingControllersResponse:
      type: object
      properties:
        lighting_controllers:
          type: array
          items:
            $ref: '#/components/schemas/LightingController'
    UpdateLightingZoneGroupRequest:
      type: object
      description: All update properties aside from the id are optional
      properties:
        id:
          type: string
        name:
          type: string
        lighting_zone_ids:
          $ref: '#/components/schemas/LightingZoneIds'
    DeleteLightingSceneResponse:
      type: object
      properties: {}
    WattageMeasurement:
      type: object
      description: Wattage measurement with timestamp
      properties:
        wattage:
          type: integer
          format: int32
        timestamp:
          type: string
          format: date-time
    Time:
      type: object
      properties:
        hour:
          type: integer
          format: int32
        minute:
          type: integer
          format: int32
        second:
          type: integer
          format: int32
    LightingZoneDimmingSetting:
      type: object
      properties:
        lighting_zone_id:
          type: string
        dimming_percent:
          type: integer
          format: int32
    LightingSceneIds:
      type: object
      properties:
        ids:
          type: array
          items:
            type: string
    LightingZoneReportedDimmingSettings:
      type: object
      description: Reported dimming configuration including calibration and current dim level. Percentage fields are integers [0,100]. Note that the firmware handles scaling based on min and max. The default and current dim levels are always [0,100]
      properties:
        min_dimming_percent:
          type: integer
          format: uint32
        max_dimming_percent:
          type: integer
          format: uint32
        default_dimming_percent:
          type: integer
          format: uint32
        current_dimming_percent:
          type: integer
          format: uint32
    CreateLightingZoneGroupRequest:
      type: object
      properties:
        name:
          type: string
        lighting_area_id:
          type: string
        lighting_zone_ids:
          type: array
          items:
            type: string
    LightingArea:
      type: object
      description: A top level resource that contains all additional lighting resources.
      properties:
        id:
          type: string
        shared:
          type: boolean
          description: shared is true when the user does not actually own this area, but has been granted shared access to it
    SetLightingZoneDimmingLevelsResponse:
      type: object
      properties: {}
    UpdateLightingControllerResponse:
      type: object
      properties:
        lighting_controller:
          $ref: '#/components/schemas/LightingController'
    UpdateLightingZoneRequest:
      type: object
      description: All update properties aside from the id are optional. Adjusting dimmable and max_output will automatically adjust calibration.
      properties:
        id:
          type: string
        name:
          type: string
        enabled:
          type: boolean
        dimmable:
          type: boolean
        max_output:
          enum:
          - TWELVE_VOLTS
          - FIFTEEN_VOLTS
          type: string
          format: enum
    SunPositionBasedTime:
      type: object
      properties:
        sun_position:
          enum:
          - BEFORE_RISE
          - AFTER_RISE
          - BEFORE_SET
          - AFTER_SET
          type: string
          format: enum
        offset_seconds:
          type: integer
          format: int64
    UpdateLightingControllerRequest:
      type: object
      description: All update properties aside from the id are optional
      properties:
        id:
          type: string
        name:
          type: string
    ListLightingZonesResponse:
      type: object
      properties:
        lighting_zones:
          type: array
          items:
            $ref: '#/components/schemas/LightingZone'
    LightingZoneGroupIds:
      type: object
      properties:
        ids:
          type: array
          items:
            type: string
        dimming_settings:
          type: array
          description: Custom program dimming levels to use. Default settings are created when a zone dimming setting is not provided.
          items:
            $ref: '#/components/schemas/LightingZoneDimmingSetting'
    GetLightingZoneResponse:
      type: object
      properties:
        lighting_zone:
          $ref: '#/components/schemas/LightingZone'
    LightingControllerReportedMatterConfiguration:
      type: object
      description: Rachio matter fabric details
      properties:
        fabric_id:
          type: string
        node_id:
          type: string
    CreateLightingProgramRequest:
      type: object
      description: Create a new program. A program can have one of both of on_at and off_at. Only one of zones, groups, or scenes can be provided.
      properties:
        lighting_area_id:
          type: string
        name:
          type: string
        on_at:
          $ref: '#/components/schemas/LightingTime'
        off_at:
          $ref: '#/components/schemas/LightingTime'
        days_of_week:
          type: array
          items:
            enum:
            - MONDAY
            - TUESDAY
            - WEDNESDAY
            - THURSDAY
            - FRIDAY
            - SATURDAY
            - SUNDAY
            type: string
            format: enum
        lighting_zone_ids:
          $ref: '#/components/schemas/LightingZoneIds'
        lighting_zone_group_ids:
          $ref: '#/components/schemas/LightingZoneGroupIds'
        lighting_scene_ids:
          $ref: '#/components/schemas/LightingSceneIds'
    ActivateLightingSceneResponse:
      type: object
      properties: {}
    ListLightingAreasResponse:
      type: object
      properties:
        lighting_areas:
          type: array
          items:
            $ref: '#/components/schemas/LightingArea'
    CreateLightingSceneRequest:
      type: object
      properties:
        name:
          type: string
        lighting_area_id:
          type: string
        lighting_scene_settings:
          type: array
          items:
            $ref: '#/components/schemas/LightingSceneSetting'
    SetLightingZoneStatesResponse:
      type: object
      properties: {}
    ListLightingScenesResponse:
      type: object
      properties:
        lighting_scenes:
          type: array
          items:
            $ref: '#/components/schemas/LightingScene'
    CreateLightingZoneGroupResponse:
      type: object
      properties:
        lighting_zone_group:
          $ref: '#/components/schemas/LightingZoneGroup'
    NullableLightingTime:
      type: object
      description: Set "data" to a new lighting time to update, or "null" to null to remove
      properties:
        'null':
          type: string
        lighting_time:
          $ref: '#/components/schemas/LightingTime'
    GetLightingControllerResponse:
      type: object
      properties:
        lighting_controller:
          $ref: '#/components/schemas/LightingController'
    SetLightingZoneStatesRequest:
      type: object
      properties:
        id:
          type: array
          items:
            type: string
        state:
          enum:
          - 'ON'
          - 'OFF'
          type: string
          format: enum
    SetLightingZoneDesiredDimmingSettingsRequest:
      type: object
      properties:
        id:
          type: string
        desired_dimming_settings:
          $ref: '#/components/schemas/LightingZoneDesiredDimmingSettings'
    UpdateLightingSceneRequest:
      type: object
      description: All update properties aside from the id are optional
      properties:
        id:
          type: string
        name:
          type: string
        lighting_scene_settings:
          $ref: '#/components/schemas/LightingSceneSettings'
    LightingSceneSetting:
      type: object
      description: A setting for a single zone in a scene. The dimming percentage is optional.
      properties:
        lighting_zone_id:
          type: string
        lighting_zone_state:
          enum:
          - 'ON'
          - 'OFF'
          type: string
          format: enum
        dimming_percent:
          type: integer
          format: int32
    UpdateLightingZoneResponse:
      type: object
      properties:
        lighting_zone:
          $ref: '#/components/schemas/LightingZone'
    SetLightingZoneDesiredDimmingSettingsResponse:
      type: object
      properties: {}
    LightingZone:
      type: object
      properties:
        id:
          type: string
        lighting_controller_id:
          type: string
        zone_number:
          type: integer
          format: uint32
        name:
          type: string
        reported_state:
          $ref: '#/components/schemas/LightingZoneReportedState'
        order:
          type: integer
          format: uint32
        enabled:
          type: boolean
        dimmable:
          type: boolean
        lighting_controller_serial_number:
          type: string
        lighting_controller_name:
          type: string
        max_output:
          enum:
          - TWELVE_VOLTS
          - FIFTEEN_VOLTS
          type: string
          format: enum
    DaysOfWeek:
      type: object
      properties:
        days_of_week:
          type: array
          items:
            enum:
            - MONDAY
            - TUESDAY
            - WEDNESDAY
            - THURSDAY
            - FRIDAY
            - SATURDAY
            - SUNDAY
            type: string
            format: enum
    UpdateLightingZoneGroupResponse:
      type: object
      properties:
        lighting_zone_group:
          $ref: '#/components/schemas/LightingZoneGroup'
    UpdateLightingProgramResponse:
      type: object
      properties:
        lighting_program:
          $ref: '#/components/schemas/LightingProgram'
    DeleteLightingProgramResponse:
      type: object
      properties: {}
    GetLightingProgramResponse:
      type: object
      properties:
        lighting_program:
          $ref: '#/components/schemas/LightingProgram'
    GetLightingSceneResponse:
      type: object
      properties:
        lighting_scene:
          $ref: '#/components/schemas/LightingScene'
    LightingScene:
      type: object
      description: Preconfigured lighting settings for a group of zones
      properties:
        id:
          type: string
        lighting_area_id:
          type: string
        name:
          type: string
        lighting_scene_settings:
          type: array
          items:
            $ref: '#/components/schemas/LightingSceneSetting'
    LightingProgram:
      type: object
      properties:
        id:
          type: string
        lighting_area_id:
          type: string
        name:
          type: string
        enabled:
          type: boolean
        on_at:
          $ref: '#/components/schemas/LightingTime'
        off_at:
          $ref: '#/components/schemas/LightingTime'
        days_of_week:
          type: array
          items:
            enum:
            - MONDAY
            - TUESDAY
            - WEDNESDAY
            - THURSDAY
            - FRIDAY
            - SATURDAY
            - SUNDAY
            type: string
            format: enum
        lighting_zone_ids:
          $ref: '#/components/schemas/LightingZoneIds'
        lighting_zone_group_ids:
          $ref: '#/components/schemas/LightingZoneGroupIds'
        lighting_scene_ids:
          $ref: '#/components/schemas/LightingSceneIds'
    GetLightingZoneGroupResponse:
      type: object
      properties:
        lighting_zone_group:
          $ref: '#/components/schemas/LightingZoneGroup'
    LightingSceneSettings:
      type: object
      properties:
        settings:
          type: array
          items:
            $ref: '#/components/schemas/LightingSceneSetting'
    LightingZoneIds:
      type: object
      properties:
        ids:
          type: array
          items:
            type: string
        dimming_settings:
          type: array
          description: Custom program dimming levels to use. Default settings are created when a zone dimming setting is not provided.
          items:
            $ref: '#/components/schemas/LightingZoneDimmingSetting'
    UpdateLightingProgramRequest:
      type: object
      description: All update properties aside from the id are optional. Only one of zones, groups, or scenes can be provided.
      properties:
        id:
          type: string
        name:
          type: string
        enabled:
          type: boolean
        on_at:
          $ref: '#/components/schemas/NullableLightingTime'
        off_at:
          $ref: '#/components/schemas/NullableLightingTime'
        days_of_week:
          $ref: '#/components/schemas/DaysOfWeek'
        lighting_zone_ids:
          $ref: '#/components/schemas/LightingZoneIds'
        lighting_zone_group_ids:
          $ref: '#/components/schemas/LightingZoneGroupIds'
        lighting_scene_ids:
          $ref: '#/components/schemas/LightingSceneIds'
    CreateLightingProgramResponse:
      type: object
      properties:
        lighting_program:
          $ref: '#/components/schemas/LightingProgram'
    GetLightingAreaResponse:
      type: object
      properties:
        lighting_area:
          $ref: '#/components/schemas/LightingArea'
    ListLightingZoneGroupsResponse:
      type: object
      properties:
        lighting_zone_groups:
          type: array
          items:
            $ref: '#/components/schemas/LightingZoneGroup'
    LightingController:
      type: object
      description: A smart lighting controller
      properties:
        id:
          type: string
        lighting_area_id:
          type: string
        serial_number:
          type: string
        mac_address:
          type: string
        model:
          enum:
          - LIGHTING_CONTROLLER_200W_3ZONE_GEN1
          type: string
          format: enum
        name:
          type: string
        reported_state:
          $ref: '#/components/schemas/LightingControllerReportedState'
        max_total_wattage:
          type: integer
          format: int32
        program_configuration_hash:
          type: string
          description: An internal representation of the controller program data
    ListLightingProgramsResponse:
      type: object
      properties:
        lighting_programs:
          type: array
          items:
            $ref: '#/components/schemas/LightingProgram'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
x-provenance:
  method: searched
  source: https://rachio.readme.io/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://rachio.readme.io/reference/lightingservice_activatelightingscene.md
  - https://rachio.readme.io/reference/lightingservice_createlightingprogram.md
  - https://rachio.readme.io/reference/lightingservice_createlightingscene.md
  - https://rachio.readme.io/reference/lightingservice_createlightingzonegroup.md
  - https://rachio.readme.io/reference/lightingservice_deactivatelightingscene.md
  - https://rachio.readme.io/reference/lightingservice_deletelightingprogram.md
  - https://rachio.readme.io/reference/lightingservice_deletelightingscene.md
  - https://rachio.readme.io/reference/lightingservice_deletelightingzonegroup.md
  - https://rachio.readme.io/reference/lightingservice_getlightingarea.md
  - https://rachio.readme.io/reference/lightingservice_getlightingcontroller.md
  - https://rachio.readme.io/reference/lightingservice_getlightingprogram.md
  - https://rachio.readme.io/reference/lightingservice_getlightingscene.md
  - https://rachio.readme.io/reference/lightingservice_getlightingzone.md
  - https://rachio.readme.io/reference/lightingservice_getlightingzonegroup.md
  - https://rachio.readme.io/reference/lightingservice_listlightingareas.md
  - https://rachio.readme.io/reference/lightingservice_listlightingcontrollers.md
  - https://rachio.readme.io/reference/lightingservice_listlightingprograms.md
  - https://rachio.readme.io/reference/lightingservice_listlightingscenes.md
  - https://rachio.readme.io/reference/lightingservice_listlightingzonegroups.md
  - https://rachio.readme.io/reference/lightingservice_listlightingzones.md
  - https://rachio.readme.io/reference/lightingservice_setlightingzonedesireddimmingsettings.md
  - https://rachio.readme.io/reference/lightingservice_setlightingzonedimminglevels.md
  - https://rachio.readme.io/reference/lightingservice_setlightingzonestates.md
  - https://rachio.readme.io/reference/lightingservice_updatelightingcontroller.md
  - https://rachio.readme.io/reference/lightingservice_updatelightingprogram.md
  - https://rachio.readme.io/reference/lightingservice_updatelightingscene.md
  - https://rachio.readme.io/reference/lightingservice_updatelightingzone.md
  - https://rachio.readme.io/reference/lightingservice_updatelightingzonegroup.md
  merge:
    pages: 28
    deduped: 83
    conflicts_kept_first: 0