GetDMXValue(integer[, integer, boolean])

Description

The GetDMXValue Lua function returns a number indicating the DMX value of a specified DMX address.

Arguments

• Integer:
  The integer is the DMX address. This value should be from 1 to 512 if a universe integer is provided. If a universe is not provided, this should be the absolute DMX address ranging from 1 to 524 288.
• Integer (optional):
  The integer is the universe number.
• Boolean (optional):
  The boolean indicates if the returned value is in percent or DMX value.
  • True:
    The returned value is in percent. The range is 0 to 100.
  • False:
    The returned value is in DMX value. The range is 0 to 255.

Return

• Integer or nil:
  The returned integer value corresponds with the value of the selected DMX address or nil if the DMX address is not granted.

Example

This example prints the value for DMX address 1 in Universe 4 (if it is granted):

return function()
    -- This prints the value of DMX address 1 in universe 4 in a range of 0 to 255
    local address = 1       -- The DMX address
    local universe = 4      -- The DMX universe
    local percent = false   -- Readout in percent or DMX value
    local value = GetDMXValue(address, universe, percent)
    Printf("DMX address %i.%03d is %03d", universe, address, value)
end