unreal.DMXSubsystem

class unreal.DMXSubsystem(outer=None, name='None')

Bases: unreal.EngineSubsystem

UDMXSubsystem Collections of DMX context blueprint subsystem functions and internal functions for DMX K2Nodes

C++ Source:

  • Plugin: DMXEngine
  • Module: DMXRuntime
  • File: DMXSubsystem.h

Editor Properties: (see get_editor_property/set_editor_property)

  • on_protocol_received (ProtocolReceivedDelegate): [Read-Write] On Protocol Received
bytes_to_int(bytes, use_lsb=False) → int32

Return integer given an array of bytes. Up to the first 4 bytes in the array will be used for the conversion.

Parameters:
  • bytes (Array(uint8)) –
  • use_lsb (bool) – Least Significant Byte mode makes the individual bytes (channels) of the function be interpreted with the first bytes being the lowest part of the number. Most Fixtures use MSB (Most Significant Byte).
Returns:

Return type:

int32

bytes_to_normalized_value(bytes, use_lsb=False) → float

Return normalized value given an array of bytes. Up to the first 4 bytes in the array will be used for the conversion.

Parameters:
  • bytes (Array(uint8)) –
  • use_lsb (bool) – Least Significant Byte mode makes the individual bytes (channels) of the function be interpreted with the first bytes being the lowest part of the number. Most Fixtures use MSB (Most Significant Byte).
Returns:

Return type:

float

get_all_controllers_in_library(dmx_library) -> Array(DMXEntityController)

Return reference to array of Controller objects in library.

Parameters:dmx_library (DMXLibrary) –
Returns:
Return type:Array(DMXEntityController)
get_all_dmx_libraries() -> Array(DMXLibrary)

Return reference to array of DMX Library objects.

Returns:
Return type:Array(DMXLibrary)
get_all_fixture_types_in_library(dmx_library) -> Array(DMXEntityFixtureType)

Return reference to array of Fixture Types objects in library.

Parameters:dmx_library (DMXLibrary) –
Returns:
Return type:Array(DMXEntityFixtureType)
get_all_fixtures_in_library(dmx_library) -> Array(DMXEntityFixturePatch)

Return reference to array of Fixture Patch objects in library.

Parameters:dmx_library (DMXLibrary) –
Returns:
Return type:Array(DMXEntityFixturePatch)
get_all_fixtures_in_universe(dmx_library, universe_id) -> Array(DMXEntityFixturePatch)

Return reference to array of Fixture Patch objects in a given universe.

Parameters:
  • dmx_library (DMXLibrary) –
  • universe_id (int32) –
Returns:

out_result (Array(DMXEntityFixturePatch)):

Return type:

Array(DMXEntityFixturePatch)

get_all_fixtures_of_category(dmx_library, category) -> Array(DMXEntityFixturePatch)

Return reference to array of Fixture Patch objects of a given category.

Parameters:
Returns:

out_result (Array(DMXEntityFixturePatch)):

Return type:

Array(DMXEntityFixturePatch)

get_all_fixtures_of_type(fixture_type) -> Array(DMXEntityFixturePatch)

Return reference to array of Fixture Patch objects of a given type.

Parameters:fixture_type (DMXEntityFixtureTypeRef) –
Returns:out_result (Array(DMXEntityFixturePatch)):
Return type:Array(DMXEntityFixturePatch)
get_all_fixtures_with_tag(dmx_library, custom_tag) -> Array(DMXEntityFixturePatch)

Return reference to array of Fixture Patch objects with a given tag.

Parameters:
Returns:

Return type:

Array(DMXEntityFixturePatch)

get_all_universes_in_controller(dmx_library, controller_name) -> Array(int32)

Return reference to array of Fixture Patch objects in a given controller.

Parameters:
Returns:

out_result (Array(int32)):

Return type:

Array(int32)

get_controller_by_name(dmx_library, name) → DMXEntityController

Return reference to Controller object with a given name.

Parameters:
Returns:

Return type:

DMXEntityController

get_fixture_by_name(dmx_library, name) → DMXEntityFixturePatch

Return reference to Fixture Patch object with a given name.

Parameters:
Returns:

Return type:

DMXEntityFixturePatch

get_fixture_functions(fixture_patch, dmx_buffer) -> Map(Name, int32)

Return map with all DMX functions and their associated values given DMX buffer and desired universe.

Parameters:
Returns:

out_result (Map(Name, int32)):

Return type:

Map(Name, int32)

get_fixture_type_by_name(dmx_library, name) → DMXEntityFixtureType

Return reference to Fixture Type object with a given name.

Parameters:
Returns:

Return type:

DMXEntityFixtureType

get_normalized_function_value(fixture_patch, function_name, value) → float

Return the normalized value of an Int value from a Fixture Patch function.

Parameters:
Returns:

The normalized value of the passed in Int using the Function’s signal format. -1.0 if the Function is not found in the Fixture Patch.

Return type:

float

get_raw_buffer(selected_protocol, universe_index) -> Array(uint8)

Return byte array from the DMX buffer given a universe.

Parameters:
Returns:

dmx_buffer (Array(uint8)):

Return type:

Array(uint8)

int_to_normalized_value(value, signal_format) → float

Return the normalized value of an Int value from the specified Signal Format.

Parameters:
Returns:

Return type:

float

int_value_to_bytes(value, signal_format, use_lsb=False) -> Array(uint8)

Return the Bytes format of Value in the desired Signal Format.

Parameters:
  • value (int32) –
  • signal_format (DMXFixtureSignalFormat) –
  • use_lsb (bool) – Least Significant Byte mode makes the individual bytes (channels) of the function be interpreted with the first bytes being the lowest part of the number. Most Fixtures use MSB (Most Significant Byte).
Returns:

bytes (Array(uint8)):

Return type:

Array(uint8)

load_dmx_library(dmx_library) → None

Load all referenced Objects in the given library. The DMX library should be Loaded at least one in any part of the Unreal Engine

Parameters:dmx_library (DMXLibrary) –
normalized_value_to_bytes(value, signal_format, use_lsb=False) -> Array(uint8)

Return the Bytes format of Value in the desired Signal Format.

Parameters:
  • value (float) –
  • signal_format (DMXFixtureSignalFormat) –
  • use_lsb (bool) – Least Significant Byte mode makes the individual bytes (channels) of the function be interpreted with the first bytes being the lowest part of the number. Most Fixtures use MSB (Most Significant Byte).
Returns:

bytes (Array(uint8)):

Return type:

Array(uint8)

on_protocol_received

(ProtocolReceivedDelegate) – [Read-Write] On Protocol Received

send_dmx(selected_protocol, fixture_patch, function_map) → DMXSendResult

Send DMX using function names and integer values.

Parameters:
Returns:

out_result (DMXSendResult):

Return type:

DMXSendResult

send_dmx_raw(selected_protocol, universe_index, channel_values_map) → DMXSendResult

Send DMX using channel and value raw values.

Parameters:
  • selected_protocol (DMXProtocolName) –
  • universe_index (int32) –
  • channel_values_map (Map(int32, uint8)) –
Returns:

out_result (DMXSendResult):

Return type:

DMXSendResult