velbus.messages package¶

Submodules¶

velbus.messages.blind_status module¶

author:	Tom Dupré <gitd8400@gmail.com>

class velbus.messages.blind_status.BlindStatusMessage(address=None)[source]¶

Bases: velbus.message.Message

sent by: VMB2BLE received by:

is_down()[source]¶

Returns:	bool

is_up()[source]¶

Returns:	bool

populate(priority, address, rtr, data)[source]¶

Returns:	None

to_json()[source]¶

Returns:	str

class velbus.messages.blind_status.BlindStatusNgMessage(address=None)[source]¶

Bases: velbus.message.Message

sent by: VMB2BLE received by:

data_to_binary()[source]¶

Returns:	bytes

is_down()[source]¶

Returns:	bool

is_up()[source]¶

Returns:	bool

populate(priority, address, rtr, data)[source]¶

Returns:	None

to_json()[source]¶

Returns:	str

velbus.messages.bus_active module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.bus_active.BusActiveMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: received by: VMB1USB

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

set_defaults(address)[source]¶

Set defaults

If a message has different than low priority or NO_RTR set, then this method needs override in subclass

Returns:	None

velbus.messages.bus_error_counter_status module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.bus_error_counter_status.BusErrorCounterStatusMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: VMB6IN, VMB4RYLD received by:

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

velbus.messages.bus_error_counter_status_request module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.bus_error_counter_status_request.BusErrorStatusRequestMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: received by: VMB6IN, VMB4RYLD

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

velbus.messages.bus_off module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.bus_off.BusOffMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: received by: VMB1USB

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

velbus.messages.channel_name_part1 module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.channel_name_part1.ChannelNamePart1Message(address=None)[source]¶

Bases: velbus.message.Message

send by: VMB6IN, VMB4RYLD received by:

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

to_json()[source]¶

Returns:	str

class velbus.messages.channel_name_part1.ChannelNamePart1Message2(address=None)[source]¶

Bases: velbus.messages.channel_name_part1.ChannelNamePart1Message

send by: VMBGP* received by:

populate(priority, address, rtr, data)[source]¶

Returns:	None

class velbus.messages.channel_name_part1.ChannelNamePart1Message3(address=None)[source]¶

Bases: velbus.messages.channel_name_part1.ChannelNamePart1Message

send by: VMBGP* received by:

populate(priority, address, rtr, data)[source]¶

Returns:	None

velbus.messages.channel_name_part2 module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.channel_name_part2.ChannelNamePart2Message(address=None)[source]¶

Bases: velbus.message.Message

send by: VMB6IN, VMB4RYLD received by:

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

to_json()[source]¶

Returns:	str

class velbus.messages.channel_name_part2.ChannelNamePart2Message2(address=None)[source]¶

Bases: velbus.messages.channel_name_part2.ChannelNamePart2Message

send by: VMBGP* received by:

populate(priority, address, rtr, data)[source]¶

Returns:	None

class velbus.messages.channel_name_part2.ChannelNamePart2Message3(address=None)[source]¶

Bases: velbus.messages.channel_name_part2.ChannelNamePart2Message

send by: VMBGP* received by:

populate(priority, address, rtr, data)[source]¶

Returns:	None

velbus.messages.channel_name_part3 module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.channel_name_part3.ChannelNamePart3Message(address=None)[source]¶

Bases: velbus.message.Message

send by: VMB6IN, VMB4RYLD received by:

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

to_json()[source]¶

Returns:	str

class velbus.messages.channel_name_part3.ChannelNamePart3Message2(address=None)[source]¶

Bases: velbus.messages.channel_name_part3.ChannelNamePart3Message

send by: VMBGP* received by:

populate(priority, address, rtr, data)[source]¶

Returns:	None

class velbus.messages.channel_name_part3.ChannelNamePart3Message3(address=None)[source]¶

Bases: velbus.messages.channel_name_part3.ChannelNamePart3Message

send by: VMBGP* received by:

populate(priority, address, rtr, data)[source]¶

Returns:	None

velbus.messages.channel_name_request module¶

author:	Thomas Delaet <thomas@delaet.org> and Maikel Punie <maikel.punie@gmail.com>

