Zeek_Modbus.events.bif.zeek¶

GLOBAL¶

Namespace: GLOBAL

Summary¶

Events¶

`modbus_exception`: `event`	Generated for any Modbus exception message.
`modbus_mask_write_register_request`: `event`	Generated for a Modbus mask write register request.
`modbus_mask_write_register_response`: `event`	Generated for a Modbus mask write register request.
`modbus_message`: `event`	Generated for any Modbus message regardless if the particular function is further supported or not.
`modbus_read_coils_request`: `event`	Generated for a Modbus read coils request.
`modbus_read_coils_response`: `event`	Generated for a Modbus read coils response.
`modbus_read_discrete_inputs_request`: `event`	Generated for a Modbus read discrete inputs request.
`modbus_read_discrete_inputs_response`: `event`	Generated for a Modbus read discrete inputs response.
`modbus_read_fifo_queue_request`: `event`	Generated for a Modbus read FIFO queue request.
`modbus_read_fifo_queue_response`: `event`	Generated for a Modbus read FIFO queue response.
`modbus_read_file_record_request`: `event`	Generated for a Modbus read file record request.
`modbus_read_file_record_response`: `event`	Generated for a Modbus read file record response.
`modbus_read_holding_registers_request`: `event`	Generated for a Modbus read holding registers request.
`modbus_read_holding_registers_response`: `event`	Generated for a Modbus read holding registers response.
`modbus_read_input_registers_request`: `event`	Generated for a Modbus read input registers request.
`modbus_read_input_registers_response`: `event`	Generated for a Modbus read input registers response.
`modbus_read_write_multiple_registers_request`: `event`	Generated for a Modbus read/write multiple registers request.
`modbus_read_write_multiple_registers_response`: `event`	Generated for a Modbus read/write multiple registers response.
`modbus_write_file_record_request`: `event`	Generated for a Modbus write file record request.
`modbus_write_file_record_response`: `event`	Generated for a Modbus write file record response.
`modbus_write_multiple_coils_request`: `event`	Generated for a Modbus write multiple coils request.
`modbus_write_multiple_coils_response`: `event`	Generated for a Modbus write multiple coils response.
`modbus_write_multiple_registers_request`: `event`	Generated for a Modbus write multiple registers request.
`modbus_write_multiple_registers_response`: `event`	Generated for a Modbus write multiple registers response.
`modbus_write_single_coil_request`: `event`	Generated for a Modbus write single coil request.
`modbus_write_single_coil_response`: `event`	Generated for a Modbus write single coil response.
`modbus_write_single_register_request`: `event`	Generated for a Modbus write single register request.
`modbus_write_single_register_response`: `event`	Generated for a Modbus write single register response.

Detailed Interface¶

Events¶

modbus_exception¶

Type: event (c: connection, headers: ModbusHeaders, code: count)

Generated for any Modbus exception message.

C: The connection.
Headers: The headers for the modbus function.
Code: The exception code.

modbus_mask_write_register_request¶

Type: event (c: connection, headers: ModbusHeaders, address: count, and_mask: count, or_mask: count)

Generated for a Modbus mask write register request.

C: The connection.
Headers: The headers for the modbus function.
Address: The memory address of the register where the masks should be applied.
And_mask: The value of the logical AND mask to apply to the register.
Or_mask: The value of the logical OR mask to apply to the register.

modbus_mask_write_register_response¶

Type: event (c: connection, headers: ModbusHeaders, address: count, and_mask: count, or_mask: count)

Generated for a Modbus mask write register request.

C: The connection.
Headers: The headers for the modbus function.
Address: The memory address of the register where the masks were applied.
And_mask: The value of the logical AND mask applied register.
Or_mask: The value of the logical OR mask applied to the register.

modbus_message¶

Type: event (c: connection, headers: ModbusHeaders, is_orig: bool)

Generated for any Modbus message regardless if the particular function is further supported or not.

C: The connection.
Headers: The headers for the modbus function.
Is_orig: True if the event is raised for the originator side.

modbus_read_coils_request¶

Type: event (c: connection, headers: ModbusHeaders, start_address: count, quantity: count)

Generated for a Modbus read coils request.

C: The connection.
Headers: The headers for the modbus function.
Start_address: The memory address of the first coil to be read.
Quantity: The number of coils to be read.

modbus_read_coils_response¶

Type: event (c: connection, headers: ModbusHeaders, coils: ModbusCoils)

Generated for a Modbus read coils response.

C: The connection.
Headers: The headers for the modbus function.
Coils: The coil values returned from the device.

modbus_read_discrete_inputs_request¶

Type: event (c: connection, headers: ModbusHeaders, start_address: count, quantity: count)

Generated for a Modbus read discrete inputs request.

C: The connection.
Headers: The headers for the modbus function.
Start_address: The memory address of the first coil to be read.
Quantity: The number of coils to be read.

modbus_read_discrete_inputs_response¶

Type: event (c: connection, headers: ModbusHeaders, coils: ModbusCoils)

Generated for a Modbus read discrete inputs response.

C: The connection.
Headers: The headers for the modbus function.
Coils: The coil values returned from the device.

modbus_read_fifo_queue_request¶

Type: event (c: connection, headers: ModbusHeaders, start_address: count)

Generated for a Modbus read FIFO queue request.

C: The connection.
Headers: The headers for the modbus function.
Start_address: The address of the FIFO queue to read.

