From 2794e882cfc55f003f978e5a07ef464b31cad24e Mon Sep 17 00:00:00 2001 From: Philip Basford Date: Thu, 17 May 2018 14:03:29 +0100 Subject: [PATCH] A bit more documentation --- pistack/__init__.py | 4 +++- pistack/comms.py | 6 ++++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/pistack/__init__.py b/pistack/__init__.py index 0e04e14..676f5b5 100644 --- a/pistack/__init__.py +++ b/pistack/__init__.py @@ -1,3 +1,5 @@ # -*- coding: utf-8 -*- - +""" + Interface to control the Pi Stack boards +""" from pistack import * diff --git a/pistack/comms.py b/pistack/comms.py index e38786e..8f00da9 100644 --- a/pistack/comms.py +++ b/pistack/comms.py @@ -27,6 +27,12 @@ class Comms(object): Handle all comms over the serial link """ def __init__(self, port_name, baud=_DEFAULT_BAUD, timeout=_DEFAULT_TIMEOUT): + """ + Create the interface for the Pi Stack boards + :param port_name: The serial port to use + :param baud: OPTIONAL: The baud rate to use + :param timeout: OPTIONAL: The timeout to use + """ self._port_name = port_name self._baudrate = baud self._timeout = timeout