Skip to content

Latest commit

 

History

History
93 lines (57 loc) · 2.89 KB

client_core.md

File metadata and controls

93 lines (57 loc) · 2.89 KB

Module drone.modules.client_core

Is a client-side module (meant to be run on Python 2.7) containing base Client class, utility functions and basic callbacks declarations. Main focus of the module is client-specific communication without reliance on clover Raspberry Pi environment.

Module functions

Class Client

Client base class provides config loading, communication with server (including automatic reconnection, broadcast listening and binding). You can inherit this class in order to extend functionality for practical applications.

Attributes:

server_connection (ConnectionManager) - connection to the server.

connected (bool) - whether the client is connected to the server.

client_id (string) - ID of the client.

config (ConfigManager) - contains loaded client configuration.

config_path (string) -  path to configuration file. There also should be config specification file at 'config_path\config\configspec_client.ini'.

__init__

def __init__(self, config_path='C:\\Users\\artem\\Documents\\GitHub\\COEX-clever-swarm\\clever-show\\drone\\modules\\..\\config\\client.ini')

Initializtion

client = Client(config_path)

Args:

config_path (string, optional): Path to the file with configuration.  There also should be config specification file at `<config_path>\config\configspec_client.ini`. Defaults to `<current_dir>\os.pardir\config\client.ini`.

broadcast_bind

def broadcast_bind(self, timeout=2.0, attempt_limit=3)

get_ntp_time

def get_ntp_time(ntp_host, ntp_port)

Gets and returns time from specified host and port of NTP server.

Args:

ntp_host (string): hostname or address of the NTP server.

ntp_port (int): port of the NTP server.

Returns:

int: Current time recieved from the NTP server

load_config

def load_config(self)

Loads or reloads config from file specified in 'config_path' attribute.

on_broadcast_bind

def on_broadcast_bind(self)

Method called on binding to the server by broadcast. Override that method in order to add functionality.

start

def start(self)

Reloads config and starts infinite loop of connecting to the server and processing said connection. Calling of this method will indefinitely halt execution of any subsequent code.

time_now

def time_now(self)

gets and returns system time or NTP time depending on the config.

Returns:

int: Current time.