pyIndego 2.0.5

API for Bosch Indego mower

API for Bosch Indego lawnmowers

Join the Discord channel to discuss around this integration: https://discord.gg/aD33GsP

Usage with Home Assistant

For source files and version handling: https://github.com/jm-73/pyIndego

For PYPI package: https://pypi.org/project/pyIndego/

Basic information needed

Information	Description
your_username	Your username in the BoschSmartMove app
your_password	Your password for the app
your_serial	Your Bosch Indego serial (found on the mover, in the mover menu or in the app)

The python library is written for the login method with username (email address) and password. Login with Facebook account is not supported.

Call the API and the mower

Call the API:

IndegoApi_Instance = IndegoAPI(username='[e-mail]', password='your_password', serial='your_serial')

get-functions

Description for the functions updating data from API and mower. The functions collecting data from only Bosch API does not wake up mower. Functions collecting data from both Bosch API and mower does wake up mower from sleeping.

API Call	Bosch API	Mower	Mower needs to be online
getAlerts	X
getConfig	X
getForcedState		X	?
getGenericData	X
getLastComletedMow	X
getLongpollState	?	?	?
getNetwork	X
getNextMow
getOperatingData		X	X
getPredictiveSetup	X
getState	X
getUpdates		X	X
getUsers	X
login	X

List of get-functions

getAlerts()

Collect alerts.

Response:
{
    'alm_sn': '123456789', 
    'alert_id': '5d48171263c5345a75dbc017', 
    'error_code': 'ntfy_blade_life', 
    'headline': 'Underhållstips.', 
    'date': '2019-08-05T11:46:26.397Z', 
    'message': 'Kontrollera klippknivarna. Indego har klippt i 100 timmar. Ska den fungera optimalt, kontrollera klippknivarna så att de är i bra skick. Du kan beställa nya knivar via avsnittet Tillbehör.', 
    'read_status': 'unread', 
    'flag': 'warning', 
    'push': True
}

getConfig()

Collects the configuration of the mower.

Response:
{
    'region': 0,
    'language': 1,
    'border_cut': 0,
    'is_pin_set': True,
    'wire_id': 4,
    'bump_sensitivity': 0,
    'alarm_mode': True
}

getForcedState()

Collects state of mower, % lawn mowed, position, runtime, map coordinates. Compared to the getState() command, it forces the server to update all information - including the position of the mower.

Response:
--> same as getState()

getGenericData()

Collect serial, service counter, name, mowing mode, model number and firmware.

Response:
{
    'alm_sn': '123456789', 
    'alm_name': 'Indego', 
    'service_counter': 60488, 
    'needs_service': False, 
    'alm_mode': 'manual', 
    'bareToolnumber': '3600HA2300', 
    'alm_firmware_version': '00837.01043'
}

getLastCompletedMow()

Collects data on the last completed mow. .

Response:
{
    'last_mowed': '2020-05-25T10:00:00+02:00'
}

getLocation()

Collect location of the garden/mower.

Response:
{
    'latitude': '59.742950', 
    'longitude': '17.380440', 
    'timezone': 'Europe/Berlin'
}

getLongpollState(timeout)

Function getState must have been called before using this call. It sends a state value to the server and then waits for the timeout to see if there are an updated state value. The server attempts to "hold open" (not immediately reply to) each HTTP request, responding only when there are events to deliver or the timeout (in seconds) is due.

This function can be used instead of polling the status every couple of seconds: place one longpoll status request with a timeout of max. 300 seconds and the function will provide its return value when the status has been updated. As soon as an answer is received, the next longpoll status request can be placed. This should save traffic on both ends.

Response:
--> same as getState(), but might also include less information
--> if the status is not updated until the timeout, the return is empty
--> functions reading data from locally cached API data will provide the latest availabe data

getNetwork()

Collects data on the mobile network the Indego is connected to.

