Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.sigfox.sensor.SigfoxAPI Class Reference

Public Member Functions

def __init__ (self, api_login, api_password)
 
def auth (self)
 
def check_credentials (self)
 
def devices (self)
 
def get_device_types (self)
 
def get_devices (self, device_types)
 

Private Attributes

 _auth
 
 _devices
 

Detailed Description

Class for interacting with the SigFox API.

Definition at line 66 of file sensor.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.sigfox.sensor.SigfoxAPI.__init__ (   self,
  api_login,
  api_password 
)
Initialise the API object.

Definition at line 69 of file sensor.py.

Member Function Documentation

◆ auth()

def homeassistant.components.sigfox.sensor.SigfoxAPI.auth (   self)
Return the API authentication.

Definition at line 109 of file sensor.py.

◆ check_credentials()

def homeassistant.components.sigfox.sensor.SigfoxAPI.check_credentials (   self)
Check API credentials are valid.

Definition at line 76 of file sensor.py.

◆ devices()

def homeassistant.components.sigfox.sensor.SigfoxAPI.devices (   self)
Return the list of device_id.

Definition at line 114 of file sensor.py.

◆ get_device_types()

def homeassistant.components.sigfox.sensor.SigfoxAPI.get_device_types (   self)
Get a list of device types.

Definition at line 91 of file sensor.py.

◆ get_devices()

def homeassistant.components.sigfox.sensor.SigfoxAPI.get_devices (   self,
  device_types 
)
Get the device_id of each device registered.

Definition at line 97 of file sensor.py.

Member Data Documentation

◆ _auth

homeassistant.components.sigfox.sensor.SigfoxAPI._auth
private

Definition at line 71 of file sensor.py.

◆ _devices

homeassistant.components.sigfox.sensor.SigfoxAPI._devices
private

Definition at line 74 of file sensor.py.


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