Package: philander
About philanderPhilander is a collection of drivers for the components of an embedded
system or wireless sensor node. This includes but is not limited to:sensorsbattery chargersbattery fuel gaugesactors, such as motorsGUI elements, like LEDs and buttonsservice modules, e.g. integer mathematicsThe code is completely written in Python and relies on low-level
communication modules such as smbus, smbus2 or periphery and pymitter.
It aims at making application development easier by providing a
unified interface for electronic parts that are expected to do
similar things.The intended hardware platform is all kind of single-board computers
such as Raspberry Pi, Arduino and Google Coral.
This software is specifically designed for making the features of their
shields, daughter- and add-on boards available to the application.InstallationReleased builds of this collection can be installed from the
python package index athttps://pypi.orgby just
using pip as in:pip3 install philanderApplication developmentThe main guide line is: Keep your application code as generic as
possible. References to philander objects should only be as specific as
necessary!The API reference may be generated from the source code, through, e.g.
sphinx. It can be found athttps://philander.readthedocs.ioThe most relevant philander objects are derived frommodule. The life
cycle of such an object is as follows.Instantiation: usually a default constructor without any parameter.Params_init(): A class method to pre-populate a configuration dictionary
with default entries.open(): Configures an object and prepares it for use....operation...: depends on the actual type and may be
specified by other interfaces, such as sensor, charger or gasgauge.close(): Shut down the instance and possibly release any hardware resources.Note that the configuration is done through Python dictionaries,
passed in as the first parameter to the open() method.
The dictionary can be pre-initialized by Params_init()
or set by the application. Alternatively, parts of it could be read from
config files, for example.Example codefrom philander.accelerometer import Accelerometer
from philander.bma456 import BMA456 as sensorDriver
from philander.systypes import ErrorCode

configSensor = {
    "SerialBus.designator": "/dev/i2c-1",
    "SerialBusDevice.address": 0x18,
    "Sensor.dataRange"    : 4000,
    "Sensor.dataRate"     : 100,
}
sensor = sensorDriver()
sensorDriver.Params_init( configSensor )

err = sensor.open( configSensor )
if (err == ErrorCode.errOk):
    print("Success!")
else:
    print("Error: ", err)

mdata, err = sensor.getNextData()
if (err == ErrorCode.errOk):
    print(now, mdata)

sensor.close()Library developmentPython developers are welcome to add own classes and driver
implementations to this collection. Stick to the rules and conventions
of object-oriented Python programming!The mandatory coding convention for Python code is the Python
Enhancement Proposal #8 (PEP 8).
It also gives advice on the naming convention.Documentation must followPEP 257.
The Docstring format should be reStructuredText as defined by thereStructuredText Markup Specification.
To generate the HTML documentation output from the source files, tools
likeSphinxmay be used.
Preferrably, the same tool should also be able to generate PDF output.