class velbus.messages.channel_name_request.ChannelNameRequestMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: received by: VMB6IN, VMB4RYLD

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

class velbus.messages.channel_name_request.ChannelNameRequestMessage2(address=None)[source]¶

Bases: velbus.messages.channel_name_request.ChannelNameRequestMessage

send by: received by: VMB2BL

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

velbus.messages.clear_led module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.clear_led.ClearLedMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: VMB4RYLD received by: VMB6IN, VMB4RYLD

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

velbus.messages.cover_down module¶

author:	Tom Dupré <gitd8400@gmail.com>

class velbus.messages.cover_down.CoverDownMessage(address=None)[source]¶

Bases: velbus.message.Message

sent by: received by: VMB2BLE

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

set_defaults(address)[source]¶

Set defaults

If a message has different than low priority or NO_RTR set, then this method needs override in subclass

Returns:	None

to_json()[source]¶

Returns:	str

class velbus.messages.cover_down.CoverDownMessage2(address=None)[source]¶

Bases: velbus.message.Message

sent by: received by: VMB1BL VMB2BL

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

set_defaults(address)[source]¶

Set defaults

If a message has different than low priority or NO_RTR set, then this method needs override in subclass

Returns:	None

to_json()[source]¶

Returns:	str

velbus.messages.cover_up module¶

author:	Tom Dupré <gitd8400@gmail.com>

class velbus.messages.cover_up.CoverUpMessage(address=None)[source]¶

Bases: velbus.message.Message

sent by: received by: VMB2BLE

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

set_defaults(address)[source]¶

Set defaults

If a message has different than low priority or NO_RTR set, then this method needs override in subclass

Returns:	None

to_json()[source]¶

Returns:	str

class velbus.messages.cover_up.CoverUpMessage2(address=None)[source]¶

Bases: velbus.message.Message

sent by: received by: VMB1BL VMB2BL

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

set_defaults(address)[source]¶

Set defaults

If a message has different than low priority or NO_RTR set, then this method needs override in subclass

Returns:	None

to_json()[source]¶

Returns:	str

velbus.messages.fast_blinking_led module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.fast_blinking_led.FastBlinkingLedMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: VMB4RYLD received by: VMB6IN

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

velbus.messages.interface_status_request module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.interface_status_request.InterfaceStatusRequestMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: VMB1USB received by:

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

velbus.messages.memory_data module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.memory_data.MemoryDataMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: VMB6IN, VMB4RYLD received by:

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

to_json()[source]¶

Returns:	str

velbus.messages.memory_data_block module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.memory_data_block.MemoryDataBlockMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: VMB6IN, VMB4RYLD received by:

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶: :return None

velbus.messages.memory_dump_request module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.memory_dump_request.MemoryDumpRequestMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: received by: VMB6IN, VMB4RYLD

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

velbus.messages.module_status module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.module_status.ModuleStatusMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: VMB6IN received by:

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

class velbus.messages.module_status.ModuleStatusMessage2(address=None)[source]¶

Bases: velbus.message.Message

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

to_json()[source]¶

Returns:	str

class velbus.messages.module_status.ModuleStatusPirMessage(address=None)[source]¶

Bases: velbus.message.Message

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

velbus.messages.module_status_request module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.module_status_request.ModuleStatusRequestMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: received by: VMB6IN, VMB4RYLD

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

velbus.messages.module_type module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.module_type.ModuleTypeMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: VMB6IN, VMB4RYLD received by:

data_to_binary()[source]¶

Returns:	bytes

module_name()[source]¶

Returns:	str

populate(priority, address, rtr, data)[source]¶

Returns:	None

velbus.messages.module_type_request module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.module_type_request.ModuleTypeRequestMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: received by: VMB6IN, VMB4RYLD

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

set_defaults(address)[source]¶

Set defaults

If a message has different than low priority or NO_RTR set, then this method needs override in subclass

Returns:	None

velbus.messages.push_button_status module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.push_button_status.PushButtonStatusMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: VMB6IN, VMB4RYLD received by: VMB4RYLD

data_to_binary()[source]¶

Returns:	bytes

get_channels()[source]¶

Returns:	list

populate(priority, address, rtr, data)[source]¶

Returns:	None

set_defaults(address)[source]¶

