Differences

This shows you the differences between two versions of the page.

--- custom_protocols [2020/01/02 10:44] – [readRegister] emozolyak
+++ custom_protocols [2020/02/07 12:50] – [readRegister] emozolyak
@@ Line 93: / Line 93: @@
 Three parameters are passed to it as arguments:
-reg - Table (structure) with register parameters
+  ***reg** - Table (structure) with register parameters
-device - Table (structure) with register type parameters (that were defined in createDevices)
+  ***device** - Table (structure) with register type parameters (that were defined in createDevices)
-unitId – device ID for the bus or other ID. For instance, Slave ID in ModBus RTU or Unit ID in ModBus TCP.
+  ***unitId** – device ID for the bus or other ID. For instance, Slave ID in ModBus RTU or Unit ID in ModBus TCP.
-There are such attributes in the reg structure:
+There are such attributes in the __reg__ structure:
-internalAddr - Recalculated register address. This number is recalculated from the specified number system with shift added to it.
+  *internalAddr - Recalculated register address. This number is recalculated from the specified number system with shift added to it.
-addr - The original address of the register that the user entered.
+  *addr - The original address of the register that the user entered.
-dataType – The type of data that the user specified for the register. 0 = Bit, 1 = Byte, 2 = Word, 3 = Double Word, 4 = UnixTime
+  *dataType – The type of data that the user specified for the register. 0 = Bit, 1 = Byte, 2 = Word, 3 = Double Word, 4 = UnixTime
-There are such attributes in the device structure:
+There are such attributes in the __device__ structure:
-shift - The shift value from the corresponding row in createDevices
+  *shift - The shift value from the corresponding row in createDevices
-base - base value from the corresponding row in createDevices
+  *base - base value from the corresponding row in createDevices
-xtraFields – xtraFields value from the corresponing row in createDevices
+  *xtraFields – xtraFields value from the corresponing row in createDevices
 These parameters are passed in order to be able to correctly and fully compose a request according to the protocol.
@@ Line 120: / Line 120: @@
 To make a delay, //sleep// function can be used. Its only argument is time in microseconds, e.g. sleep(20000) will make a pause for 20 ms.
-Для работы с битами можно использовать библиотеку bitop [4].
+For bit processing refer to bitop library and this [[useful_programs#bit_functions | link]].
-Для отладки и вывода диагностических сообщений можно использовать процедуры ERROR, INFO, DEBUG и TRACE которые доступны и в обычных сценариях Lua [5].
+For debugging and diagnostic messages you can use ERROR, INFO, DEBUG or TRACE from the users Lua scripts - see [[write_to_logs | this]].
-Что бы лучше понять как это все работает давайте рассмотрим пример функции readRegister для протокола ModBus TCP:
+To better understand the custom protocol application, let's examine the readRegister function for the ModBus TCP protocol:
 <code lua>