rchOpen (Function)

Top  Previous  Next

Architecture:

NX32L

Firmware version:

1.54.00


This function will open a connection to the RTCU Communication Hub, using the configuration set with the rchConfigSet function.

Also see rchClose for closing the connection to the RTCU  Communication Hub.

 

The rchOpen function is functionally identical to and interchangeable with the gwOpen function.

 

 

Input:        

None.

 

Returns: INT

1

- Success.

0

- Not available.

-1

- The connection is already open.

-2

- Invalid configuration.

 

Declaration:

FUNCTION rchOpen : INT;
 

 

Example:

INCLUDE rtcu.inc
 
PROGRAM test;
VAR
   timer    : clockDayTimer;
   rc       : INT;
END_VAR;

 
   // Initialize
   timer(enable:=ON, start_hour:=12, start_minute:=0, stop_hour:=13, stop_minute:=30);
 
BEGIN
   // Manage the connection
   timer();
   IF timer.THEN
      IF NOT rchIsOpen() THEN
         DebugMsg(message := "Starting connection");
         rc := rchOpen();
         IF rc < 1 THEN
            DebugFmt(message := "  rchOpen=\1", v1 := rc);
         END_IF;
      END_IF;
   ELSE
      IF rchIsOpen() THEN
         DebugMsg(message := "Stopping connection");
         rc := rchClose();
         IF rc < 1 THEN
            DebugFmt(message := "  rchClose=\1", v1 := rc);
         END_IF;
      END_IF;
   END_IF;

 
   IF rchConnected() THEN
      // Connection is ready for work
   END_IF;
END;
END_PROGRAM;