Energenie EG-PMS User Manual download pdf (Page 16)

pickups Documentation, Release 0.7.0

3.4 Reference

Automatic generated Documenation by apidoc and autodoc.

3.4.1 pickups

Subpackages

pickups.bamboo

Submodules

bamboopickup

class pickups.bamboo.bamboopickup.BambooPickup(conﬁgﬁle)

Bases: pickups.basepickup.BasePickup

As a child class of BasePickup, BambooPickup implements all methods needed to update extreme feedback

devices using an Atlassian Bamboo buildserver and a RasberryPi with a manageable USB-Powersocket. Bam-

booPickup is using Bamboo’s REST-API to acquire all needed information on builds.

Initialize a BambooPickup object reading build statuses and updating connected feedback devices, according to

the logic deﬁned in update_status().

Parameters conﬁgﬁle – A conﬁg ﬁle which is passed to the baseclass to read it in.

Returns None

Raises None

overall_status

Getter for the overall status of the builds.

Returns A list ﬁltered by the result status of each build possibly look-

ing like [{’buildState’: ’Successful’}, {’buildState’:

’Successful’}]. Valid statuses are Successful, Failed and Unknown.

Raises None

builds_status

Getter for the current status of the builds.

Returns

List, ﬁltered by plans possibly looking like [{’isBuilding’: False},

{’isBuilding’: True}]. Valid current statuses are:

• True if a build is currently running

• False if a build is currently not running.

Raises None

cleanup()

Turn off all lamps if system is interrupted somehow. Using pickups.helpers.register() ensures

this is called when a SIGTERM is sent.

Returns None

Raises None

12 Chapter 3. Contents:

1 2 ... 11 12 13 14 15 16 17 18 19 20 21 ... 29 30

No comments

Energenie EG-PMS User Manual Page 16