pyflipdot API¶

HanoverController¶

The HanoverController is the main class used for controlling flipdot signs.

class pyflipdot.pyflipdot.HanoverController(port: serial.serialposix.Serial)[source]¶

Bases: object

A controller for addressing Hanover signs

add_sign(name: str, sign: pyflipdot.sign.HanoverSign)[source]¶

Adds a sign for the controller to communicate with

draw_image(image_data: numpy.array, sign_name: str = None)[source]¶

Sends an image to a sign to be displayed

Parameters

Raises

ValueError – Ambiguity which sign is to be addressed

property signs¶

Get the connected signs

start_test_signs()[source]¶: Broadcasts the test signs start command All signs connected to the serial port will loop the test sequence. Note: The sign need not be added to the controller for this sequence to take effect.

stop_test_signs()[source]¶: Broadcasts the test signs stop command All signs connected to the serial port will stop the test sequence. Note: The sign need not be added to the controller for this sequence to take effect.

The HanoverSign class defines the specific signs connected to your controller, allowing them to be individually addressed.

class pyflipdot.sign.HanoverSign(address: int, width: int, height: int, flip: bool = False)[source]¶

Bases: object

A Hanover sign

address¶

Address of the sign

flip¶

True if the sign is upside-down

height¶

Pixel height of the sign

width¶

Pixel width of the sidn

create_image() → numpy.ndarray[source]¶

Creates a blank image

to_image_packet(image_data: numpy.array) → pyflipdot.data.ImagePacket[source]¶

Produces a serial packet from an image