Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.ping.helpers.PingDataSubProcess Class Reference
Inheritance diagram for homeassistant.components.ping.helpers.PingDataSubProcess:
[legend]
Collaboration diagram for homeassistant.components.ping.helpers.PingDataSubProcess:
[legend]

Public Member Functions

None __init__ (self, HomeAssistant hass, str host, int count, bool|None privileged)
 
dict[str, Any]|None async_ping (self)
 
None async_update (self)
 
- Public Member Functions inherited from homeassistant.components.ping.helpers.PingData
None __init__ (self, HomeAssistant hass, str host, int count)
 

Public Attributes

 data
 
 is_alive
 
- Public Attributes inherited from homeassistant.components.ping.helpers.PingData
 hass
 
 ip_address
 

Private Attributes

 _ping_cmd
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.components.ping.helpers.PingData
 bool
 
 None
 

Detailed Description

The Class for handling the data retrieval using the ping binary.

Definition at line 85 of file helpers.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.ping.helpers.PingDataSubProcess.__init__ (   self,
HomeAssistant  hass,
str  host,
int  count,
bool | None   privileged 
)
Initialize the data object.

Definition at line 88 of file helpers.py.

Member Function Documentation

◆ async_ping()

dict[str, Any] | None homeassistant.components.ping.helpers.PingDataSubProcess.async_ping (   self)
Send ICMP echo request and return details if success.

Definition at line 103 of file helpers.py.

◆ async_update()

None homeassistant.components.ping.helpers.PingDataSubProcess.async_update (   self)
Retrieve the latest details from the host.

Definition at line 173 of file helpers.py.

Member Data Documentation

◆ _ping_cmd

homeassistant.components.ping.helpers.PingDataSubProcess._ping_cmd
private

Definition at line 93 of file helpers.py.

◆ data

homeassistant.components.ping.helpers.PingDataSubProcess.data

Definition at line 175 of file helpers.py.

◆ is_alive

homeassistant.components.ping.helpers.PingDataSubProcess.is_alive

Definition at line 176 of file helpers.py.


The documentation for this class was generated from the following file: