Skip to content

Latest commit

 

History

History
73 lines (52 loc) · 1.78 KB

nimGet.md

File metadata and controls

73 lines (52 loc) · 1.78 KB

nimGet API

nimGet methods are created to retrieve or transform information retrieved from local robot/hub.

Constants

Constants Type Description
NIMV_CONTIP string Controller IP
NIMV_CONTPORT int Controller Port
NIMV_SPOOLIP string Spooler IP
NIMV_SPOOLPORT int Spooler Port
NIMV_HUBIP string HUB IP
NIMV_HUBPORT int HUB Port
NIMV_DEF_HUBPORT int N.A
NIMV_HUBADDR string Hub nimbus addresse
NIMV_HUBDOMAIN string Hub domain
NIMV_DEF_CONTPORT int N.A
NIMV_DEF_SPOOLPORT int N.A
NIMV_ROBOTIP string Robot IP
NIMV_HUBNAME string Hub name
NIMV_PROBEID int Probe id
NIMV_ROBOTNAME string robotname

API

nimGetNameToIp(szName)

Look up a NimBUS address to find the IP address and port number to connect to, used together with nimSessionConnect or nimSession. Use nimNamedSession instead.

my($rc,$szIp,$iPort) =  nimGetNameToIp ($szName);

nimGetIpToName(szIp,szPort);

Transform nimbus ip and port into a nimbus addr.

my($rc,$szName) =  nimGetIpToName ($szIp,$iPort);

nimGetVarStr(constant)

Get the requested API value. Typically used for fetching the current hub, spooler or controller IP.

my ($rc,$domain) = nimGetVarStr(NIMV_HUBDOMAIN);
if($rc == NIME_OK) {
    print "$domain\n";
}

nimGetVarInt(constant)

Return the requested API value. E.g. what = NIMV_SPOOLPORT returns the local spooler port

my ($rc,$ip) = nimGetVarStr(NIMV_ROBOTIP);
if($rc == NIME_OK) {
    print "$ip\n";
}

nimSetVarInt(constant)

Set the named API variable. Typically used to change the default spooler port.

nimSetVarStr(constant)

Set a new API value. Typically used to change default spooler IP.