Welcome to Pyjector’s documentation!¶

Contents:

Indices and tables¶

class pyjector.pyjector.Pyjector(port=None, device_id='benq', **kwargs)[source]¶

command_spec[source]¶

Return all command specifications.

Returns:	dict – All command specs, with the pattern: “<alias>”: { “command”: “<serial_command>”, “actions”: { “<alias>”: “<serial_command>”, ..., },

get_config(device_id, overrides)[source]¶

Get configuration for pyserial and the device.

Parameters:	device_id – The string which identifies the command set to use with your device.

get_device_config_from_id(device_id)[source]¶

Get device configuration.

Parameters:	device_id – The string which identifies the command set to use.
Returns:	dict – The device configuration, including default

pyserial settings, as well as the command set.

get_pyserial_config()[source]¶

Get the pyserial config values from the device config.

This also checks that config values are sane, and casts them to the appropriate type, as needed.

get_device_config_from_id() must be called before this method.

Returns:	dict – The config values for `serial.Serial`.
Raises :	KeyError