API Documentation¶

class landroidcc.Landroid[source]¶

connect(username, password)[source]¶

Connect to the cloud with the given credentials.

Parameters:	username – Username for the cloud login password – Password for the login
Returns:	None

disconnect()[source]¶

Disconnects from the cloud

Returns:	None

get_status(refresh=True)[source]¶

Returns the last retrieved status from the mower. If refresh is True an update is requested from the mower and the call will block until an update is received.

Once connected the status will automatically updated once the mower sent an automatic update message. This happens every 2-15 minutes and for all state changes.

Parameters:	refresh – Force an update or only return the cached last status
Return type:	LandroidStatus
Returns:	The status of the mower.

go_home()[source]¶

Sent the mower the command to go home mowing

Returns:	None

pause()[source]¶

Sent the mower the command to pause mowing

Returns:	None

set_statuscallback(func)[source]¶

Sets a callback function which will be called for any status update from the mower:

def callback(status):
  # type: (LandroidStatus) -> None
  print (status)

landroid = Landroid()
landroid.connect("", "")
landroid.set_statuscallback(callback)

Parameters:	func – The callback
Returns:	None

start()[source]¶

Sent the mower the command to start mowing

Returns:	None

class landroidcc.LandroidStatus(inputraw)[source]¶

class BatteryStatus(percent, charges, volts, temperature, charging)¶

charges¶: Alias for field number 1

charging¶: Alias for field number 4

percent¶: Alias for field number 0

temperature¶: Alias for field number 3

volts¶: Alias for field number 2

class Orientation(heading, pitch, roll)¶

heading¶: Alias for field number 0

pitch¶: Alias for field number 1

roll¶: Alias for field number 2

class Statistics(distance, running, mowing)¶

distance¶: Alias for field number 0

mowing¶: Alias for field number 2

running¶: Alias for field number 1

get_battery()[source]¶

Returns:
Return type:	BatteryStatus

get_error()[source]¶

Returns the error as string. If there is no error, “No Error” is returned

Returns:	The error as text
Return type:	str

get_orientation()[source]¶

get_raw()[source]¶

Returns the status update as received directly from MQTT/mower.

Returns:	Raw status message
Return type:	dict

get_state()[source]¶

Returns the state as string

Returns:	The state as text
Return type:	str

get_statistics()[source]¶

get_updated()[source]¶