mycroft.api Namespace Reference

Classes
class	Api
class	BackendDown
class	DeviceApi
class	InternetDown
class	STTApi

Functions
def	has_been_paired ()
def	is_paired (ignore_errors=True)

Variables
bool	_paired_cache = False

Function Documentation

def mycroft.api.has_been_paired

(

)

Determine if this device has ever been paired with a web backend

Returns:
    bool: True if ever paired with backend (not factory reset)

Definition at line 472 of file scripts/mycroft/api/__init__.py.

def mycroft.api.is_paired

(

ignore_errors = True

)

Determine if this device is actively paired with a web backend

Determines if the installation of Mycroft has been paired by the user
with the backend system, and if that pairing is still active.

Returns:
    bool: True if paired with backend

Definition at line 484 of file scripts/mycroft/api/__init__.py.

Variable Documentation

bool mycroft.api._paired_cache = False

private

Definition at line 32 of file scripts/mycroft/api/__init__.py.