rauc_hawkbit.ddi package

Submodules

rauc_hawkbit.ddi.cancel_action module

class rauc_hawkbit.ddi.cancel_action.Action(ddi, action_id)

Bases: object

Represents /{tenant}/controller/v1/{targetid}/cancelAction/{actionId} in HawkBit’s DDI API.

feedback(status_execution, status_result, status_details=())

See http://sp.apps.bosch-iot-cloud.com/documentation/rest-api/rootcontroller-api-guide.html#_post_tenant_controller_v1_targetid_cancelaction_actionid_feedback # noqa

class rauc_hawkbit.ddi.cancel_action.CancelAction(ddi)

Bases: object

Represents /{tenant}/controller/v1/{targetid}/cancelAction in HawkBit’s DDI API.

class rauc_hawkbit.ddi.cancel_action.CancelStatusExecution

Bases: enum.Enum

An enumeration.

canceled = 3

closed = 1

proceeding = 2

rejected = 5

resumed = 6

scheduled = 4

rauc_hawkbit.ddi.cancel_action.CancelStatusResult

alias of rauc_hawkbit.ddi.cancel_action.CancelStatusResultFinished

rauc_hawkbit.ddi.client module

exception rauc_hawkbit.ddi.client.APIError

Bases: Exception

class rauc_hawkbit.ddi.client.ConfigStatusExecution

Bases: enum.Enum

An enumeration.

canceled = 3

closed = 1

proceeding = 2

rejected = 5

resumed = 6

scheduled = 4

rauc_hawkbit.ddi.client.ConfigStatusResult

alias of rauc_hawkbit.ddi.client.ConfigStatusResultFinished

class rauc_hawkbit.ddi.client.DDIClient(session, host, ssl, auth_token, tenant_id, controller_id, timeout=10)

Bases: object

Base Direct Device Integration API client providing GET, POST and PUT helpers as well as access to next level API resources.

build_api_url(api_path)

Build the actual API URL.

Parameters:api_path (str) – REST API path Returns:Expanded API URL with protocol (http/https) and host prepended

cancelAction

check_http_status(resp)

Log API error message.

configData(status_execution, status_result, action_id='', status_details=(), **kwdata)

Provide meta informtion during device registration at the update server.

See http://sp.apps.bosch-iot-cloud.com/documentation/rest-api/rootcontroller-api-guide.html#_put_tenant_controller_v1_targetid_configdata # noqa

Parameters:

• status_execution (ConfigStatusExecution) – status of the action execution
• status_result (status_result) – result of the action execution

Keyword Arguments:  

• action_id (str) – Id of the action, not mandator for configData
• status_details ((tuple, list)) – List of details to provide
• other – passed as custom configuration data (key/value)

deploymentBase

error_responses = {400: 'Bad Request - e.g. invalid parameters', 401: 'The request requires user authentication.', 403: 'Insufficient permissions or data volume restriction applies.', 404: 'Resource not available or device unknown.', 405: 'Method Not Allowed', 406: 'Accept header is specified and is not application/json.', 429: 'Too many requests.'}

get_binary(url, dl_location, mime='application/octet-stream', timeout=3600)

Actual download method with checksum checking.

Parameters:

• url (str) – URL of item to download
• dl_location (str) – storage path for downloaded artifact

Keyword Arguments:  

• mime – mimetype of content to retrieve (default: ‘application/octet-stream’)
• timeout – download timeout (default: 3600)

Returns:

MD5 hash of downloaded content

get_binary_resource(api_path, dl_location, mime='application/octet-stream', timeout=3600, **kwargs)

Helper method for binary HTTP GET API requests.

Triggers download of the retreived content to dl_location.

Parameters:

• api_path (str) – REST API path
• dl_location (str) – storage path for downloaded artifact

Keyword Arguments:  

• mime – mimetype of content to retrieve (default: ‘application/octet-stream’)
• kwargs – Other keyword args used for replacing items in the API path

Returns:

MD5 hash of downloaded content

get_resource(api_path, query_params={}, **kwargs)

Helper method for HTTP GET API requests.

Parameters:

api_path (str) – REST API path

Keyword Arguments:  

• query_params – Query parameters to add to the API URL
• kwargs – Other keyword args used for replacing items in the API path

Returns:

Response JSON data

post_resource(api_path, data, **kwargs)

Helper method for HTTP POST API requests.

Parameters:

• api_path (str) – REST API path
• data – JSON data for POST request

Keyword Arguments:  

kwargs – keyword args used for replacing items in the API path

put_resource(api_path, data, **kwargs)

Helper method for HTTP PUT API requests.

Parameters:

• api_path (str) – REST API path
• data – JSON data for POST request

Keyword Arguments:  

kwargs – keyword args used for replacing items in the API path

softwaremodules

rauc_hawkbit.ddi.deployment_base module

class rauc_hawkbit.ddi.deployment_base.DeploymentBase(ddi)

Bases: object

Represents /{tenant}/controller/v1/{targetid}/deploymentBase in HawkBit’s DDI API.

class rauc_hawkbit.ddi.deployment_base.DeploymentBaseAction(ddi, action_id)

Bases: object

Represents /{tenant}/controller/v1/{targetid}/deploymentBase/{actionId} in HawkBit’s DDI API. See http://sp.apps.bosch-iot-cloud.com/documentation/rest-api/rootcontroller-api-guide.html#_get_tenant_controller_v1_targetid_deploymentbase_actionid # noqa

feedback(status_execution, status_result, status_details=(), **kwstatus_result_progress)

See http://sp.apps.bosch-iot-cloud.com/documentation/rest-api/rootcontroller-api-guide.html#_post_tenant_controller_v1_targetid_deploymentbase_actionid_feedback # noqa

class rauc_hawkbit.ddi.deployment_base.DeploymentStatusExecution

Bases: enum.Enum

An enumeration.

canceled = 3

closed = 1

proceeding = 2

rejected = 5

resumed = 6

scheduled = 4

rauc_hawkbit.ddi.deployment_base.DeploymentStatusResult

alias of rauc_hawkbit.ddi.deployment_base.DeploymentStatusResultFinished

class rauc_hawkbit.ddi.deployment_base.DeploymentUpdate

Bases: enum.Enum

An enumeration.

attempt = 2

forced = 3

skip = 1

rauc_hawkbit.ddi.softwaremodules module

class rauc_hawkbit.ddi.softwaremodules.Artifacts(ddi, software_module_id)

Bases: object

Represents /{tenant}/controller/v1/{targetid}/softwaremodules/{softwareModuleId}/artifacts # noqa in HawkBit’s DDI API.

class rauc_hawkbit.ddi.softwaremodules.FileName(ddi, software_module_id, file_name)

Bases: object

Represents /{tenant}/controller/v1/{targetid}/softwaremodules/{softwareModuleId}/artifacts/{fileName} # noqa in HawkBit’s DDI API.

MD5SUM(md5_dl_location)

See http://sp.apps.bosch-iot-cloud.com/documentation/rest-api/rootcontroller-api-guide.html#_get_tenant_controller_v1_targetid_softwaremodules_softwaremoduleid_artifacts_filename_md5sum # noqa

class rauc_hawkbit.ddi.softwaremodules.SoftwareModule(ddi, software_module_id)

Bases: object

Represents /{tenant}/controller/v1/{targetid}/softwaremodules/{softwareModuleId} # noqa in HawkBit’s DDI API.

artifacts

class rauc_hawkbit.ddi.softwaremodules.SoftwareModules(ddi)

Bases: object

Represents /{tenant}/controller/v1/{targetid}/softwaremodules in HawkBit’s DDI API.