Set defaults

If a message has different than low priority or NO_RTR set, then this method needs override in subclass

Returns:	None

to_json()[source]¶

Returns:	str

velbus.messages.read_data_block_from_memory module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.read_data_block_from_memory.ReadDataBlockFromMemoryMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: received by: VMB4RYLD

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

velbus.messages.read_data_from_memory module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.read_data_from_memory.ReadDataFromMemoryMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: received by: VMB6IN, VMB4RYLD

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

velbus.messages.receive_buffer_full module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.receive_buffer_full.ReceiveBufferFullMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: received by: VMB1USB

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

set_defaults(address)[source]¶

Set defaults

If a message has different than low priority or NO_RTR set, then this method needs override in subclass

Returns:	None

velbus.messages.receive_ready module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.receive_ready.ReceiveReadyMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: received by: VMB1USB

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

velbus.messages.relay_status module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.relay_status.RelayStatusMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: VMB4RYLD received by:

channel_is_on()[source]¶

Returns:	bool

data_to_binary()[source]¶

Returns:	bytes

has_interval_timer_on()[source]¶

Returns:	bool

is_disabled()[source]¶

Returns:	bool

is_forced_on()[source]¶

Returns:	bool

is_inhibited()[source]¶

Returns:	bool

is_normal()[source]¶

Returns:	bool

is_off()[source]¶

Returns:	bool

is_on()[source]¶

Returns:	bool

populate(priority, address, rtr, data)[source]¶

Returns:	None

to_json()[source]¶

Returns:	str

velbus.messages.set_led module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.set_led.SetLedMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: VMB4RYLD received by: VMB6IN

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

velbus.messages.slow_blinking_led module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.slow_blinking_led.SlowBlinkingLedMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: VMB4RYLD received by: VMB6IN

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

velbus.messages.start_relay_blinking_timer module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.start_relay_blinking_timer.StartRelayBlinkingTimerMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: received by: VMB4RYLD

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

set_defaults(address)[source]¶

Set defaults

If a message has different than low priority or NO_RTR set, then this method needs override in subclass

Returns:	None

velbus.messages.start_relay_timer module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.start_relay_timer.StartRelayTimerMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: received by: VMB4RYLD

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

set_defaults(address)[source]¶

Set defaults

If a message has different than low priority or NO_RTR set, then this method needs override in subclass

Returns:	None

velbus.messages.switch_relay_off module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.switch_relay_off.SwitchRelayOffMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: received by: VMB4RYLD

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

set_defaults(address)[source]¶

Set defaults

If a message has different than low priority or NO_RTR set, then this method needs override in subclass

Returns:	None

to_json()[source]¶

Returns:	str

velbus.messages.switch_relay_on module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.switch_relay_on.SwitchRelayOnMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: received by: VMB4RYLD

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

set_defaults(address)[source]¶

Set defaults

If a message has different than low priority or NO_RTR set, then this method needs override in subclass

Returns:	None

to_json()[source]¶

Returns:	str

velbus.messages.update_led_status module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.update_led_status.UpdateLedStatusMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: received by: VMB6IN

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

velbus.messages.very_fast_blinking_led module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.very_fast_blinking_led.VeryFastBlinkingLedMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: VMB4RYLD received by: VMB6IN

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

velbus.messages.write_data_to_memory module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.write_data_to_memory.WriteDataToMemoryMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: received by: VMB6IN, VMB4RYLD

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

velbus.messages.write_memory_block module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.write_memory_block.WriteMemoryBlockMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: received by: VMB4RYLD

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

velbus.messages.write_module_address_and_serial_number module¶

author:	Thomas Delaet <thomas@delaet.org>

class velbus.messages.write_module_address_and_serial_number.WriteModuleAddressAndSerialNumberMessage(address=None)[source]¶

Bases: velbus.message.Message

send by: received by: VMB4RYLD

data_to_binary()[source]¶

Returns:	bytes

populate(priority, address, rtr, data)[source]¶

Returns:	None

set_defaults(address)[source]¶

Set defaults

If a message has different than low priority or NO_RTR set, then this method needs override in subclass

Returns:	None

Module contents¶

author:	Thomas Delaet <thomas@delaet.org>