upm_pca9685

Class PCA9685

java.lang.Object

upm_pca9685.PCA9685

public class PCA9685
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PCA9685.PCA9685_MODE1_T
static class	PCA9685.PCA9685_MODE2_T
static class	PCA9685.PCA9685_REG_T

Constructor Summary

Constructors

Constructor and Description
PCA9685(int bus)
PCA9685(int bus, short address)
PCA9685(int bus, short address, boolean raw) PCA9685 constructor

Method Summary

Modifier and Type	Method and Description
void	delete()
void	enableRestart(boolean enabled) Enables or disables the restart capability of the controller
boolean	ledFullOff(short led, boolean val) Sets or clears the FULL OFF bit for a given LED.
boolean	ledFullOn(short led, boolean val) Sets or clears the FULL ON bit for a given LED
boolean	ledOffTime(short led, int time) Sets the 'LED off' time (0-4,095).
boolean	ledOnTime(short led, int time) Sets the 'LED on' time (0-4,095).
short	readByte(short reg) Reads a byte value from a register
int	readWord(short reg) Reads a word value from a register.
boolean	setModeSleep(boolean sleep) Puts the device in or out of the sleep mode.
boolean	setPrescale(short prescale) Sets the prescale value.
boolean	setPrescaleFromHz(float hz)
boolean	setPrescaleFromHz(float hz, float oscFreq) Sets the prescale value based on a desired frequency in Hz.
boolean	writeByte(short reg, short arg1) Writes a byte value into a register
boolean	writeWord(short reg, int word) Writes a word value into a register.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PCA9685

public PCA9685(int bus,
               short address,
               boolean raw)

PCA9685 constructor

Parameters:

bus - I2C bus to use

address - Address for this device

PCA9685

public PCA9685(int bus,
               short address)

PCA9685

public PCA9685(int bus)

Method Detail

delete

public void delete()

writeByte

public boolean writeByte(short reg,
                         short arg1)

Writes a byte value into a register

Parameters:

reg - Register location to write into

byte - Byte to write

Returns:

True if successful

writeWord

public boolean writeWord(short reg,
                         int word)

Writes a word value into a register. Note: the device must have the auto-increment bit set in the MODE1 register to work.

Parameters:

reg - Register location to write into

word - Word to write

Returns:

True if successful

readByte

public short readByte(short reg)

Reads a byte value from a register

Parameters:

reg - Register location to read from

Returns:

Value in a specified register

readWord

public int readWord(short reg)

Reads a word value from a register. Note: the device must have the auto-increment bit set in the MODE1 register to work.

Parameters:

reg - Register location to read from

Returns:

Value in a specified register

setModeSleep

public boolean setModeSleep(boolean sleep)

Puts the device in or out of the sleep mode. The device is always in the sleep mode upon power-up.

Parameters:

sleep - True to put the device in the sleep mode, false to put out

Returns:

True if successful

ledFullOn

public boolean ledFullOn(short led,
                         boolean val)

Sets or clears the FULL ON bit for a given LED

Parameters:

led - LED number; valid values are 0-15, PCA9685_ALL_LED

val - True to set the bit, false to clear it

Returns:

True if successful

ledFullOff

public boolean ledFullOff(short led,
                          boolean val)

Sets or clears the FULL OFF bit for a given LED. If the FULL ON bit is also set, FULL OFF has precedence.

Parameters:

led - LED number; valid values are 0-15, PCA9685_ALL_LED

val - True to set the bit, false to clear it

Returns:

True if successful

ledOnTime

public boolean ledOnTime(short led,
                         int time)

Sets the 'LED on' time (0-4,095). See the PCA9685 datasheet for details.

Parameters:

led - LED number; valid values are 0-15, PCA9685_ALL_LED

time - 12-bit value at which point the LED turns on

Returns:

True if successful

ledOffTime

public boolean ledOffTime(short led,
                          int time)

Sets the 'LED off' time (0-4,095). See the PCA9685 datasheet for details.

Parameters:

led - LED number; valid values are 0-15, PCA9685_ALL_LED

time - 12-bit value at which point the LED turns off

Returns:

True if successful

setPrescale

public boolean setPrescale(short prescale)

Sets the prescale value. See the PCA9685 datasheet for details. The prescale can only be set when the device is in the sleep mode.

Parameters:

prescale - Prescale value

Returns:

True if successful

setPrescaleFromHz

public boolean setPrescaleFromHz(float hz,
                                 float oscFreq)

Sets the prescale value based on a desired frequency in Hz. The prescale can only be set when the device is in the sleep mode.

Parameters:

hz - Desired frequency in Hz

oscFreq - Oscillator frequency; default is 25 MHz

Returns:

True if successful

setPrescaleFromHz

public boolean setPrescaleFromHz(float hz)

enableRestart

public void enableRestart(boolean enabled)

Enables or disables the restart capability of the controller

Parameters:

enabled - True to enable, false to disable It is enabled by default.