pybragerone.api.endpoints

API endpoint URL builders for BragerOne REST client.

This module contains functions that build properly formatted URLs for various BragerOne API endpoints, including authentication, user management, objects, and modules. All URLs are URL-encoded for safety.

Functions

auth_revoke_url(*[, api_base])

Get URL for token revocation endpoint.

auth_user_url(*[, api_base])

Get URL for user authentication endpoint.

module_card_url(module_id, *[, api_base])

Get URL for module card data endpoint.

module_command_raw_url(*[, api_base])

Get URL for raw module command endpoint.

module_command_url(*[, api_base])

Get URL for module command endpoint.

module_url(module_id, *[, api_base])

Get URL for specific module endpoint.

modules_activity_quantity_url(*[, api_base])

Get URL for modules activity quantity endpoint.

modules_connect_url(*[, api_base])

Get URL for modules connection endpoint.

modules_parameters_url(*[, api_base])

Get URL for all modules parameters endpoint.

modules_url(object_id[, page, limit, api_base])

Get URL for modules collection endpoint with pagination.

object_permissions_url(object_id, *[, api_base])

Get URL for object permissions endpoint.

object_url(object_id, *[, api_base])

Get URL for specific object endpoint.

objects_url(*[, api_base])

Get URL for objects collection endpoint.

system_version_url(*[, api_base, container, ...])

Get URL for system version endpoint.

user_permissions_url(*[, api_base])

Get URL for user permissions endpoint.

user_url(*[, api_base])

Get URL for user info endpoint.
pybragerone.api.endpoints.auth_revoke_url(*, api_base: str = 'https://io.brager.pl/v1')[source]

Get URL for token revocation endpoint.

Returns:

str – URL for POST requests to revoke authentication token.

Parameters:

api_base (str)

Return type:

str

pybragerone.api.endpoints.auth_user_url(*, api_base: str = 'https://io.brager.pl/v1')[source]

Get URL for user authentication endpoint.

Returns:

str – URL for POST requests to authenticate a user.

Parameters:

api_base (str)

Return type:

str

pybragerone.api.endpoints.module_card_url(module_id: str, *, api_base: str = 'https://io.brager.pl/v1')[source]

Get URL for module card data endpoint.

Parameters:

  • module_id (str) – The ID of the module.

  • api_base (str) – Base URL for the REST API.

Returns:

str – URL for GET requests to fetch module card/dashboard data.

Return type:

str

pybragerone.api.endpoints.module_command_raw_url(*, api_base: str = 'https://io.brager.pl/v1')[source]

Get URL for raw module command endpoint.

Returns:

str – URL for POST requests to dispatch symbolic commands to module firmware.

Parameters:

api_base (str)

Return type:

str

pybragerone.api.endpoints.module_command_url(*, api_base: str = 'https://io.brager.pl/v1')[source]

Get URL for module command endpoint.

Returns:

str – URL for POST requests to write parameter-like command payloads.

Parameters:

api_base (str)

Return type:

str

pybragerone.api.endpoints.module_url(module_id: str, *, api_base: str = 'https://io.brager.pl/v1')[source]

Get URL for specific module endpoint.

Parameters:

  • module_id (str) – The ID of the module.

  • api_base (str) – Base URL for the REST API.

Returns:

str – URL for GET/POST requests to fetch or modify specific module.

Return type:

str

pybragerone.api.endpoints.modules_activity_quantity_url(*, api_base: str = 'https://io.brager.pl/v1')[source]

Get URL for modules activity quantity endpoint.

Returns:

str – URL for GET requests to fetch activity quantity statistics.

Parameters:

api_base (str)

Return type:

str

pybragerone.api.endpoints.modules_connect_url(*, api_base: str = 'https://io.brager.pl/v1')[source]

Get URL for modules connection endpoint.

Returns:

str – URL for WebSocket connection to modules.

Parameters:

api_base (str)

Return type:

str

pybragerone.api.endpoints.modules_parameters_url(*, api_base: str = 'https://io.brager.pl/v1')[source]

Get URL for all modules parameters endpoint.

Returns:

str – URL for GET requests to fetch parameters for all modules.

Parameters:

api_base (str)

Return type:

str

pybragerone.api.endpoints.modules_url(object_id: int, page: int = 1, limit: int = 999, *, api_base: str = 'https://io.brager.pl/v1')[source]

Get URL for modules collection endpoint with pagination.

Parameters:

  • object_id (int) – The ID of the object/group to get modules for.

  • page (int) – Page number for pagination (default: 1).

  • limit (int) – Number of items per page (default: 999).

  • api_base (str) – Base URL for the REST API.

Returns:

str – URL for GET requests to fetch modules with query parameters.

Return type:

str

pybragerone.api.endpoints.object_permissions_url(object_id: int, *, api_base: str = 'https://io.brager.pl/v1')[source]

Get URL for object permissions endpoint.

Parameters:

  • object_id (int) – The ID of the object/group.

  • api_base (str) – Base URL for the REST API.

Returns:

str – URL for GET requests to fetch permissions for specific object.

Return type:

str

pybragerone.api.endpoints.object_url(object_id: int, *, api_base: str = 'https://io.brager.pl/v1')[source]

Get URL for specific object endpoint.

Parameters:

  • object_id (int) – The ID of the object/group.

  • api_base (str) – Base URL for the REST API.

Returns:

str – URL for GET/POST requests to fetch or modify specific object.

Return type:

str

pybragerone.api.endpoints.objects_url(*, api_base: str = 'https://io.brager.pl/v1')[source]

Get URL for objects collection endpoint.

Returns:

str – URL for GET requests to fetch all objects/groups.

Parameters:

api_base (str)

Return type:

str

pybragerone.api.endpoints.system_version_url(*, api_base: str = 'https://io.brager.pl/v1', container: str = 'BragerOne', platform: int = 0)[source]

Get URL for system version endpoint.

Parameters:

  • api_base (str) – Base URL for the REST API.

  • container (str) – The container name (default: “BragerOne”).

  • platform (int) – The platform identifier (default: 0).

Returns:

str – URL for GET requests to fetch system version information.

Return type:

str

pybragerone.api.endpoints.user_permissions_url(*, api_base: str = 'https://io.brager.pl/v1')[source]

Get URL for user permissions endpoint.

Returns:

str – URL for GET requests to fetch current user’s permissions.

Parameters:

api_base (str)

Return type:

str

pybragerone.api.endpoints.user_url(*, api_base: str = 'https://io.brager.pl/v1')[source]

Get URL for user info endpoint.

Returns:

str – URL for GET requests to fetch current user information.

Parameters:

api_base (str)

Return type:

str