Response:
{
    'mcc': 262,
    'mnc': 2,
    'rssi': -76,
    'currMode': 's',
    'configMode': 's',
    'steeredRssi': -100,
    'networkCount': 3,
    'networks': [26201, 26202, 26203]
}

getNextMow()

Collects data on next mow. Returns none if mower is set to manual mode.

Response:
{
    'mow_next': '2020-05-25T10:00:00+02:00'
}

getOperatingData()

Collect operational data data: battery, runtime, garden data and temperature.

Response:
{
    'runtime': {
        'total': {
            'operate': 86333, 
            'charge': 25845
        }, 
        'session': {
            'operate': 0, 
            'charge': 0
        }
    }, 
    'battery': {
        'voltage': 33.5, 
        'cycles': 1, 
        'discharge': 0.0, 
        'ambient_temp': 17, 
        'battery_temp': 17, 
        'percent': 335
    }, 
    'garden': {
        'id': 7, 
        'name': 1, 
        'signal_id': 1, 
        'size': 625, 
        'inner_bounds': 3, 
        'cuts': 26, 
        'runtime': 82197, 
        'charge': 24860, 
        'bumps': 4650, 
        'stops': 24, 
        'last_mow': 4
    }, 
    'hmiKeys': 1344
}

getPredictiveSetup()

Response:
{
    'garden_size': 93,
    'mowing_duration': 3,
    'rain_factor': 1.4,
    'temperature_factor': 1.1,
    'garden_location': {
        'latitude': '48.7357',
        'longitude': '8.9505',
        'timezone': 'Europe/Berlin'
    },
    'full_cuts': 3,
    'avoid_rain': True,
    'avoid_temperature': True,
    'use_grass_growth': True,
    'no_mow_calendar_days': [
        {
            'day': 0,
            'slots': [
                {
                    'En': True,
                    'StHr': 0,
                    'StMin': 0,
                    'EnHr': 8,
                    'EnMin': 0
                },
                {
                    'En': True,
                    'StHr': 20,
                    'StMin': 0,
                    'EnHr': 23,
                    'EnMin': 59
                }
            ]
        },
        ...
        {
            'day': 6,
            'slots': [
                {
                    'En': True,
                    'StHr': 0,
                    'StMin': 0,
                    'EnHr': 23,
                    'EnMin': 59
                }
            ]
        }
    ]
}

getState()

Collects state of mower, % lawn mowed, position, runtime, map coordinates.

Response:
{
    'state': 64513, 
    'map_update_available': True, 
    'mowed': 95, 
    'mowmode': 0, 
    'xPos': 68, 
    'yPos': 30, 
    'runtime': {
        'total': {
            'operate': 86327, 
            'charge': 25845
            }, 
        'session': {
            'operate': 4, 
            'charge': 0
            }
        }, 
    'mapsvgcache_ts': 1565381013023, 
    'svg_xPos': 928, 
    'svg_yPos': 264
}

getUpdates()

Check if there are any updates apllicable to the mower.

Response:
{
     'available': False
}

getUsers()

Collect user data.

Response:
{
    'email': '[e-mail]', 
    'display_name': 'Indego', 
    'language': 'sv', 
    'country': 'GB', 
    'optIn': True, 
    'optInApp': True
}

Sending commands

putCommand(command)

Send commands.

Command	Description
putCommand('mow')	Start mowing
putCommand('pause')	Pause mower
putCommand('returnToDock')	Return mower to dock

putMowMode(command)

Send command. Accepted commands:

Command	Description
putMowMode('true')	Smart Mow enabled
putMowMode('false')	Smart Mow disabled

Functions for reading data from locally cached API data

All functions that doesnt contain "get" first in name is collecting data from locally stored variables in the function. No API calls to Bosch or mower.

