Differences

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

--- custom_protocols [2020/01/02 10:31] – [readRegister] emozolyak
+++ custom_protocols [2020/01/02 10:56] – [readRegister] emozolyak
@@ Line 108: / Line 108: @@
 These parameters are passed in order to be able to correctly and fully compose a request according to the protocol.
-To send a request to the device //sendBytes// and //sendString// are used. To read the reply //readBytes// and //readString// respectively.
+To send a request to the device //sendBytes// and //sendString// are used. To read the reply //readBytes// and //readString// respectively. Their overview is given in the following table:
-The sendBytes fucntion accepts a table(array) of bytes as an argument. On success execution it returns true, otherwise - false.
+^ Function ^ Arguments ^ Returns ^
-The sendString accepts a string as an argument. Результатом будет true в случае успеха и false в случае ошибки.
+|sendBytes  |table | true/false (success execution or no) |
-На вход readBytes принимает количество байт, которое необходимо прочитать. Результатом будет таблица (массив) байт в случае успеха и false в случае ошибки.
+|sendString |string| same |
-На вход readString принимает количество байт, которое необходимо прочитать. Результатом будет строка в случае успеха и false в случае ошибки.
+|readBytes  |number (of bytes to read)| table of bytes or false for error |
-Если необходимо закрыть соединение (например, в случае множественных ошибок), то можно вызвать процедуру closeConnection.
+|readString |number (of chars to read)| string  or false for error |
-Если необходимо сделать паузу, то можно вызвать функцию sleep. Ее единственным аргументом должно быть время в микросекундах. Пример: sleep(20000); - произойдет пауза 20 миллисекунд.
+To close connection (in case of many errors), //closeConnection// function can be used.
-Для работы с битами можно использовать библиотеку bitop [4].
+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.
-Для отладки и вывода диагностических сообщений можно использовать процедуры ERROR, INFO, DEBUG и TRACE которые доступны и в обычных сценариях Lua [5].
+For bit processing refer to bitop library and this [[useful_programs#bit_functions | link]].
-Что бы лучше понять как это все работает давайте рассмотрим пример функции readRegister для протокола ModBus TCP:
+For debugging and diagnostic messages you can use ERROR, INFO, DEBUG or TRACE from the users Lua scripts - see [[write_to_logs | this]].
+To better understand the custom protocol application, let's examine the readRegister function for the ModBus TCP protocol:
 <code lua>