Return Type

Method

Description

analogPoll( rtuName )

Execute the analog poll command to devices. (HMI only)

  str

connectedHost( device )

Return the IP of connected devices. (TCP/IP server only)

integrityPoll( rtuName )

Execute the integrity poll command to devices. (HMI only)

openSetPoint( name, confirm )

It is used to write values on the device. (HMI only)

boolean

sendCommand( device, cmd, param )

It is used to send driver commands.

boolean

setAnalogSequence( device, datas, confirm )

Write the value of analog points simultaneously. (HMI only)

  boolean

setAnalogSequence( device, datas, savelog )

Write the value of status points simultaneously. (Server only)

 boolean

setValue( name, value )

Write the value on the output address of the device set on point 'name'. (HMI only)

boolean

setValue( name, value, savelog )

Write the value on the output address of the device set on point 'name'. (Server only)

boolean

setValueConfirm( name, value )

Write the value on the output address of the device set on point 'name', after user confirm is done. (HMI only)

  boolean

setValueUnConfirmed( name, value )

Write the value on the output address of the device set on point 'name'. (HMI only)

setValueUnConfirmed( name, value, savelog )

Write the value on the output address of the device set on point 'name'. (Server only)

statusPoll( rtuName )

Execute the status poll command to devices. (HMI only)

timeSyncCmd( rtuName )

Execute the time synchronization command to devices. (HMI only)

toggle( name, confirm )

