Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.gitter.sensor Namespace Reference

Classes

class  GitterSensor
 

Functions

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

Variables

 _LOGGER = logging.getLogger(__name__)
 
string ATTR_MENTION = "mention"
 
string ATTR_ROOM = "room"
 
string ATTR_USERNAME = "username"
 
string DEFAULT_NAME = "Gitter messages"
 
string DEFAULT_ROOM = "home-assistant/home-assistant"
 
 PLATFORM_SCHEMA
 

Detailed Description

Support for displaying details about a Gitter.im chat room.

Function Documentation

◆ setup_platform()

None homeassistant.components.gitter.sensor.setup_platform ( HomeAssistant  hass,
ConfigType  config,
AddEntitiesCallback  add_entities,
DiscoveryInfoType | None   discovery_info = None 
)
Set up the Gitter sensor.

Definition at line 40 of file sensor.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.gitter.sensor._LOGGER = logging.getLogger(__name__)
private

Definition at line 21 of file sensor.py.

◆ ATTR_MENTION

string homeassistant.components.gitter.sensor.ATTR_MENTION = "mention"

Definition at line 23 of file sensor.py.

◆ ATTR_ROOM

string homeassistant.components.gitter.sensor.ATTR_ROOM = "room"

Definition at line 24 of file sensor.py.

◆ ATTR_USERNAME

string homeassistant.components.gitter.sensor.ATTR_USERNAME = "username"

Definition at line 25 of file sensor.py.

◆ DEFAULT_NAME

string homeassistant.components.gitter.sensor.DEFAULT_NAME = "Gitter messages"

Definition at line 27 of file sensor.py.

◆ DEFAULT_ROOM

string homeassistant.components.gitter.sensor.DEFAULT_ROOM = "home-assistant/home-assistant"

Definition at line 28 of file sensor.py.

◆ PLATFORM_SCHEMA

homeassistant.components.gitter.sensor.PLATFORM_SCHEMA
Initial value:
1 = SENSOR_PLATFORM_SCHEMA.extend(
2  {
3  vol.Required(CONF_API_KEY): cv.string,
4  vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
5  vol.Optional(CONF_ROOM, default=DEFAULT_ROOM): cv.string,
6  }
7 )

Definition at line 31 of file sensor.py.