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

Classes

class  ShodanData
 
class  ShodanSensor
 

Functions

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

Variables

 _LOGGER = logging.getLogger(__name__)
 
string CONF_QUERY = "query"
 
string DEFAULT_NAME = "Shodan Sensor"
 
 PLATFORM_SCHEMA
 
 SCAN_INTERVAL = timedelta(minutes=15)
 

Detailed Description

Sensor for displaying the number of result on Shodan.io.

Function Documentation

◆ setup_platform()

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

Definition at line 38 of file sensor.py.

Variable Documentation

◆ _LOGGER

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

Definition at line 21 of file sensor.py.

◆ CONF_QUERY

string homeassistant.components.shodan.sensor.CONF_QUERY = "query"

Definition at line 23 of file sensor.py.

◆ DEFAULT_NAME

string homeassistant.components.shodan.sensor.DEFAULT_NAME = "Shodan Sensor"

Definition at line 25 of file sensor.py.

◆ PLATFORM_SCHEMA

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

Definition at line 29 of file sensor.py.

◆ SCAN_INTERVAL

homeassistant.components.shodan.sensor.SCAN_INTERVAL = timedelta(minutes=15)

Definition at line 27 of file sensor.py.