API Reference v9.2.0

Illuminatorclass

Module: ZaberMotionMicroscopy

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

import ZaberMotionAscii
import ZaberMotionMicroscopy

let connection = try await Connection.openSerialPort(portName: "COM3")
let microscope = try await Microscope.find(connection: connection)
let illuminator = microscope.illuminator

import ZaberMotionAscii
import ZaberMotionMicroscopy

let connection = try await Connection.openSerialPort(portName: "COM3")
let illuminator = try await Illuminator.find(connection: connection)

Related Guides:

Microscope

Index

pProperties

mMethods

Constructor

try Illuminator(device)throws

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()

asyncthrows

try await Illuminator.find(connection, deviceAddress = 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.
deviceAddress	`Int`	Optional device address of the illuminator.

Return Value

Illuminator New instance of illuminator.

m

getChannel()

throws

try illuminator.getChannel(channelNumber)

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

Arguments

Name	Type	Description
channelNumber	`Int`	Number of channel to control.

Return Value

IlluminatorChannel Illuminator channel instance.

m

toString()

throws

try illuminator.toString()

Returns a string that represents the device.

Return Value

String A string that represents the device.

m

turnOff()

asyncthrows

try await illuminator.turnOff()

Turns all channels off.