Skip to content

Configuration Reference

penfold42 edited this page Mar 24, 2016 · 5 revisions

This is partly a placeholder whilst we formally document all of the configuration options. I have grabbed all the config options I could find from the source so we can document them

#General Configuration ###XBMC/Kodi integration

  • xbmcAddress
  • xbmcTcpPort
  • grabVideo
  • grabPictures
  • grabAudio
  • grabMenu
  • grabScreensaver
  • enable3DDetection

###bootsequence

  • effect
  • duration_ms
  • priority
  • color

###blackborderConfig

  • borderFrameCnt
  • maxInconsistentCnt
  • blurRemoveCnt
  • mode
  • threshold

###effect engine

  • paths

###Device

  • bgr-output
  • colorOrder

###transformConfig

  • id
  • red
  • green
  • blue
  • hsv

###colorConfig

  • transform
  • gamma
  • blacklevel
  • whitelevel

###hsvConfig

  • saturationGain
  • valueGain

###ledConfig

  • hscan
  • vscan

###hscanConfig

  • minimum
  • maximum

###vscanConfig

  • minimum
  • maximum

###smoothingConfig

  • type
  • time_ms
  • updateFrequency
  • updateDelay

###forwarderConfig

  • json
  • proto

#Grabber Configuration ###framegrabber

  • width
  • height
  • frequency_Hz
  • priority

###grabber-v4l2

  • device
  • input
  • standard
  • pixelFormat
  • width
  • height
  • frameDecimation
  • sizeDecimation
  • redSignalThreshold
  • greenSignalThreshold
  • blueSignalThreshold
  • priority
  • mode
  • cropLeft
  • cropRight
  • cropTop
  • cropBottom

###amlgrabber

  • width
  • height
  • frequency_Hz
  • priority

###framebuffergrabber

  • device
  • width
  • height
  • frequency_Hz
  • priority

###osxgrabber

  • display
  • width
  • height
  • frequency_Hz
  • priority

#Device Specific Configuration ###adalight, adalightapa102, ambiled

  • output
  • rate
  • delayAfterConnect

###lpd6803,ldp6803,lpd8806,ldp8806,p9813,apa102,sedu

  • output
  • rate

###ws2801,lightberry

  • output - SPI device to write to
  • rate - bit rate of SPI clock
  • latchtime - how long to pause after writing 1 full update

###tinkerforge

  • output
  • port
  • uid
  • rate

###rawhid

  • delayAfterConnect
  • VID
  • PID

###lightpack

  • output

###paintpack

  • delayAfterConnect
  • VID
  • PID

###piblaster

  • output
  • assignment

###multi-lightpack,multi_lightpack

  • none

###hyperion-usbasp-ws2801,hyperion-usbasp-ws2812

  • none

###philipshue

  • output
  • username
  • switchOffOnBlack
  • transitiontime
  • lightIds

###file

  • output - path to the text file which will have led data written to. default is /dev/null

###test (renamed to "file" in recent builds)

  • output - path to the text file which will have led data written to

###fadecandy

  • output
  • port
  • channel

###udp

  • output - the target IP address or hostname
  • rate - the max bits per second to send (unimplemented)
  • protocol - 3 different protocols are supported (0,1,2). details coming soon
  • maxpacket - specifies the maximum UDP packet size

###tpm2

  • output
  • rate

###atmo

  • output

###ws2812b

  • none

###ws281x

  • gpio - which GPIO pin the strip is attached to. defaults to 18
  • leds - maximum number of leds this driver supports - defaults to 256
  • freq - some older LEDs only supported 400kHZ signalling
  • dmanum - which DMA channel to use. be very careful you dont stomp on an already allocated dma channel
  • invert - if != 0, inverts the signal on the GPIO to support an inverting level shifter

###AtmoOrb

  • output
  • transitiontime
  • port
  • numLeds
  • orbIds
  • switchOffOnBlack