Classes
class	GitLabData

class	GitLabSensor

Functions
None	setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback add_entities, DiscoveryInfoType\|None discovery_info=None)

Variables
	_LOGGER = logging.getLogger(__name__)

string	ATTR_BUILD_BRANCH = "build branch"

string	ATTR_BUILD_COMMIT_DATE = "commit date"

string	ATTR_BUILD_COMMIT_ID = "commit id"

string	ATTR_BUILD_DURATION = "build_duration"

string	ATTR_BUILD_FINISHED = "build_finished"

string	ATTR_BUILD_ID = "build id"

string	ATTR_BUILD_STARTED = "build_started"

string	ATTR_BUILD_STATUS = "build_status"

string	ATTRIBUTION = "Information provided by https://gitlab.com/"

string	CONF_GITLAB_ID = "gitlab_id"

string	DEFAULT_NAME = "GitLab CI Status"

string	DEFAULT_URL = "https://gitlab.com"

string	ICON_HAPPY = "mdi:emoticon-happy"

string	ICON_OTHER = "mdi:git"

string	ICON_SAD = "mdi:emoticon-sad"

	PLATFORM_SCHEMA

	SCAN_INTERVAL = timedelta(seconds=300)

Detailed Description

Sensor for retrieving latest GitLab CI job information.

Function Documentation

◆ setup_platform()

None homeassistant.components.gitlab_ci.sensor.setup_platform	(	HomeAssistant	hass,
		ConfigType	config,
		AddEntitiesCallback	add_entities,
		DiscoveryInfoType \| None	discovery_info = `None`
	)

Set up the GitLab sensor platform.

Definition at line 55 of file sensor.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.gitlab_ci.sensor._LOGGER = logging.getLogger(__name__)

private

Definition at line 22 of file sensor.py.

◆ ATTR_BUILD_BRANCH

string homeassistant.components.gitlab_ci.sensor.ATTR_BUILD_BRANCH = "build branch"

Definition at line 24 of file sensor.py.

◆ ATTR_BUILD_COMMIT_DATE

string homeassistant.components.gitlab_ci.sensor.ATTR_BUILD_COMMIT_DATE = "commit date"

Definition at line 25 of file sensor.py.

◆ ATTR_BUILD_COMMIT_ID

string homeassistant.components.gitlab_ci.sensor.ATTR_BUILD_COMMIT_ID = "commit id"

Definition at line 26 of file sensor.py.

◆ ATTR_BUILD_DURATION

string homeassistant.components.gitlab_ci.sensor.ATTR_BUILD_DURATION = "build_duration"

Definition at line 27 of file sensor.py.

◆ ATTR_BUILD_FINISHED

string homeassistant.components.gitlab_ci.sensor.ATTR_BUILD_FINISHED = "build_finished"

Definition at line 28 of file sensor.py.

◆ ATTR_BUILD_ID

string homeassistant.components.gitlab_ci.sensor.ATTR_BUILD_ID = "build id"

Definition at line 29 of file sensor.py.

◆ ATTR_BUILD_STARTED

string homeassistant.components.gitlab_ci.sensor.ATTR_BUILD_STARTED = "build_started"

Definition at line 30 of file sensor.py.

◆ ATTR_BUILD_STATUS

string homeassistant.components.gitlab_ci.sensor.ATTR_BUILD_STATUS = "build_status"

Definition at line 31 of file sensor.py.

◆ ATTRIBUTION

string homeassistant.components.gitlab_ci.sensor.ATTRIBUTION = "Information provided by https://gitlab.com/"

Definition at line 32 of file sensor.py.

◆ CONF_GITLAB_ID

string homeassistant.components.gitlab_ci.sensor.CONF_GITLAB_ID = "gitlab_id"

Definition at line 34 of file sensor.py.

◆ DEFAULT_NAME

string homeassistant.components.gitlab_ci.sensor.DEFAULT_NAME = "GitLab CI Status"

Definition at line 36 of file sensor.py.

◆ DEFAULT_URL

string homeassistant.components.gitlab_ci.sensor.DEFAULT_URL = "https://gitlab.com"

Definition at line 37 of file sensor.py.

◆ ICON_HAPPY

string homeassistant.components.gitlab_ci.sensor.ICON_HAPPY = "mdi:emoticon-happy"

Definition at line 39 of file sensor.py.

◆ ICON_OTHER

string homeassistant.components.gitlab_ci.sensor.ICON_OTHER = "mdi:git"

Definition at line 40 of file sensor.py.

◆ ICON_SAD

string homeassistant.components.gitlab_ci.sensor.ICON_SAD = "mdi:emoticon-sad"

Definition at line 41 of file sensor.py.

◆ PLATFORM_SCHEMA

homeassistant.components.gitlab_ci.sensor.PLATFORM_SCHEMA

Initial value:

 =  SENSOR_PLATFORM_SCHEMA.extend(
     {
         vol.Required(CONF_GITLAB_ID): cv.string,
         vol.Required(CONF_TOKEN): cv.string,
         vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
         vol.Optional(CONF_URL, default=DEFAULT_URL): cv.string,
     }
 )

Definition at line 45 of file sensor.py.

◆ SCAN_INTERVAL

homeassistant.components.gitlab_ci.sensor.SCAN_INTERVAL = timedelta(seconds=300)

Definition at line 43 of file sensor.py.

Home Assistant Unofficial Reference 2024.12.1

Classes

Functions

Variables