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

Classes

class  MinecraftServerSensorEntity
 
class  MinecraftServerSensorEntityDescription
 

Functions

None async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)
 
dict[str, list[str]] get_extra_state_attributes_players_list (MinecraftServerData data)
 

Variables

string ATTR_PLAYERS_LIST = "players_list"
 
string KEY_EDITION = "edition"
 
string KEY_GAME_MODE = "game_mode"
 
string KEY_MAP_NAME = "map_name"
 
string KEY_PLAYERS_MAX = "players_max"
 
string KEY_PLAYERS_ONLINE = "players_online"
 
string KEY_PROTOCOL_VERSION = "protocol_version"
 
string KEY_VERSION = "version"
 
list SENSOR_DESCRIPTIONS
 
string UNIT_PLAYERS_MAX = "players"
 
string UNIT_PLAYERS_ONLINE = "players"
 

Detailed Description

The Minecraft Server sensor platform.

Function Documentation

◆ async_setup_entry()

None homeassistant.components.minecraft_server.sensor.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  config_entry,
AddEntitiesCallback  async_add_entities 
)
Set up the Minecraft Server sensor platform.

Definition at line 159 of file sensor.py.

◆ get_extra_state_attributes_players_list()

dict[str, list[str]] homeassistant.components.minecraft_server.sensor.get_extra_state_attributes_players_list ( MinecraftServerData  data)
Return players list as extra state attributes, if available.

Definition at line 44 of file sensor.py.

Variable Documentation

◆ ATTR_PLAYERS_LIST

string homeassistant.components.minecraft_server.sensor.ATTR_PLAYERS_LIST = "players_list"

Definition at line 21 of file sensor.py.

◆ KEY_EDITION

string homeassistant.components.minecraft_server.sensor.KEY_EDITION = "edition"

Definition at line 23 of file sensor.py.

◆ KEY_GAME_MODE

string homeassistant.components.minecraft_server.sensor.KEY_GAME_MODE = "game_mode"

Definition at line 24 of file sensor.py.

◆ KEY_MAP_NAME

string homeassistant.components.minecraft_server.sensor.KEY_MAP_NAME = "map_name"

Definition at line 25 of file sensor.py.

◆ KEY_PLAYERS_MAX

string homeassistant.components.minecraft_server.sensor.KEY_PLAYERS_MAX = "players_max"

Definition at line 26 of file sensor.py.

◆ KEY_PLAYERS_ONLINE

string homeassistant.components.minecraft_server.sensor.KEY_PLAYERS_ONLINE = "players_online"

Definition at line 27 of file sensor.py.

◆ KEY_PROTOCOL_VERSION

string homeassistant.components.minecraft_server.sensor.KEY_PROTOCOL_VERSION = "protocol_version"

Definition at line 28 of file sensor.py.

◆ KEY_VERSION

string homeassistant.components.minecraft_server.sensor.KEY_VERSION = "version"

Definition at line 29 of file sensor.py.

◆ SENSOR_DESCRIPTIONS

list homeassistant.components.minecraft_server.sensor.SENSOR_DESCRIPTIONS

Definition at line 57 of file sensor.py.

◆ UNIT_PLAYERS_MAX

string homeassistant.components.minecraft_server.sensor.UNIT_PLAYERS_MAX = "players"

Definition at line 31 of file sensor.py.

◆ UNIT_PLAYERS_ONLINE

string homeassistant.components.minecraft_server.sensor.UNIT_PLAYERS_ONLINE = "players"

Definition at line 32 of file sensor.py.