API Reference v9.1.0

Illuminatorclass

Module: zaber_motion.microscopy

Use to manage an LED controller. Requires at least Firmware 7.09.

The following examples illustrate how you can obtain an instance of this type:

Example 1

Example 2

from zaber_motion.ascii import Connection
from zaber_motion.microscopy import Microscope

connection = Connection.open_serial_port('COM3')
microscope = Microscope.find(connection)
illuminator = microscope.illuminator

from zaber_motion.ascii import Connection
from zaber_motion.microscopy import Illuminator

connection = Connection.open_serial_port('COM3')
illuminator = Illuminator.find(connection)

Related Guides:

Microscope

Index

pProperties

mMethods

Constructor

Illuminator(device)

Creates instance of `Illuminator` based on the given device. If the device is identified, this constructor will ensure it is an illuminator.

Arguments

Name	Type	Description
device	`Device`	The base device of this illuminator.

Properties

p

device

readonly

illuminator.device

Device The base device of this illuminator.

p

io

readonly

illuminator.io

DeviceIO I/O channels of this device.

Methods

s

find()

async available

Illuminator.find(connection, device_address = 0)

Finds an illuminator on a connection. In case of conflict, specify the optional device address.

Arguments

Name	Type	Description
connection	`Connection`	Connection on which to detect the illuminator.
device_address	`int`	Optional device address of the illuminator.

Return Value

Illuminator New instance of illuminator.

m

get_channel()

illuminator.get_channel(channel_number)

Gets an IlluminatorChannel class instance that allows control of a particular channel. Channels are numbered from 1.

Arguments

Name	Type	Description
channel_number	`int`	Number of channel to control.

Return Value

IlluminatorChannel Illuminator channel instance.

m

repr()

illuminator.__repr__()

Returns a string that represents the device.

Return Value

str A string that represents the device.

m

turn_off()

async available

illuminator.turn_off()

Turns all channels off.