Invert the current value and write it on devices. (HMI only)

  analogPoll( rtuName:Device name)

  Poll all analog data belong to that device.

        ㆍ Enter the name of devices registered on Data Explorer to rtuName. (HMI only)

  Example)

       remote.analogPoll('10Kv Feeder#1');  << Poll all analog data belong to 10Kv Feeder#1.

  The following is the device window of Data Explorer.

        ㆍ When the control succeeds, print a message about completion.

                                <Success>

        ㆍ When the control fails, print a message about failure.

                          <Device is not connected>

                          <Device is not existing>

                          <PowerScene driver is not running>

  str connectedHost( device:Device name )

  Return the IP of connected devices (TCP/IP only)

  Example)

       deviceAddress = remote.connectedHost('LP-1 RTU')  << Return the IP of 'LP-1 RTU'

  integrityPoll( rtuName:Device name )

  Poll all data belongs to that device.

        ㆍ Enter the name of devices registered on Data Explorer to tuName.

  Example)

       remote.integrityPoll('10Kv Feeder#1');  << Poll all data belong to '10Kv Feeder#1'.

  The following is the device window of Data Explorer.

        ㆍ When the control succeeds, print a message about completion.

                          <Success>

        ㆍ When the control fails, print a message about failure.

                          <Device is not connected>

                          <Device is not existing>

                          <PowerScene driver is not running>

  openSetPoint( name:Point name, confirm:User confirm settings )

  Open the screen that users can enter the value of points.

        ㆍ Enter the name of points to name.

        ㆍ The using user confirm is entered on confirm.

                - Enter 1 : Entering the value of points, then open the user confirm screen.

                - Enter 0 : Entering the value of points, do not open the user confirm screen.

        ㆍ (HMI only)

  Example)

       remote.openSetPoint('A', 0);  << Open the screen to enter the value of A, then do not open the user confirm screen.

  The following is an example of control success without the user confirm.

  The following is an example of control failure without the user confirm.

        ㆍ Control success without user confirm -> no messages

        ㆍ Control failure without user confirm -> print a message

  Example)

       remote.openSetPoint('A', 1);  << Open the screen to enter the value of A, then open the user confirm screen.

  The following is an example of control success with the user confirm.

  The following is an example of control failure with the user confirm.

        ㆍ Control success with user confirm, then print a success message.

        ㆍ Control failure with user confirm, then print a failure message.

  boolean setAnalogSequence( device:Device name, datas:A list of values and points, confirm:User confirm settings )

  Set the value of points. (HMI only)

        ㆍ The device name could be checked in Data Explorer.

        ㆍ datas is a list of points and data.

                Example) Set the value of point1, point2, point3 as 22, 0, 1.1, respectively : [['point1', 22], ['point2', 0], ['point3', 1.1]]

        ㆍ Enter the using user confirm to confirm.

                - Enter 1 : Open the user confirm screen, and control the value of points through the user authentication process.

                - Enter 0 : Control the value of points without user authentication.

  Example)

       valueToWrite = list()

       valueToWrite.append ( ['RTU A', 32.5 ] )  << Set the value of 'RTU A' as 32.5

       valueToWrite.append ( ['RTU B', 77.5 ] )  << Set the value of 'RTU B' as 77.5

       remote.setAnalogSequence( 'LP - 1 RTU', valueToWrite , 1);  << Set the value of 'RTU A' and 'RTU B' as 32.5 ,and 77.5 respectively. Open the user confirm screen, and control the value of points through user authentication process.

  When entering 1 on confirm, the following screen is popped-up.

  boolean setAnalogSequence( device:Device name, datas:A list of points and values, saveLog: Saving log )

        ㆍ (Server only)

        ㆍ It provides the same function as well as setAnalogSequence and used in the same way.

        ㆍ The differences are as follows:

                - HMI : Set using user confirm.

                - Server : Set saving the log.

        ㆍ The saving log is entered on saveLog.

                - Enter 1 : Save the control log.

                - Enter 0 : Do not save the control log.

        ㆍ The result values are as follows:

                - Success : Return TRUE

                - Failure : Return FALSE

  Example)

       valueToWrite = list()

       valueToWrite.append ( ['RTU A', 32.5 ] ) << Set the value of 'RTU A' as 32.5.

       valueToWrite.append ( ['RTU B', 77.5 ] ) << Set the value of 'RTU B' as 77.5.

       remote.setAnalogSequence( 'LP - 1 RTU', valueToWrite , 1);  << Set the value of 'RTU A' ,and 'RTU B' as 32.5, and 77.5 respectively, then save the control log.

  boolean setValue( name:Point name, value:Values )

  setValue is used to write the value of points to devices. Without other processes, it sends the control command when executing the script.

        ㆍ Enter the name of points to be set to name.

        ㆍ Enter The value of points to value.

        ㆍ (HMI only)

  Example)

       remote.setValue('PLC.START', 0);  << Set the value of 'PLC.START' as 0.

  The following is an example of a success message printing on the alarm window.

  The following is an example of a message according to control failure.

        ㆍ Do not print a message based on control success.

        ㆍ Print a message about control failure. (Print the reason for failure)

  The following is an example of a control progress screen.

  Control progress screen is a screen that occurs when control exists in the remote object used commands. If the transmission is fast, it is invisible to users. if not, the screen is visible.

        ㆍ Control – Control progress screen – Success

        ㆍ Control – Control progress screen – Failure

  boolean setValue( name:Point name, value:Values, saveLog:Saving log )

  setValue is used to write the value of points to drivers.

        ㆍ There is no screen resulting from executing functions.

        ㆍ The following are the result of point value settings.

                - Success : Return TRUE

                - Failure : Return FALSE

        ㆍ (Server only)

  Example)

       remote.setValue('PLC.START', 0);  << Set the value of 'PLC.START' as 0.

  boolean setValueConfirm( name:Point name, value:Values )

  setValueConfirm is used to write the value of points to drivers.

        ㆍ setValueConfirm differs from setValue. Before sending the value, it validates user ID and password then progress.

        ㆍ (HMI only)

  Example)

       remote.setValueConfirm('LP 2.DI 1', 0);  << Set the value of 'LP 2.DI 1' as 0

  The following is an example of control success after the user confirm.

  The following is an example of control failure after the user confirm

        ㆍ setValueConfirm differs from setValue. It re-verifies control through the control confirm box.

        ㆍ setValueConfirm prints a control success box when succeeded controlling.

        ㆍ Print the reason for failure when failed to control.

  boolean setValueUnConfirmed( name:Point name, value:Values )

  Write the entered value of point 'name' to drivers.

        ㆍ SetValueConfimed differs from setValue. setValue waits for the response from devices in order of HMI->PowerScene driver->Devices->PowerScene driver->HMI. However, setValueUnConfimed waits for the confirm response in order of HMI->PowerScene driver->HMI.

        ㆍ When controlling various data, using setValueConfirmed, the waiting time is lower than setValue.

        ㆍ When the control command is sent normally, return TRUE, or FALSE. (HMI only)

  Example)

       ret = remote. setValueUnConfirmed('A', 0);  << Set the value of point A as 0.

       app.messageBox(ret);

   The following is the output window when the point doesn't exist.

                  ㆍ Do not print a message regardless of controls.

                  ㆍ But, if the point doesn't exist, print a failure message.

   The following is the response and control of setValue.

   The following is the response and control of setValueUnConfirmed.

  setValueUnConfirmed( name:Point name, value:Values, saveLog:Saving log )

  Write the entered value of point 'name' to drivers.

        ㆍ setValueConfirmed differs from setValue. setValue waits for the response after setValue in order of HMI->PowerScene driver->Devices->PowerScene driver->HMI. However, setValueUnConfirmed waits for the response in order of HMI->PowerScene driver->HMI.

        ㆍ When controlling various data, using setValueUnConfirmed the waiting time is lower than setValue. (Server only)

  Example)

       remote. setValueUnConfirmed('A', 0 , 1);  << Save the log and print it on the event window.

       remote. setValueUnConfirmed('B', 0 , 1);  << Do not save the log.

  statusPoll( rtuName:Device name )

  Poll all status data belong to that device.

        ㆍ Enter the name of devices registered on Data Explorer to rtuName. (HMI only)

  Example)

       remote.statusPoll('10Kv Feeder#1');  << Poll all status data belong to 10Kv Feeder#1.

  The following is the device window of Data Explorer.

        ㆍ When control succeeds, print a message about completion.

                                      <Success>

        ㆍ When control fails, print a message about failure.

                                            <Device is not connected>

                                            <Device is not existing>

                                      <PowerScene driver is not running>

  timeSyncCmd( rtuName:Device name )

  Synchronize the time of that device to match the time of PC running the PowerScene driver monitor. (HMI only)

  Example)

       remote.timeSyncCmd('10Kv Feeder#1');  << Synchronize the time of 10Kv Feeder#1 to match the time of PC.

  The following is the device window of Data Explorer.

        ㆍ When the control succeeds, print a message about completion.

                                      <Success>

        ㆍ When the control fails print a message about failure.

                                             <Device is not connected>

                                             <Device is not existing>

                                       <PowerScene driver is not running>

  toggle( name:Point name, confirm:Using user confirm )

  Provide a toggle function(Like an on/off button) on point 'name'. (HMI only)

        ㆍ If confirm is 0, do not open the user confirm screen, if it is 1, open the screen.

        ㆍ toggles are available for status points.

  Example)

       remote.toggle('Point name', 0); << User authentication is unverified.

       remote.toggle('Point name', 1); << User autentication is verified.

  The following is the toggle setting.

  boolean sendCommand( device:Device name, cmd:Command name, param:Parameter )

  sendCommand is used to send a driver command.

  The type of command differs based on the driver. The command type and functions are as follows:                                                                                            

        ㆍ When using sendMessage of munjanara driver, the parameter format is as follows:

                - Send a message to all of the users.       :   'Sending message'

                - Send a message to the particular user.  :   ['Sending message', 'user ID']

        ㆍ Users can check the user ID on the User tab of Data Explorer.

  The following is an example of munjanara driver.

  Example) Send a message to all of the users.

       remote.sendCommand('www.munjanara.co.kr','SendMessage','Emergency')

  Example) Send a message to the particular user.

       message=['Emergency',1']

       remote.sendCommand('www.munjanara.co.kr','SendMessage',message)