active_user module

class active_user.User(user: str)

Bases: object

[This class is dedicated to the user standing in from of the camera]

get_user(user: str)

[Method that returns the name of the user in front of the camera

  • user == stranger if the user is not registered

  • user == name the user registered with]

Parameters

user (str) – [The user standing in front of the camera]

Returns

[the name of the user –> ‘stranger’ or the name the user registered with]

Return type

str

is_user_registered()

[Method that returns TRUE if the user in front of the camera is registered on the device, or FALSE if the user is not registered on the device]

Returns

  • True -> the user is registered on the device

  • False -> the user is not registered on the device

Return type

[bool]

user_has_SOS_contact()

[The method returns TRUE if the user in question has created an SOS contact]

Returns

  • True -> an SOS contact exists for the user in front of the camera

  • False -> an SOS contact does not exist for the user in front of the camera

Return type

[bool]