Modbus Object ManagementModbus Object ManagementFunctions boolean Modbus::getTimeOutState ()get communication watch-dog timer state int8_t Modbus::poll ()cyclic poll for master int8_t Modbus::poll (uint16_t *regs, uint8_t u8size)cyclic poll for slave int8_t Modbus::query (modbus_t telegram)only for master Detailed DescriptionFunction DocumentationgetTimeOutState()getTimeOutStateModbus Object ManagementModbus Object ManagementgetTimeOutStateboolean Modbus::getTimeOutState ( )get communication watch-dog timer state Return communication Watchdog state. It could be useful to reset outputs if the watchdog is fired.ReturnsTRUE if millis() > u32timeOut
Definition at line 506 of file ModbusRtu.h.00507 {
00508 return (millis() > u32timeOut);
00509 }
poll()<computeroutput>[1/2]</computeroutput>pollModbus Object ManagementModbus Object Managementpollint8_t Modbus::poll ( )cyclic poll for master *** Only for Modbus Master *** This method checks if there is any incoming answer if pending. If there is no answer, it would change Master state to COM_IDLE. This method must be called only at loop section. Avoid any delay() function.Any incoming data would be redirected to au16regs pointer, as defined in its modbus_t query telegram.@params nothing Returnserrors counter
Definition at line 691 of file ModbusRtu.h.00692 {
00693 // check if there is any incoming frame
00694 uint8_t u8current;
00695 if (u8serno < 4)
00696 {
00697 u8current = port->available();
00698 }
00699 else
00700 {
00701 u8current = softPort->available();
00702 }
00703
00704 if (millis() > u32timeOut)
00705 {
00706 u8state = COM_IDLE;
00707 u8lastError = NO_REPLY;
00708 u16errCnt++;
00709 return 0;
00710 }
00711
00712 if (u8current == 0)
00713 {
00714 return 0;
00715 }
00716
00717 // check T35 after frame end or still no frame end
00718 if (u8current != u8lastRec)
00719 {
00720 u8lastRec = u8current;
00721 u32time = millis() + T35;
00722 return 0;
00723 }
00724 if (millis() < u32time)
00725 {
00726 return 0;
00727 };
00728
00729 // transfer Serial buffer frame to auBuffer
00730 u8lastRec = 0;
00731 int8_t i8state = getRxBuffer();
00732 if (i8state < 7)
00733 {
00734 u8state = COM_IDLE;
00735 u16errCnt++;
00736 Log.verboseln("Add error : %d - RX-Buffer < 7", i8state);
00737 printHex(rxBuffer, u8BufferSize);
00738 return i8state;
00739 }
00740
00741 // validate message: id, CRC, FCT, exception
00742 uint8_t u8exception = validateAnswer();
00743 if (u8exception != 0)
00744 {
00745 Log.verboseln("ModbusRTU::poll : exception : %d", u8exception);
00746 u8state = COM_IDLE;
00747 return u8exception;
00748 }
00749
00750 // process answer
00751 switch (au8Buffer[FUNC])
00752 {
00753 case MB_FC_READ_COILS:
00754 case MB_FC_READ_DISCRETE_INPUT:
00755 // call get_FC1 to transfer the incoming message to au16regs buffer
00756 get_FC1();
00757 break;
00758 case MB_FC_READ_INPUT_REGISTER:
00759 case MB_FC_READ_REGISTERS:
00760 // call get_FC3 to transfer the incoming message to au16regs buffer
00761 get_FC3();
00762 break;
00763 case MB_FC_WRITE_COIL:
00764 case MB_FC_WRITE_REGISTER:
00765 case MB_FC_WRITE_MULTIPLE_COILS:
00766 case MB_FC_WRITE_MULTIPLE_REGISTERS:
00767 // nothing to do
00768 break;
00769 default:
00770 break;
00771 }
00772 u8state = COM_IDLE;
00773 currentQuery->flags = QUERY_STATE::RESPONDED;
00774 return u8BufferSize;
00775 }
poll()<computeroutput>[2/2]</computeroutput>pollModbus Object ManagementModbus Object Managementpollint8_t Modbus::poll (uint16_t * regs, uint8_t u8size)cyclic poll for slave *** Only for Modbus Slave *** This method checks if there is any incoming query Afterwards, it would shoot a validation routine plus a register query Avoid any delay() function !!!! After a successful frame between the Master and the Slave, the time-out timer is reset.
Parameters
*regsregister table for communication exchange u8sizesize of the register table
Returns0 if no query, 1..4 if communication error, >4 if correct query processed
Definition at line 790 of file ModbusRtu.h.00791 {
00792
00793 au16regs = regs;
00794 u8regsize = u8size;
00795 uint8_t u8current;
00796
00797 // check if there is any incoming frame
00798 if (u8serno < 4)
00799 u8current = port->available();
00800 else
00801 u8current = softPort->available();
00802
00803 if (u8current == 0)
00804 return 0;
00805
00806 // check T35 after frame end or still no frame end
00807 if (u8current != u8lastRec)
00808 {
00809 u8lastRec = u8current;
00810 u32time = millis() + T35;
00811 return 0;
00812 }
00813 if (millis() < u32time)
00814 return 0;
00815
00816 u8lastRec = 0;
00817 int8_t i8state = getRxBuffer();
00818 u8lastError = i8state;
00819 if (i8state < 7)
00820 return i8state;
00821
00822 // check slave id
00823 if (au8Buffer[ID] != u8id)
00824 {
00825 return 0;
00826 }
00827
00828 // validate message: CRC, FCT, address and size
00829 uint8_t u8exception = validateRequest();
00830 if (u8exception > 0)
00831 {
00832 Serial.println("exception : 1");
00833 if (u8exception != NO_REPLY)
00834 {
00835 buildException(u8exception);
00836 sendTxBuffer();
00837 }
00838 u8lastError = u8exception;
00839 return u8exception;
00840 }
00841
00842 u32timeOut = millis() + long(u16timeOut);
00843 u8lastError = 0;
00844
00845 Log.verboseln("mb : process message : %d", FUNC);
00846
00847 // process message
00848 switch (au8Buffer[FUNC])
00849 {
00850 case MB_FC_READ_COILS:
00851 case MB_FC_READ_DISCRETE_INPUT:
00852 return process_FC1(regs, u8size);
00853 break;
00854 case MB_FC_READ_INPUT_REGISTER:
00855 case MB_FC_READ_REGISTERS:
00856 return process_FC3(regs, u8size);
00857 break;
00858 case MB_FC_WRITE_COIL:
00859 return process_FC5(regs, u8size);
00860 break;
00861 case MB_FC_WRITE_REGISTER:
00862 return process_FC6(regs, u8size);
00863 break;
00864 case MB_FC_WRITE_MULTIPLE_COILS:
00865 return process_FC15(regs, u8size);
00866 break;
00867 case MB_FC_WRITE_MULTIPLE_REGISTERS:
00868 return process_FC16(regs, u8size);
00869 break;
00870 default:
00871 break;
00872 }
00873 currentQuery->flags = RESPONDED;
00874 return i8state;
00875 }
query()queryModbus Object ManagementModbus Object Managementqueryint8_t Modbus::query (modbus_t telegram)only for master *** Only Modbus Master *** Generate a query to an slave with a modbus_t telegram structure The Master must be in COM_IDLE mode. After it, its state would be COM_WAITING. This method has to be called only in loop() section.See alsomodbus_t
Parameters