HomeInterfacesRecipesChangelogFAQ
Log In
Interfaces

Get System State

Endpoint

BIN_INTERFACE_API_ENDPOINT

Request parameters

None

Request example

//Interface installation location(Ip adress)
string ip = "127.0.0.1";
//The URL to the bin interface
string url = "http://" + ip + ":44000/api/v2/bin";
//XML that will be POST'ed
string xmlData = string.Format(
@"<?xml version=""1.0""?>
<methodcall>
  <name>getsystemstate</name>
</methodcall>");
//POST to interface
HttpResponseMessage response = await new HttpClient().PostAsync(url, new StringContent(xmlData,
        Encoding.UTF8, "application/xml"));
string responseString = await response.Content.ReadAsStringAsync();
Console.WriteLine(responseString);
# Interface installation location (IP address)
ip = "127.0.0.1"
# The URL to the task interface
url = f"http://{ip}:44000/api/v2/bin"
# XML that will be POST'ed
xmlData ="""<?xml version="1.0"?>
<methodcall>
  <name>getsystemstate</name>
</methodcall>"""
# POST to interface
response = requests.post(url, data=xmlData.encode('utf-8'), headers={"Content-Type": "application/xml"})
print(response.text)
const ip = "127.0.0.1";
const url = `http://${ip}:44000/api/v2/bin`;
const xmlData = 
`<?xml version="1.0"?>
<methodcall>
  <name>getsystemstate</name>
</methodcall>`;

fetch(url, {
    method: 'POST',
    body: xmlData,
    headers: {
        'Content-Type': 'application/xml'
    }
})
    .then(response => response.text())
    .then(responseString => console.log(responseString));
<?xml version="1.0"?>
<methodcall>
  <name>getsystemstate</name>
</methodcall>
{
    "method": "getsystemstate"
}

Response parameters

ParameterData typeDescription
modeIntegerThe current mode of the system.
Mode Description
10 Connecting
12 Starting
20 Running
30 Service
35 Alert
60 Stopping
70 Stopped
stopcodeIntegerA stop code that could provide information about why the system stopped.
chargepercentIntegerThe currently set percentage of robots that should be forced to charge batteries.

Response example

<?xml version="1.0"?>
<response>
  <params>
    <mode>20</mode>
    <stopcode>0</stopcode>
    <chargepercent>50</chargepercent>
  </params>
</response>

OR

<?xml version="1.0"?>
<response>
  <fault>
    <code>1000</code>
  </fault>
</response>

Error Codes

None

Software version requirement

Software Release October 2022 and newer