Modbus Object Instantiation/InitializationModbus Object Instantiation/InitializationFunctions void Modbus::begin (long u32speed)Initialize class object. void Modbus::begin (long u32speed, uint8_t u8config)Initialize class object. void Modbus::begin (SoftwareSerial *sPort, long u32speed)Initialize class object. uint8_t Modbus::getID ()get slave ID between 1 and 247 Modbus::Modbus ()Default Constructor for Master through Serial. void Modbus::setID (uint8_t u8id)write new ID for the slave void Modbus::setTimeOut (uint16_t u16timeout)write communication watch-dog timer Detailed DescriptionFunction Documentationbegin()<computeroutput>[1/3]</computeroutput>beginModbus Object Instantiation/InitializationModbus Object Instantiation/Initializationbeginvoid Modbus::begin (long u32speed)Initialize class object. Sets up the serial port using specified baud rate. Call once class has been instantiated, typically within setup().See alsohttp://arduino.cc/en/Serial/Begin#.Uy4CJ6aKlHY
Parameters
speedbaud rate, in standard increments (300..115200)
Definition at line 298 of file ModbusRtu.h.00299 {
00300
00301 switch (u8serno)
00302 {
00303 #if defined(UBRR1H)
00304 case 1:
00305 port = &Serial1;
00306 break;
00307 #endif
00308
00309 #if defined(UBRR2H)
00310 case 2:
00311 port = &Serial2;
00312 break;
00313 #endif
00314
00315 #if defined(UBRR3H)
00316 case 3:
00317 port = &Serial3;
00318 break;
00319 #endif
00320 case 0:
00321 default:
00322
00323 port = &Serial;
00324 break;
00325 }
00326
00327 port->begin(u32speed);
00328 if (u8txenpin > 1) // pin 0 & pin 1 are reserved for RX/TX
00329 {
00330 // return RS485 transceiver to transmit mode
00331 RS485_DIR_REG |= RS485_PIN_DE | RS485_PIN_RE;
00332 RS485_CLEAR_DE;
00333 RS485_CLEAR_RE;
00334 // pinMode(u8txenpin, OUTPUT);
00335 // digitalWrite(u8txenpin, LOW);
00336 }
00337
00338 while (port->read() >= 0)
00339 ;
00340 u8lastRec = u8BufferSize = 0;
00341 u16InCnt = u16OutCnt = u16errCnt = 0;
00342 }
begin()<computeroutput>[2/3]</computeroutput>beginModbus Object Instantiation/InitializationModbus Object Instantiation/Initializationbeginvoid Modbus::begin (long u32speed, uint8_t u8config)Initialize class object. Sets up the serial port using specified baud rate. Call once class has been instantiated, typically within setup().See alsohttp://arduino.cc/en/Serial/Begin#.Uy4CJ6aKlHY
Parameters
speedbaud rate, in standard increments (300..115200) configdata frame settings (data length, parity and stop bits)
Definition at line 395 of file ModbusRtu.h.00396 {
00397
00398 switch (u8serno)
00399 {
00400 #if defined(UBRR1H)
00401 case 1:
00402 port = &Serial1;
00403 break;
00404 #endif
00405
00406 #if defined(UBRR2H)
00407 case 2:
00408 port = &Serial2;
00409 break;
00410 #endif
00411
00412 #if defined(UBRR3H)
00413 case 3:
00414 port = &Serial3;
00415 break;
00416 #endif
00417 case 0:
00418 default:
00419 port = &Serial;
00420 break;
00421 }
00422
00423 port->begin(u32speed, u8config);
00424 if (u8txenpin > 1) // pin 0 & pin 1 are reserved for RX/TX
00425 {
00426 // return RS485 transceiver to transmit mode
00427 RS485_DIR_REG |= RS485_PIN_DE | RS485_PIN_RE;
00428 RS485_CLEAR_DE;
00429 RS485_CLEAR_RE;
00430 // pinMode(u8txenpin, OUTPUT);
00431 // digitalWrite(u8txenpin, LOW);
00432 }
00433
00434 while (port->read() >= 0)
00435 ;
00436 u8lastRec = u8BufferSize = 0;
00437 u16InCnt = u16OutCnt = u16errCnt = 0;
00438 }
begin()<computeroutput>[3/3]</computeroutput>beginModbus Object Instantiation/InitializationModbus Object Instantiation/Initializationbeginvoid Modbus::begin (SoftwareSerial * sPort, long u32speed)Initialize class object. Sets up the software serial port using specified baud rate and SoftwareSerial object. Call once class has been instantiated, typically within setup().
Parameters
speed*softPort, pointer to SoftwareSerial class object speedbaud rate, in standard increments (300..115200)
Definition at line 360 of file ModbusRtu.h.00361 {
00362
00363 softPort = sPort;
00364
00365 softPort->begin(u32speed);
00366
00367 if (u8txenpin > 1) // pin 0 & pin 1 are reserved for RX/TX
00368 {
00369 // return RS485 transceiver to transmit mode
00370 RS485_DIR_REG |= RS485_PIN_DE | RS485_PIN_RE;
00371 RS485_CLEAR_DE;
00372 RS485_CLEAR_RE;
00373 // pinMode(u8txenpin, OUTPUT);
00374 // digitalWrite(u8txenpin, LOW);
00375 }
00376
00377 while (softPort->read() >= 0)
00378 ;
00379 u8lastRec = u8BufferSize = 0;
00380 u16InCnt = u16OutCnt = u16errCnt = 0;
00381 }
getID()getIDModbus Object Instantiation/InitializationModbus Object Instantiation/InitializationgetIDuint8_t Modbus::getID ( )get slave ID between 1 and 247 Method to read current slave ID address.Returnsu8id current slave address between 1 and 247
Definition at line 477 of file ModbusRtu.h.00478 {
00479 return this->u8id;
00480 }
Modbus()ModbusModbus Object Instantiation/InitializationModbus Object Instantiation/InitializationModbusModbus::Modbus ( )Default Constructor for Master through Serial.
Definition at line 228 of file ModbusRtu.h.00229 {
00230 init(0, 0, 0);
00231 debugSend = false;
00232 }
setID()setIDModbus Object Instantiation/InitializationModbus Object Instantiation/InitializationsetIDvoid Modbus::setID (uint8_t u8id)write new ID for the slave Method to write a new slave ID address.
Parameters
u8idnew slave address between 1 and 247
Definition at line 462 of file ModbusRtu.h.00463 {
00464 if ((u8id != 0) && (u8id <= 247))
00465 {
00466 this->u8id = u8id;
00467 }
00468 }
setTimeOut()setTimeOutModbus Object Instantiation/InitializationModbus Object Instantiation/InitializationsetTimeOutvoid Modbus::setTimeOut (uint16_t u16timeOut)write communication watch-dog timer Initialize time-out parameter.Call once class has been instantiated, typically within setup(). The time-out timer is reset each time that there is a successful communication between Master and Slave. It works for both.
Parameters
time-outvalue (ms)
Definition at line 493 of file ModbusRtu.h.00494 {
00495 this->u16timeOut = u16timeOut;
00496 }