# getSystemInformation

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /json-rpc/system:
    post:
      summary: getSystemInformation
      deprecated: false
      description: >-
        Provides data about the live state of Hyperion, broken down into a
        number of different parts.
      tags:
        - Hyperion API/Information
        - Websocket
        - HTTP/S
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                command:
                  type: string
                  description: The type of command to execute.
                  title: ''
                  enum:
                    - serverinfo
                  x-apidog-enum:
                    - value: serverinfo
                      name: ''
                      description: ''
                subcommand:
                  type: string
                  description: The type of sub-command to execute.
                  title: ''
                  enum:
                    - getInfo
                  x-apidog-enum:
                    - value: getInfo
                      name: ''
                      description: ''
                instance: &ref_0
                  description: Instance index (0-254) to which the command applies.
                  $ref: '#/components/schemas/instance%20-%20single'
                tan:
                  type: integer
                  minimum: 0
                  examples:
                    - 4711
                  description: Transaction number for tracking requests and responses.
              x-apidog-orders:
                - command
                - subcommand
                - instance
                - 01JVHARBC5KH9YQ6YNQ1TTGE9W
              required:
                - command
                - subcommand
              x-apidog-refs:
                01JVHARBC5KH9YQ6YNQ1TTGE9W:
                  $ref: '#/components/schemas/tan'
              x-apidog-ignore-properties:
                - tan
            example:
              command: serverinfo
              subcommand: getInfo
              tan: 4711
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  command:
                    type: string
                    description: The command executed
                  subcommand:
                    type: string
                    description: The sub-command executed
                  info:
                    type: object
                    properties:
                      activeEffects:
                        type: array
                        items:
                          type: object
                          properties:
                            args:
                              type: object
                              properties:
                                blobs:
                                  type: integer
                                color:
                                  type: array
                                  items:
                                    type: integer
                                hueChange:
                                  type: integer
                                reverse:
                                  type: boolean
                                rotationTime:
                                  type: integer
                                smoothing-custom-settings:
                                  type: 'null'
                              required:
                                - blobs
                                - color
                                - hueChange
                                - reverse
                                - rotationTime
                                - smoothing-custom-settings
                              x-apidog-orders:
                                - blobs
                                - color
                                - hueChange
                                - reverse
                                - rotationTime
                                - smoothing-custom-settings
                              x-apidog-ignore-properties: []
                            name:
                              type: string
                            priority:
                              type: integer
                            script:
                              type: string
                            timeout:
                              type: integer
                          x-apidog-orders:
                            - args
                            - name
                            - priority
                            - script
                            - timeout
                          x-apidog-ignore-properties: []
                      activeLedColor:
                        type: array
                        items:
                          type: string
                      adjustment:
                        type: array
                        items:
                          type: object
                          properties:
                            backlightColored:
                              type: boolean
                            backlightThreshold:
                              type: integer
                            blue:
                              type: array
                              items:
                                type: integer
                            brightness:
                              type: integer
                            brightnessCompensation:
                              type: integer
                            brightnessGain:
                              type: integer
                            cyan:
                              type: array
                              items:
                                type: integer
                            gammaBlue:
                              type: number
                            gammaGreen:
                              type: number
                            gammaRed:
                              type: number
                            green:
                              type: array
                              items:
                                type: integer
                            id:
                              type: string
                            magenta:
                              type: array
                              items:
                                type: integer
                            red:
                              type: array
                              items:
                                type: integer
                            saturationGain:
                              type: integer
                            temperature:
                              type: integer
                            white:
                              type: array
                              items:
                                type: integer
                            yellow:
                              type: array
                              items:
                                type: integer
                          x-apidog-orders:
                            - backlightColored
                            - backlightThreshold
                            - blue
                            - brightness
                            - brightnessCompensation
                            - brightnessGain
                            - cyan
                            - gammaBlue
                            - gammaGreen
                            - gammaRed
                            - green
                            - id
                            - magenta
                            - red
                            - saturationGain
                            - temperature
                            - white
                            - yellow
                          x-apidog-ignore-properties: []
                        description: >-
                          Adjustments reflect the value of the last performed
                          (non-persistent) color adjustment (e.g. brightness). 
                      cec:
                        type: object
                        properties:
                          enabled:
                            type: boolean
                        required:
                          - enabled
                        x-apidog-orders:
                          - enabled
                        x-apidog-ignore-properties: []
                      components:
                        type: array
                        items:
                          type: object
                          properties:
                            enabled:
                              type: boolean
                            name:
                              type: string
                          required:
                            - enabled
                            - name
                          x-apidog-orders:
                            - enabled
                            - name
                          x-apidog-ignore-properties: []
                        description: >-
                          List of Hyperion components and their current status
                          "enabled" (on/off). You can enable or disable them
                          during runtime . The "ALL" component reflect Hyperion
                          as a whole -- if "ALL" is false (off) you can't enable
                          any other component. 
                      effects:
                        type: array
                        items:
                          type: object
                          properties:
                            args:
                              type: object
                              properties:
                                center_x:
                                  type: number
                                center_y:
                                  type: number
                                custom-colors:
                                  type: array
                                  items:
                                    type: array
                                    items:
                                      type: integer
                                custom-colors2:
                                  type: array
                                  items:
                                    type: array
                                    items:
                                      type: integer
                                enable-second:
                                  type: boolean
                                random-center:
                                  type: boolean
                                reverse:
                                  type: boolean
                                rotation-time:
                                  type: integer
                                blobs:
                                  type: integer
                                color:
                                  type: array
                                  items:
                                    type: integer
                                hueChange:
                                  type: integer
                                rotationTime:
                                  type: integer
                                color-end:
                                  type: array
                                  items:
                                    type: integer
                                color-end-time:
                                  type: integer
                                color-start:
                                  type: array
                                  items:
                                    type: integer
                                color-start-time:
                                  type: integer
                                fade-in-time:
                                  type: integer
                                fade-out-time:
                                  type: integer
                                maintain-end-color:
                                  type: boolean
                                repeat-count:
                                  type: integer
                                brightness:
                                  type: integer
                                candles:
                                  type: string
                                sleepTime:
                                  type: number
                                smoothing-custom-settings:
                                  type: boolean
                                smoothing-time_ms:
                                  type: integer
                                smoothing-updateFrequency:
                                  type: integer
                                baseChange:
                                  type: boolean
                                baseColorChangeRate:
                                  type: integer
                                baseColorRangeLeft:
                                  type: integer
                                baseColorRangeRight:
                                  type: integer
                                explodeRadius:
                                  type: integer
                                speed:
                                  type: integer
                                trailLength:
                                  type: integer
                                center_x2:
                                  type: number
                                center_y2:
                                  type: number
                                random-center2:
                                  type: boolean
                                reverse2:
                                  type: boolean
                                cropBottom:
                                  type: integer
                                cropLeft:
                                  type: integer
                                cropRight:
                                  type: integer
                                cropTop:
                                  type: integer
                                file:
                                  type: string
                                fps:
                                  type: integer
                                grayscale:
                                  type: boolean
                                imageSource:
                                  type: string
                                countries:
                                  type: array
                                  items:
                                    type: string
                                switch-time:
                                  type: integer
                                colorRandom:
                                  type: boolean
                                fadeFactor:
                                  type: number
                                testleds:
                                  type: string
                                background-color:
                                  type: array
                                  items:
                                    type: integer
                                hour-color:
                                  type: array
                                  items:
                                    type: integer
                                marker-color:
                                  type: array
                                  items:
                                    type: integer
                                marker-depth:
                                  type: integer
                                marker-enabled:
                                  type: boolean
                                marker-width:
                                  type: integer
                                minute-color:
                                  type: array
                                  items:
                                    type: integer
                                second-color:
                                  type: array
                                  items:
                                    type: integer
                                show_seconds:
                                  type: boolean
                                margin-pos:
                                  type: integer
                                color_one:
                                  type: array
                                  items:
                                    type: integer
                                color_two:
                                  type: array
                                  items:
                                    type: integer
                                colors_count:
                                  type: integer
                                saturation:
                                  type: integer
                                colors:
                                  type: array
                                  items:
                                    type: array
                                    items:
                                      type: integer
                                reverse_time:
                                  type: integer
                                rotation_time:
                                  type: integer
                                percentage:
                                  type: integer
                                random-color:
                                  type: boolean
                                sleep-time:
                                  type: number
                                alarm-color:
                                  type: array
                                  items:
                                    type: integer
                                initial-blink:
                                  type: boolean
                                post-color:
                                  type: array
                                  items:
                                    type: integer
                                set-post-color:
                                  type: boolean
                                shutdown-enabled:
                                  type: boolean
                                height:
                                  type: integer
                                max_len:
                                  type: integer
                                min_len:
                                  type: integer
                                random:
                                  type: boolean
                                trails:
                                  type: integer
                                color1:
                                  type: array
                                  items:
                                    type: integer
                                color2:
                                  type: array
                                  items:
                                    type: integer
                                length:
                                  type: integer
                              x-apidog-orders:
                                - center_x
                                - center_y
                                - custom-colors
                                - custom-colors2
                                - enable-second
                                - random-center
                                - reverse
                                - rotation-time
                                - blobs
                                - color
                                - hueChange
                                - rotationTime
                                - color-end
                                - color-end-time
                                - color-start
                                - color-start-time
                                - fade-in-time
                                - fade-out-time
                                - maintain-end-color
                                - repeat-count
                                - brightness
                                - candles
                                - sleepTime
                                - smoothing-custom-settings
                                - smoothing-time_ms
                                - smoothing-updateFrequency
                                - baseChange
                                - baseColorChangeRate
                                - baseColorRangeLeft
                                - baseColorRangeRight
                                - explodeRadius
                                - speed
                                - trailLength
                                - center_x2
                                - center_y2
                                - random-center2
                                - reverse2
                                - cropBottom
                                - cropLeft
                                - cropRight
                                - cropTop
                                - file
                                - fps
                                - grayscale
                                - imageSource
                                - countries
                                - switch-time
                                - colorRandom
                                - fadeFactor
                                - testleds
                                - background-color
                                - hour-color
                                - marker-color
                                - marker-depth
                                - marker-enabled
                                - marker-width
                                - minute-color
                                - second-color
                                - show_seconds
                                - margin-pos
                                - color_one
                                - color_two
                                - colors_count
                                - saturation
                                - colors
                                - reverse_time
                                - rotation_time
                                - percentage
                                - random-color
                                - sleep-time
                                - alarm-color
                                - initial-blink
                                - post-color
                                - set-post-color
                                - shutdown-enabled
                                - height
                                - max_len
                                - min_len
                                - random
                                - trails
                                - color1
                                - color2
                                - length
                              x-apidog-ignore-properties: []
                            file:
                              type: string
                            name:
                              type: string
                            script:
                              type: string
                          required:
                            - file
                            - name
                            - script
                          x-apidog-orders:
                            - args
                            - file
                            - name
                            - script
                          x-apidog-ignore-properties: []
                        description: >-
                          An array of effects where each object is one named
                          effect. You can filter between user created effects
                          and system provided effects by checking the effect
                          file string -- if it begins with : it's a system
                          provided effect, whereas if the path begins with /,
                          it's a user created effect.
                      grabbers:
                        type: object
                        properties:
                          audio:
                            type: object
                            properties:
                              active:
                                type: array
                                items:
                                  type: string
                              available:
                                type: array
                                items:
                                  type: string
                            x-apidog-orders:
                              - active
                              - available
                            required:
                              - available
                            x-apidog-ignore-properties: []
                          screen:
                            type: object
                            properties:
                              active:
                                type: array
                                items:
                                  type: string
                              available:
                                type: array
                                items:
                                  type: string
                            required:
                              - available
                            x-apidog-orders:
                              - active
                              - available
                            x-apidog-ignore-properties: []
                          video:
                            type: object
                            properties:
                              active:
                                type: array
                                items:
                                  type: string
                              available:
                                type: array
                                items:
                                  type: string
                            x-apidog-orders:
                              - active
                              - available
                            required:
                              - available
                            x-apidog-ignore-properties: []
                        required:
                          - audio
                          - screen
                          - video
                        x-apidog-orders:
                          - audio
                          - screen
                          - video
                        x-apidog-ignore-properties: []
                      hostname:
                        type: string
                      imageToLedMappingType:
                        type: string
                        description: Active mode of the led area mapping.
                      instance:
                        type: array
                        items:
                          type: object
                          properties:
                            friendly_name:
                              type: string
                            instance: *ref_0
                            running:
                              type: boolean
                          required:
                            - friendly_name
                            - instance
                            - running
                          x-apidog-orders:
                            - friendly_name
                            - instance
                            - running
                          x-apidog-ignore-properties: []
                        description: >-
                          Information about available instances and their state.
                          Each instance represents a LED device.
                      ledDevices:
                        type: object
                        properties:
                          available:
                            type: array
                            items:
                              type: string
                        required:
                          - available
                        x-apidog-orders:
                          - available
                        description: LED devices which can be used
                        x-apidog-ignore-properties: []
                      leds:
                        type: array
                        items:
                          type: object
                          properties:
                            hmax:
                              type: integer
                            hmin:
                              type: integer
                            vmax:
                              type: number
                            vmin:
                              type: integer
                          x-apidog-orders:
                            - hmax
                            - hmin
                            - vmax
                            - vmin
                          x-apidog-ignore-properties: []
                        description: >-
                          Information about LED layout (image mapping positions)
                          and LED count.
                      priorities:
                        type: array
                        items:
                          type: object
                          properties:
                            active:
                              type: boolean
                              description: ' If "true" it is selectable for manual source selection. '
                            componentId:
                              type: string
                              description: >-
                                A key belonging to a specific component that
                                indicates the kind of input.
                            origin:
                              type: string
                              description: >-
                                A named external setter of this source for
                                reference purposes. If not given it's System
                                (from Hyperion).
                            owner:
                              type: string
                              description: >-
                                Contains additional information related to the
                                componentId. If it's an effect, the effect name
                                is shown here. If it's USB capture, the capture
                                device is shown. If it's platform capture, you
                                get the name of the platform capture
                                implementation (e.g. dispmanx/x11/amlogic/...).
                            priority:
                              type: integer
                              description: >-
                                The priority of this source, an integer between
                                0 and 255.
                            value:
                              type: object
                              properties:
                                HSL:
                                  type: array
                                  items:
                                    oneOf:
                                      - type: integer
                                      - type: number
                                RGB:
                                  type: array
                                  items:
                                    type: integer
                              required:
                                - HSL
                                - RGB
                              x-apidog-orders:
                                - HSL
                                - RGB
                              description: >-
                                If the source is a color AND color data is
                                available (if active is false there's usually no
                                data), then this will be the color in RGB and
                                HSL.
                              x-apidog-ignore-properties: []
                            visible:
                              type: boolean
                              description: >-
                                If "true" this source is displayed and pushed to
                                the led device. The visible:true-source is
                                always the first entry!
                            duration_ms:
                              type: integer
                              description: >-
                                Actual duration in ms until this priority is
                                automatically deleted. This is shown if source
                                is color or effect AND a specific duration
                                higher than 0 is set (0 means indefinite).
                          required:
                            - active
                            - componentId
                            - origin
                            - priority
                            - visible
                          x-apidog-orders:
                            - active
                            - componentId
                            - origin
                            - owner
                            - priority
                            - value
                            - visible
                            - duration_ms
                          x-apidog-ignore-properties: []
                        description: >-
                          Overview of the registered/active sources. Each object
                          in the list is a source.
                      priorities_autoselect:
                        type: boolean
                        description: >-
                          If priorities_autoselect is "true" the visible source
                          is determined by priority. The lowest number is
                          automatically selected. If a caller requests to set a
                          source manually, then priorities_autoselect switches
                          to false.


                          If the manually selected source is
                          cleared/stops/completes-duration OR the user requests
                          the auto selection, priorities_autoselect switches
                          back to true. This value is atomically updated with
                          the priority updates (shown above).
                      services:
                        type: array
                        items:
                          type: string
                      transform:
                        type: array
                        items:
                          type: object
                          properties:
                            blacklevel:
                              type: array
                              items:
                                type: integer
                            brightnessGain:
                              type: integer
                            gamma:
                              type: array
                              items:
                                type: number
                            id:
                              type: string
                            luminanceGain:
                              type: integer
                            luminanceMinimum:
                              type: integer
                            saturationGain:
                              type: integer
                            saturationLGain:
                              type: integer
                            threshold:
                              type: array
                              items:
                                type: integer
                            whitelevel:
                              type: array
                              items:
                                type: integer
                          x-apidog-orders:
                            - blacklevel
                            - brightnessGain
                            - gamma
                            - id
                            - luminanceGain
                            - luminanceMinimum
                            - saturationGain
                            - saturationLGain
                            - threshold
                            - whitelevel
                          x-apidog-ignore-properties: []
                      videomode:
                        type: string
                        description: >-
                          The current video mode of grabbers. Can be switched to
                          3DHSBS, 3DVSBS.
                    required:
                      - activeEffects
                      - activeLedColor
                      - adjustment
                      - cec
                      - components
                      - effects
                      - grabbers
                      - hostname
                      - imageToLedMappingType
                      - instance
                      - ledDevices
                      - leds
                      - priorities
                      - priorities_autoselect
                      - services
                      - transform
                      - videomode
                    x-apidog-orders:
                      - activeEffects
                      - activeLedColor
                      - adjustment
                      - cec
                      - components
                      - effects
                      - grabbers
                      - hostname
                      - imageToLedMappingType
                      - instance
                      - ledDevices
                      - leds
                      - priorities
                      - priorities_autoselect
                      - services
                      - transform
                      - videomode
                    x-apidog-ignore-properties: []
                  success:
                    type: boolean
                    description: Result, if the request excuted successfully
                  error:
                    type: string
                    description: Reason why a request did not execute successfully
                  errorData:
                    type: array
                    items:
                      type: object
                      properties:
                        description:
                          type: string
                      x-apidog-orders:
                        - description
                      x-apidog-ignore-properties: []
                    description: Detailed error explaination
                  tan:
                    type: integer
                    description: Request's transaction number
                required:
                  - command
                  - info
                  - success
                  - tan
                x-apidog-orders:
                  - command
                  - subcommand
                  - info
                  - success
                  - error
                  - errorData
                  - tan
                x-apidog-refs: {}
                x-apidog-ignore-properties: []
              example:
                command: serverinfo-getInfo
                info:
                  activeEffects:
                    - args:
                        blobs: 5
                        color:
                          - 0
                          - 0
                          - 255
                        hueChange: 60
                        reverse: false
                        rotationTime: 60
                        smoothing-custom-settings: null
                      name: Blue mood blobs
                      priority: 1
                      script: ':/effects/mood-blobs.py'
                      timeout: -1
                  activeLedColor: []
                  adjustment:
                    - backlightColored: false
                      backlightThreshold: 0
                      blue:
                        - 0
                        - 0
                        - 255
                      brightness: 100
                      brightnessCompensation: 100
                      brightnessGain: 1
                      cyan:
                        - 0
                        - 255
                        - 255
                      gammaBlue: 2.2
                      gammaGreen: 2.2
                      gammaRed: 2.2
                      green:
                        - 0
                        - 255
                        - 0
                      id: default
                      magenta:
                        - 255
                        - 0
                        - 255
                      red:
                        - 255
                        - 0
                        - 0
                      saturationGain: 1
                      temperature: 6600
                      white:
                        - 255
                        - 255
                        - 255
                      yellow:
                        - 255
                        - 255
                        - 0
                  cec:
                    enabled: true
                  components:
                    - enabled: false
                      name: ALL
                    - enabled: false
                      name: SMOOTHING
                    - enabled: false
                      name: BLACKBORDER
                    - enabled: false
                      name: FORWARDER
                    - enabled: false
                      name: BOBLIGHTSERVER
                    - enabled: false
                      name: GRABBER
                    - enabled: false
                      name: V4L
                    - enabled: false
                      name: AUDIO
                    - enabled: false
                      name: LEDDEVICE
                  effects:
                    - args:
                        center_x: 0.5
                        center_y: 0.5
                        custom-colors:
                          - - 0
                            - 0
                            - 0
                          - - 0
                            - 0
                            - 0
                          - - 255
                            - 255
                            - 0
                          - - 0
                            - 0
                            - 0
                          - - 0
                            - 0
                            - 0
                          - - 255
                            - 255
                            - 0
                          - - 0
                            - 0
                            - 0
                          - - 0
                            - 0
                            - 0
                          - - 255
                            - 255
                            - 0
                        custom-colors2: []
                        enable-second: false
                        random-center: false
                        reverse: false
                        rotation-time: 25
                      file: ':/effects/atomic.json'
                      name: Atomic swirl
                      script: ':/effects/swirl.py'
                    - args:
                        blobs: 5
                        color:
                          - 0
                          - 0
                          - 255
                        hueChange: 60
                        reverse: false
                        rotationTime: 60
                      file: ':/effects/mood-blobs-blue.json'
                      name: Blue mood blobs
                      script: ':/effects/mood-blobs.py'
                    - args:
                        color-end:
                          - 255
                          - 255
                          - 255
                        color-end-time: 250
                        color-start:
                          - 50
                          - 50
                          - 50
                        color-start-time: 50
                        fade-in-time: 3000
                        fade-out-time: 1000
                        maintain-end-color: true
                        repeat-count: 0
                      file: ':/effects/breath.json'
                      name: Breath
                      script: ':/effects/fade.py'
                    - args:
                        brightness: 100
                        candles: all
                        color:
                          - 255
                          - 138
                          - 0
                        sleepTime: 0.2
                        smoothing-custom-settings: true
                        smoothing-time_ms: 500
                        smoothing-updateFrequency: 20
                      file: ':/effects/candle.json'
                      name: Candle
                      script: ':/effects/candle.py'
                    - args:
                        color-end:
                          - 238
                          - 173
                          - 47
                        color-end-time: 0
                        color-start:
                          - 136
                          - 97
                          - 7
                        color-start-time: 0
                        fade-in-time: 5000
                        fade-out-time: 0
                        maintain-end-color: true
                        repeat-count: 1
                      file: ':/effects/cinema-fade-in.json'
                      name: Cinema brighten lights
                      script: ':/effects/fade.py'
                    - args:
                        color-end:
                          - 238
                          - 173
                          - 47
                        color-end-time: 0
                        color-start:
                          - 136
                          - 97
                          - 7
                        color-start-time: 0
                        fade-in-time: 0
                        fade-out-time: 5000
                        maintain-end-color: true
                        repeat-count: 1
                      file: ':/effects/cinema-fade-off.json'
                      name: Cinema dim lights
                      script: ':/effects/fade.py'
                    - args:
                        baseChange: true
                        baseColorChangeRate: 2
                        baseColorRangeLeft: 160
                        baseColorRangeRight: 320
                        blobs: 5
                        color:
                          - 0
                          - 0
                          - 255
                        hueChange: 30
                        reverse: false
                        rotationTime: 60
                      file: ':/effects/mood-blobs-cold.json'
                      name: Cold mood blobs
                      script: ':/effects/mood-blobs.py'
                    - args:
                        explodeRadius: 8
                        speed: 100
                        trailLength: 5
                      file: ':/effects/collision.json'
                      name: Collision
                      script: ':/effects/collision.py'
                    - args:
                        speed: 1
                      file: ':/effects/traces.json'
                      name: Color traces
                      script: ':/effects/traces.py'
                    - args:
                        center_x: 0.5
                        center_x2: 0.5
                        center_y: 0.5
                        center_y2: 0.5
                        custom-colors:
                          - - 255
                            - 0
                            - 0
                          - - 20
                            - 0
                            - 255
                        custom-colors2:
                          - - 255
                            - 0
                            - 0
                            - 0
                          - - 255
                            - 0
                            - 0
                            - 0
                          - - 255
                            - 0
                            - 0
                            - 0
                          - - 0
                            - 0
                            - 0
                            - 1
                          - - 0
                            - 0
                            - 0
                            - 0
                          - - 255
                            - 0
                            - 0
                            - 0
                          - - 255
                            - 0
                            - 0
                            - 0
                          - - 0
                            - 0
                            - 0
                            - 1
                        enable-second: true
                        random-center: false
                        random-center2: false
                        reverse: false
                        reverse2: true
                        rotation-time: 25
                      file: ':/effects/double-swirl.json'
                      name: Double swirl
                      script: ':/effects/swirl.py'
                    - args:
                        cropBottom: 0
                        cropLeft: 0
                        cropRight: 0
                        cropTop: 0
                        file: ':fire.gif'
                        fps: 25
                        grayscale: false
                        imageSource: file
                        reverse: false
                      file: ':/effects/fire.json'
                      name: Fire
                      script: ':/effects/gif.py'
                    - args:
                        countries:
                          - de
                          - se
                        switch-time: 2
                      file: ':/effects/flag.json'
                      name: Flags Germany/Sweden
                      script: ':/effects/flag.py'
                    - args:
                        baseChange: true
                        baseColorChangeRate: 0.2
                        baseColorRangeLeft: 0
                        baseColorRangeRight: 360
                        blobs: 5
                        colorRandom: true
                        hueChange: 30
                        reverse: false
                        rotationTime: 60
                      file: ':/effects/mood-blobs-full.json'
                      name: Full color mood blobs
                      script: ':/effects/mood-blobs.py'
                    - args:
                        blobs: 5
                        color:
                          - 0
                          - 255
                          - 0
                        hueChange: 60
                        reverse: false
                        rotationTime: 60
                      file: ':/effects/mood-blobs-green.json'
                      name: Green mood blobs
                      script: ':/effects/mood-blobs.py'
                    - args:
                        color:
                          - 255
                          - 0
                          - 0
                        fadeFactor: 0.7
                        speed: 1
                      file: ':/effects/knight-rider.json'
                      name: Knight rider
                      script: ':/effects/knight-rider.py'
                    - args:
                        sleepTime: 0.5
                        smoothing-custom-settings: false
                        smoothing-time_ms: 500
                        smoothing-updateFrequency: 20
                        testleds: all
                      file: ':/effects/ledtest.json'
                      name: Led Test
                      script: ':/effects/ledtest.py'
                    - args:
                        sleepTime: 0.5
                        smoothing-custom-settings: false
                        smoothing-time_ms: 500
                        smoothing-updateFrequency: 20
                      file: ':/effects/ledtest-seq.json'
                      name: Led Test - Sequence
                      script: ':/effects/ledtest-seq.py'
                    - args:
                        background-color:
                          - 0
                          - 0
                          - 0
                        hour-color:
                          - 0
                          - 0
                          - 255
                        marker-color:
                          - 255
                          - 255
                          - 255
                        marker-depth: 0
                        marker-enabled: false
                        marker-width: 5
                        minute-color:
                          - 0
                          - 255
                          - 0
                        second-color:
                          - 255
                          - 0
                          - 0
                        show_seconds: true
                      file: ':/effects/light-clock.json'
                      name: Light clock
                      script: ':/effects/light-clock.py'
                    - args:
                        cropBottom: 0
                        cropLeft: 0
                        cropRight: 0
                        cropTop: 0
                        file: ':lights.gif'
                        fps: 25
                        grayscale: false
                        imageSource: file
                        reverse: false
                      file: ':/effects/lights.json'
                      name: Lights
                      script: ':/effects/gif.py'
                    - args:
                        cropBottom: 0
                        cropLeft: 0
                        cropRight: 0
                        cropTop: 0
                        file: ':matrix.gif'
                        fps: 30
                        grayscale: false
                        imageSource: file
                        reverse: false
                      file: ':/effects/matrix.json'
                      name: Matrix
                      script: ':/effects/gif.py'
                    - args:
                        color-end:
                          - 0
                          - 0
                          - 255
                        color-end-time: 150
                        color-start:
                          - 0
                          - 0
                          - 50
                        color-start-time: 40
                        fade-in-time: 200
                        fade-out-time: 100
                        maintain-end-color: false
                        repeat-count: 3
                      file: ':/effects/notify-blue.json'
                      name: Notify blue
                      script: ':/effects/fade.py'
                    - args:
                        margin-pos: 2
                        rotationTime: 4
                      file: ':/effects/pacman.json'
                      name: Pac-Man
                      script: ':/effects/pacman.py'
                    - args:
                        sleepTime: 0.2
                      file: ':/effects/plasma.json'
                      name: Plasma
                      script: ':/effects/plasma.py'
                    - args:
                        color_one:
                          - 255
                          - 0
                          - 0
                        color_two:
                          - 0
                          - 0
                          - 255
                        colors_count: 10
                        reverse: false
                        rotation-time: 1.5
                      file: ':/effects/police-lights-single.json'
                      name: Police Lights Single
                      script: ':/effects/police.py'
                    - args:
                        color_one:
                          - 255
                          - 0
                          - 0
                        color_two:
                          - 0
                          - 0
                          - 255
                        reverse: false
                        rotation-time: 1
                      file: ':/effects/police-lights-solid.json'
                      name: Police Lights Solid
                      script: ':/effects/police.py'
                    - args:
                        brightness: 100
                        reverse: false
                        rotation-time: 60
                      file: ':/effects/rainbow-mood.json'
                      name: Rainbow mood
                      script: ':/effects/rainbow-mood.py'
                    - args:
                        center_x: 0.5
                        center_y: 0.5
                        custom-colors: []
                        custom-colors2: []
                        enable-second: false
                        random-center: false
                        reverse: false
                        rotation-time: 20
                        smoothing-custom-settings: true
                        smoothing-time_ms: 200
                        smoothing-updateFrequency: 25
                      file: ':/effects/rainbow-swirl.json'
                      name: Rainbow swirl
                      script: ':/effects/swirl.py'
                    - args:
                        center_x: 0.5
                        center_y: 0.5
                        custom-colors: []
                        custom-colors2: []
                        enable-second: false
                        random-center: false
                        reverse: false
                        rotation-time: 7
                      file: ':/effects/rainbow-swirl-fast.json'
                      name: Rainbow swirl fast
                      script: ':/effects/swirl.py'
                    - args:
                        saturation: 1
                        smoothing-custom-settings: true
                        smoothing-time_ms: 200
                        smoothing-updateFrequency: 20
                        speed: 750
                      file: ':/effects/random.json'
                      name: Random
                      script: ':/effects/random.py'
                    - args:
                        blobs: 5
                        color:
                          - 255
                          - 0
                          - 0
                        hueChange: 60
                        reverse: false
                        rotationTime: 60
                      file: ':/effects/mood-blobs-red.json'
                      name: Red mood blobs
                      script: ':/effects/mood-blobs.py'
                    - args:
                        center_x: 1.25
                        center_y: -0.25
                        colors:
                          - - 8
                            - 0
                            - 255
                          - - 0
                            - 161
                            - 255
                          - - 0
                            - 222
                            - 255
                          - - 0
                            - 153
                            - 255
                          - - 38
                            - 0
                            - 255
                          - - 0
                            - 199
                            - 255
                        random-center: false
                        reverse: false
                        reverse_time: 0
                        rotation_time: 60
                        smoothing-custom-settings: true
                        smoothing-time_ms: 200
                        smoothing-updateFrequency: 25
                      file: ':/effects/Seawaves.json'
                      name: Sea waves
                      script: ':/effects/waves.py'
                    - args:
                        background-color:
                          - 0
                          - 0
                          - 0
                        color:
                          - 255
                          - 0
                          - 0
                        percentage: 10
                        rotation-time: 12
                      file: ':/effects/snake.json'
                      name: Snake
                      script: ':/effects/snake.py'
                    - args:
                        brightness: 100
                        color:
                          - 255
                          - 255
                          - 255
                        random-color: false
                        rotation-time: 3
                        saturation: 100
                        sleep-time: 0.05
                      file: ':/effects/sparks.json'
                      name: Sparks
                      script: ':/effects/sparks.py'
                    - args:
                        color-end:
                          - 0
                          - 0
                          - 0
                        color-end-time: 100
                        color-start:
                          - 255
                          - 0
                          - 0
                        color-start-time: 100
                        fade-in-time: 100
                        fade-out-time: 100
                        maintain-end-color: true
                        repeat-count: 0
                      file: ':/effects/strobe-red.json'
                      name: Strobe red
                      script: ':/effects/fade.py'
                    - args:
                        color-end:
                          - 0
                          - 0
                          - 0
                        color-end-time: 10
                        color-start:
                          - 255
                          - 255
                          - 255
                        color-start-time: 50
                        fade-in-time: 0
                        fade-out-time: 100
                        maintain-end-color: true
                        repeat-count: 0
                      file: ':/effects/strobe-white.json'
                      name: Strobe white
                      script: ':/effects/fade.py'
                    - args:
                        alarm-color:
                          - 255
                          - 0
                          - 0
                        initial-blink: true
                        post-color:
                          - 255
                          - 174
                          - 11
                        set-post-color: true
                        shutdown-enabled: false
                        speed: 1.2
                      file: ':/effects/shutdown.json'
                      name: System Shutdown
                      script: ':/effects/shutdown.py'
                    - args:
                        color:
                          - 255
                          - 255
                          - 255
                        height: 8
                        max_len: 7
                        min_len: 2
                        random: false
                        speed: 30
                        trails: 3
                      file: ':/effects/trails.json'
                      name: Trails
                      script: ':/effects/trails.py'
                    - args:
                        color:
                          - 255
                          - 255
                          - 255
                        height: 8
                        max_len: 6
                        min_len: 2
                        random: true
                        speed: 50
                        trails: 16
                      file: ':/effects/trails_color.json'
                      name: Trails color
                      script: ':/effects/trails.py'
                    - args:
                        baseChange: true
                        baseColorChangeRate: 2
                        baseColorRangeLeft: 333
                        baseColorRangeRight: 151
                        blobs: 5
                        color:
                          - 255
                          - 0
                          - 0
                        hueChange: 30
                        reverse: false
                        rotationTime: 60
                        smoothing-custom-settings: true
                        smoothing-time_ms: 200
                        smoothing-updateFrequency: 25
                      file: ':/effects/mood-blobs-warm.json'
                      name: Warm mood blobs
                      script: ':/effects/mood-blobs.py'
                    - args:
                        reverse: false
                      file: ':/effects/waves.json'
                      name: Waves with Color
                      script: ':/effects/waves.py'
                    - args:
                        color1:
                          - 255
                          - 255
                          - 255
                        color2:
                          - 255
                          - 0
                          - 0
                        length: 1
                        sleepTime: 750
                      file: ':/effects/x-mas.json'
                      name: X-Mas
                      script: ':/effects/x-mas.py'
                  grabbers:
                    audio:
                      active: []
                      available:
                        - audio
                    screen:
                      active:
                        - xcb
                      available:
                        - framebuffer
                        - x11
                        - xcb
                        - qt
                    video:
                      active: []
                      available:
                        - v4l2
                  hostname: ubuntu2404
                  imageToLedMappingType: multicolor_mean
                  instance:
                    - friendly_name: First LED Hardware instance
                      instance: 0
                      running: true
                    - friendly_name: 2nd instance
                      instance: 1
                      running: true
                  ledDevices:
                    available:
                      - adalight
                      - apa102
                      - apa102_ftdi
                      - apa104
                      - atmo
                      - atmoorb
                      - cololight
                      - dmx
                      - fadecandy
                      - file
                      - hd108
                      - homeassistant
                      - hyperionusbasp
                      - karate
                      - lightpack
                      - lpd6803
                      - lpd8806
                      - nanoleaf
                      - p9813
                      - paintpack
                      - philipshue
                      - piblaster
                      - rawhid
                      - razer
                      - sedu
                      - sk6812_ftdi
                      - sk6812spi
                      - sk6822spi
                      - sk9822
                      - skydimo
                      - tinkerforge
                      - tpm2
                      - tpm2net
                      - udpartnet
                      - udpddp
                      - udpe131
                      - udph801
                      - udpraw
                      - wled
                      - ws2801
                      - ws2812_ftdi
                      - ws2812spi
                      - yeelight
                  leds:
                    - hmax: 1
                      hmin: 0
                      vmax: 0.08
                      vmin: 0
                  priorities: []
                  priorities_autoselect: true
                  services:
                    - boblight
                    - cec
                    - effectengine
                    - forwarder
                    - flatbuffer
                    - protobuffer
                    - mDNS
                    - SSDP
                    - borderdetection
                  transform:
                    - blacklevel:
                        - 0
                        - 0
                        - 0
                      brightnessGain: 1
                      gamma:
                        - 2.5
                        - 2.5
                        - 2.5
                      id: default
                      luminanceGain: 1
                      luminanceMinimum: 0
                      saturationGain: 1
                      saturationLGain: 1
                      threshold:
                        - 0
                        - 0
                        - 0
                      whitelevel:
                        - 1
                        - 1
                        - 1
                  videomode: 2D
                success: true
                tan: 4711
          headers: {}
          x-apidog-name: Success
      security:
        - bearer: []
      x-apidog-folder: Hyperion API/Information
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/894413/apis/api-17016022-run
components:
  schemas:
    instance - single:
      type: integer
      minimum: 0
      maximum: 254
      description: Instance index (0-254) to which the command applies.
      x-apidog-folder: ''
    tan:
      type: object
      properties:
        tan:
          type: integer
          minimum: 0
          examples:
            - 4711
          description: Transaction number for tracking requests and responses.
      x-apidog-orders:
        - tan
      title: tan
      x-apidog-folder: ''
      x-apidog-ignore-properties: []
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
servers:
  - url: http://{{host}}:8090
    description: Develop Env
  - url: https://{{host}}:8092
    description: Testing Env
security: []

```