modbus_read_fifo_queue_response¶

Type: event (c: connection, headers: ModbusHeaders, fifos: ModbusRegisters)

Generated for a Modbus read FIFO queue response.

C: The connection.
Headers: The headers for the modbus function.
Fifos: The register values read from the FIFO queue on the device.

modbus_read_file_record_request¶

Type: event (c: connection, headers: ModbusHeaders)

Generated for a Modbus read file record request.

C: The connection.
Headers: The headers for the modbus function.

modbus_read_file_record_response¶

Type: event (c: connection, headers: ModbusHeaders)

Generated for a Modbus read file record response.

C: The connection.
Headers: The headers for the modbus function.

modbus_read_holding_registers_request¶

Type: event (c: connection, headers: ModbusHeaders, start_address: count, quantity: count)

Generated for a Modbus read holding registers request.

C: The connection.
Headers: The headers for the modbus function.
Start_address: The memory address of the first register to be read.
Quantity: The number of registers to be read.

modbus_read_holding_registers_response¶

Type: event (c: connection, headers: ModbusHeaders, registers: ModbusRegisters)

Generated for a Modbus read holding registers response.

C: The connection.
Headers: The headers for the modbus function.
Registers: The register values returned from the device.

modbus_read_input_registers_request¶

Type: event (c: connection, headers: ModbusHeaders, start_address: count, quantity: count)

Generated for a Modbus read input registers request.

C: The connection.
Headers: The headers for the modbus function.
Start_address: The memory address of the first register to be read.
Quantity: The number of registers to be read.

modbus_read_input_registers_response¶

Type: event (c: connection, headers: ModbusHeaders, registers: ModbusRegisters)

Generated for a Modbus read input registers response.

C: The connection.
Headers: The headers for the modbus function.
Registers: The register values returned from the device.

modbus_read_write_multiple_registers_request¶

Type: event (c: connection, headers: ModbusHeaders, read_start_address: count, read_quantity: count, write_start_address: count, write_registers: ModbusRegisters)

Generated for a Modbus read/write multiple registers request.

C: The connection.
Headers: The headers for the modbus function.
Read_start_address: The memory address of the first register to be read.
Read_quantity: The number of registers to read.
Write_start_address: The memory address of the first register to be written.
Write_registers: The values to be written to the registers.

modbus_read_write_multiple_registers_response¶

Type: event (c: connection, headers: ModbusHeaders, written_registers: ModbusRegisters)

Generated for a Modbus read/write multiple registers response.

C: The connection.
Headers: The headers for the modbus function.
Written_registers: The register values read from the registers specified in the request.

modbus_write_file_record_request¶

Type: event (c: connection, headers: ModbusHeaders)

Generated for a Modbus write file record request.

C: The connection.
Headers: The headers for the modbus function.

modbus_write_file_record_response¶

Type: event (c: connection, headers: ModbusHeaders)

Generated for a Modbus write file record response.

C: The connection.
Headers: The headers for the modbus function.

modbus_write_multiple_coils_request¶

Type: event (c: connection, headers: ModbusHeaders, start_address: count, coils: ModbusCoils)

Generated for a Modbus write multiple coils request.

C: The connection.
Headers: The headers for the modbus function.
Start_address: The memory address of the first coil to be written.
Coils: The values to be written to the coils.

modbus_write_multiple_coils_response¶

Type: event (c: connection, headers: ModbusHeaders, start_address: count, quantity: count)

Generated for a Modbus write multiple coils response.

C: The connection.
Headers: The headers for the modbus function.
Start_address: The memory address of the first coil that was written.
Quantity: The quantity of coils that were written.

modbus_write_multiple_registers_request¶

Type: event (c: connection, headers: ModbusHeaders, start_address: count, registers: ModbusRegisters)

Generated for a Modbus write multiple registers request.

C: The connection.
Headers: The headers for the modbus function.
Start_address: The memory address of the first register to be written.
Registers: The values to be written to the registers.

modbus_write_multiple_registers_response¶

Type: event (c: connection, headers: ModbusHeaders, start_address: count, quantity: count)

Generated for a Modbus write multiple registers response.

C: The connection.
Headers: The headers for the modbus function.
Start_address: The memory address of the first register that was written.
Quantity: The quantity of registers that were written.

modbus_write_single_coil_request¶

Type: event (c: connection, headers: ModbusHeaders, address: count, value: bool)

Generated for a Modbus write single coil request.

C: The connection.
Headers: The headers for the modbus function.
Address: The memory address of the coil to be written.
Value: The value to be written to the coil.

modbus_write_single_coil_response¶

Type: event (c: connection, headers: ModbusHeaders, address: count, value: bool)

Generated for a Modbus write single coil response.

C: The connection.
Headers: The headers for the modbus function.
Address: The memory address of the coil that was written.
Value: The value that was written to the coil.

modbus_write_single_register_request¶

Type: event (c: connection, headers: ModbusHeaders, address: count, value: count)

Generated for a Modbus write single register request.

C: The connection.
Headers: The headers for the modbus function.
Address: The memory address of the register to be written.
Value: The value to be written to the register.

modbus_write_single_register_response¶

Type: event (c: connection, headers: ModbusHeaders, address: count, value: count)

Generated for a Modbus write single register response.

C: The connection.
Headers: The headers for the modbus function.
Address: The memory address of the register that was written.
Value: The value that was written to the register.