GeViSoft

From IPLOG
Jump to: navigation, search

Back to Libraries

GeViSoft library

Interaction with GeViSoft server through GETAS interface.

Communication

GEVISOFT_COMM

Communicate with GeViSoft server, must be called periodically.

Asynchronous interface
in IP_ADDR string server ip address
in PORT uint server port
out CONNECTED bool connection state

Reading

All GeViSoft library reading blocks works with data received by GEVISOFT_COMM function block.

Each received command is stored in internal cache for one program cycle. During this program cycle can by processed by unlimited count of reading blocks.

GEVISOFT_READ

Checks incoming data for given command

in CMD string received command
out VALID bool command received
out IDX usint last index of proper command in cache (starts by 0)
out COUNT usint count of proper commands in cache

GEVISOFT_R_CUSTOM_ACTION

Returns values of last received custom action

out VALID bool CustomAction command received
out IDX usint last index of proper command in cache (starts by 0)
out COUNT usint count of proper commands in cache
out CUSTOM_INT lint custom_int value
out CUSTOM_STRING string custom_string value

GEVISOFT_R_EVENT_STARTED

Check if event with given name was started

in NAME string event name
out VALID bool event started
out IDX usint last index of proper command in cache (starts by 0)

GEVISOFT_R_EVENT_STOPPED

Check if event with given name was stopped

in NAME string event name
out VALID bool event stopped
out IDX usint last index of proper command in cache (starts by 0)

GEVISOFT_R_GSC_TEMPERATURE

Returns temperature of module with given id

in ID string module id
out VALID bool GeViScope Temperarture command received
out VALUE lint temperature value
out IDX usint last index of proper command in cache (starts by 0)

GEVISOFT_R_OUTPUT

Reads value of given output

in N uint output number
out VALID bool value of given output received
out VALUE lint output value
out IDX usint last index of proper command in cache (starts by 0)

GEVISOFT_R_INPUT

Reads value of given input

in N uint input number
out VALID bool value of given input received
out VALUE lint input value
out IDX usint last index of proper command in cache (starts by 0)

GEVISOFT_R_SYSTEM_ERROR

Returns information about last received system error

out VALID bool SystemError command received
out IDX usint last index of proper command in cache (starts by 0)
out COUNT usint count of proper commands in cache
out CLIENT_ID ulint client_id value
out ERROR_CODE lint error_code value
out ERROR_SUBCODE lint error_subcode value
out ERROR_TEXT string error_text value

GEVISOFT_R_VIDEO_SYNC

Reads sync status of given video input

in N uint video input number
out VALID bool sync status of given video input received
out VALUE lint sync status
out IDX usint last index of proper command in cache (starts by 0)

Writing

GEVISOFT_WRITE

Writes given command.

Asynchronous interface
in CMD string command to write

GEVISOFT_W_CUSTOM_ACTION

Invokes custom action with given values.

Asynchronous interface
in CUSTOM_INT lint custom_int
in CUSTOM_STRING string[255] custom_string

GEVISOFT_W_EVENT_START

Starts given event.

Asynchronous interface
in NAME string event name

GEVISOFT_W_EVENT_STOP

Stops given event.

Asynchronous interface
in NAME string event name

GEVISOFT_W_INPUT

Writes value to given input.

Asynchronous interface
in N uint input number
in VALUE bool input value

GEVISOFT_W_OUTPUT

Writes value to given output.

Asynchronous interface
in N uint output number
in VALUE bool output value