function	Description
AlertsCount()	Show counts of the current alerts.
AlertsDescription()	Show detailed list of alerts.
AlmFirmwareVersion()	Show firmware version.
AlmMode()	Show mow mode.
AlmName()	Show name.
BareToolNumber()	Show the model number.
Battery()	Show battery information.
BatteryAmbientTemp()	Show the ambient temp of the battery.
BatteryCycles()	Dont know what this value is?
BatteryDischarge()	Show the current drawn in Ah.
BatteryPercent()	Show the raw value for percentage left. For Gen 1 this seems to be the battery voltage. For Gen 2 it seems to be the actual percentage left in the battery.
BatteryPercentAdjusted()	Show the adjusted value for percentage left. Calculated for Gen 1, and the actual percentage value for Gen 2.
BatteryTemp()	Show temp of the battery.
BatteryVoltage()	Show voltage for the battery. For Gen 1 mowers this value seems to be correct. For Gen 2 it seems to be the same value as the percentage left in battery.
ConvertBoschDateTime()	Convert Bosch abbreviation for time to std 24h time
Country()	Show country for the account.
Displayname()	Show name for the account.
Email()	Show email adress for the account.
FirmwareAvailable()	Show if there are any firmware updates available.
FriendlyAlertErrorCode()	Show user friendly alert error code description to be shown in HA GUI.
Garden()	Dont know what this is?
HmiKeysn()	Dont know what this is?
Language()	Show language for the account.
MapSvgCacheTs()	Dont know what this is...
MapUpdateAvailable()	Show if there is an update of the map image.
ModelDescription()	Show user friendly model name.
ModelVoltage()	Show the predefined voltage limits in order to calculate battery percentage.
ModelVoltageMax()	Show the maximum predefined voltage limits in order to calculate battery percentage.
ModelVoltageMin()	Show the minimum predefined voltage limits in order to calculate battery percentage.
MowMode()	Show mow mode
Mowed()	Show percentage of lawn mowed
MowerState()	Show current state
MowerStateDescription()	Show simple description of current state. States available are Docked, Mowing, Stuck, Diagnostics mode, End of life, Software update.
MowerStateDescriptionDetailed()	Show description in detail of current state.
MowingModeDescription()	Show the user friendly mow mode description.
NeedsService()	Show needs service flag. Dont know when it is used.
NextMow()	Show next planned mow session.
OptIn()	Dont know what this are for?
OptInApp()	Dont know what this are for?
Runtime()	Show session and total rutime and charge time in minutes.
RuntimeSession()	show session runtime and charge time in minutes
RuntimeTotal()	Show total runtime and charge time in hours
Serial()	Show serial number
ServiceCounter()	Show service counter for knives
SvgxPos()	Show svg x-position of mower.
SvgyPos()	Show svg y-position of mower.
XPos()	Show x-position of mower.
YPos()	Show y-position of mower.

Not working

Not properly implemented yet

getPredicitiveCalendar()

Get the calender for predicted mow sessions

getUserAdjustment()

Get the user adjustment of the mowing frequency

getCalendar()

Get the calendar for allowed mowing times

getSecurity()

Get the security settings

getAutomaticUpdate()

Get the automatic update settings

API CALLS

https://api.indego.iot.bosch-si.com:443/api/v1

post
/authenticate

get
/alerts
/alms/<serial>
/alms/<serial>/automaticUpdate
/alms/<serial>/calendar
/alms/<serial>/config
/alms/<serial>/map
/alms/<serial>/network
/alms/<serial>/updates
/alms/<serial>/operatingData
/alms/<serial>/predictive
/alms/<serial>/predictive/calendar
/alms/<serial>/predictive/lastcutting
/alms/<serial>/predictive/location
/alms/<serial>/predictive/nextcutting
/alms/<serial>/predictive/useradjustment
/alms/<serial>/predictive/weather
/alms/<serial>/security
/alms/<serial>/state
/users/<userid>

put
/alms/<serial>/automaticUpdate
/alms/<serial>/predictive/calendar
/alms/<serial>/predictive/location
/alms/<serial>/predictive
/alms/<serial>/state
/alms/<serial>/predictive/useradjustment

delete
/alerts/<alertid>