PCA9685 (raspoid 1.0 API)

java.lang.Object
- com.raspoid.I2CComponent
- - com.raspoid.additionalcomponents.PCA9685

All Implemented Interfaces:

Component
```
public class PCA9685
extends I2CComponent
```
A PCA9685 can be used to generated PWM signals. It's composed of 16 independent channels (16 output PWM signals), and is directly controlled through i2c.
Datasheet: PCA9685

Each channel has 4 registers of 8 bits:
- ON_L
- ON_H
- OFF_L
- OFF_H
The implementation of this component is mainly based on:
- the datasheet
- the python driver from Adafruit

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PCA9685.PCA9685Channel
16 channels are available on the PCA9685 module, numbered from 0 to 15.

Nested Classes
Modifier and Type	Class and Description
`static class`	`PCA9685.PCA9685Channel` 16 channels are available on the PCA9685 module, numbered from 0 to 15.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AI` [datasheet - p.14] Mode register 1, MODE1.
`static int`	`ALL_LED_OFF_H` [datasheet - p.13] Register address.
`static int`	`ALL_LED_OFF_L` [datasheet - p.13] Register address.
`static int`	`ALL_LED_ON_H` [datasheet - p.13] Register address.
`static int`	`ALL_LED_ON_L` [datasheet - p.13] Register address.
`static int`	`ALLCALL` [datasheet - p.14] Mode register 1, MODE1.
`static int`	`ALLCALLADR` [datasheet - p.10] Register address.
`static int`	`DEFAULT_I2C_ADDRESS` Defautl i2c address for the PCA9685 component.
`static int`	`EXTCLK` [datasheet - p.14] Mode register 1, MODE1.
`static int`	`INVRT` [datasheet - p.16] Mode register 2, MODE2.
`static int`	`LED0_OFF_H` [datasheet - p.10] Register address.
`static int`	`LED0_OFF_L` [datasheet - p.10] Register address.
`static int`	`LED0_ON_H` [datasheet - p.10] Register address.
`static int`	`LED0_ON_L` [datasheet - p.10] Register address.
`static int`	`MAX_FREQUENCY` Maximum frequency for the PWM signals generated by the PCA9685, in Hz.
`static int`	`MIN_FREQUENCY` Minimum frequency for the PWM signals generated by the PCA9685, in Hz.
`static int`	`MODE1` [datasheet - p.10] Register address.
`static int`	`MODE2` [datasheet - p.10] Register address.
`static int`	`OCH` [datasheet - p.16] Mode register 2, MODE2.
`static int`	`OUTDRV` [datasheet - p.16] Mode register 2, MODE2.
`static int`	`OUTNE` [datasheet - p.16] Mode register 2, MODE2.
`static int`	`PRE_SCALE` [datasheet - p.13] Register address.
`static int`	`REGISTERS_PER_LED` [datasheet - p.10] Register address.
`static int`	`RESTART` [datasheet - p.14] Mode register 1, MODE1.
`static int`	`SLEEP` [datasheet - p.14] Mode register 1, MODE1.
`static int`	`SUB1` [datasheet - p.14] Mode register 1, MODE1.
`static int`	`SUB2` [datasheet - p.14] Mode register 1, MODE1.
`static int`	`SUB3` [datasheet - p.14] Mode register 1, MODE1.
`static int`	`SUBADR1` [datasheet - p.10] Register address.
`static int`	`SUBADR2` [datasheet - p.10] Register address.
`static int`	`SUBADR3` [datasheet - p.10] Register address.

Fields inherited from class com.raspoid.I2CComponent
device, MAX_I2C_ADDRESS, MIN_I2C_ADDRESS

Constructor Summary

Constructors
Constructor and Description
`PCA9685()` Default constructor for a PCA9685 using the default i2c address of the component.
`PCA9685(int i2cAddress)` Constructor for a PCA9685 using a specific i2c address.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`setAllPWM(int on, int off)` Sets the start and end of the high segment of the PWM pulse, for all the PWM channels of the PCA9685.
`void`	`setPWM(PCA9685.PCA9685Channel channel, int on, int off)` Sets the start (on) and end (off) of the high segment of the PWM pulse, on a specific channel.
`void`	`setPWMFreq(int frequency)` Sets the PWM frequency, which determines how many full pulses per second are generated by the module.

Methods inherited from class com.raspoid.I2CComponent
getDevice, getType, readSignedRegisterValue, readTwoSignedRegsiters, readTwoUnsignedRegisters, readUnsignedRegisterValue, writeUnsignedValueDirectlyToI2CDevice, writeUnsignedValueToRegister

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_I2C_ADDRESS
```
public static final int DEFAULT_I2C_ADDRESS
```
    Defautl i2c address for the PCA9685 component.
    
    See Also:
    
    Constant Field Values
  - MODE1
```
public static final int MODE1
```
    [datasheet - p.10] Register address.
    Mode register 1.
    
    See Also:
    
    Constant Field Values
  - MODE2
```
public static final int MODE2
```
    [datasheet - p.10] Register address.
    Mode register 2.
    
    See Also:
    
    Constant Field Values
  - SUBADR1
```
public static final int SUBADR1
```
    [datasheet - p.10] Register address.
    i2c-bus subaddress 1.
    
    See Also:
    
    Constant Field Values
  - SUBADR2
```
public static final int SUBADR2
```
    [datasheet - p.10] Register address.
    i2c-bus subaddress 2.
    
    See Also:
    
    Constant Field Values
  - SUBADR3
```
public static final int SUBADR3
```
    [datasheet - p.10] Register address.
    i2c-bus subaddress 3.
    
    See Also:
    
    Constant Field Values
  - ALLCALLADR
```
public static final int ALLCALLADR
```
    [datasheet - p.10] Register address.
    LED All Call i2c-bus address.
    
    See Also:
    
    Constant Field Values
  - LED0_ON_L
```
public static final int LED0_ON_L
```
    [datasheet - p.10] Register address.
    LED0 output and brightness control byte 0.
    
    Equivalent for other LEDs can be accessed with: (for LED number LED_NB)
```
LED0_ON_L + LED_NB * REGISTERS_PER_LED
```
    See Also:
    
    Constant Field Values
  - LED0_ON_H
```
public static final int LED0_ON_H
```
    [datasheet - p.10] Register address.
    LED0 output and brightness control byte 0.
    
    Equivalent for other LEDs can be accessed with: (for LED number LED_NB)
```
LED0_ON_H + LED_NB * REGISTERS_PER_LED
```
    See Also:
    
    Constant Field Values
  - LED0_OFF_L
```
public static final int LED0_OFF_L
```
    [datasheet - p.10] Register address.
    LED0 output and brightness control byte 0.
    
    Equivalent for other LEDs can be accessed with: (for LED number LED_NB)
```
LED0_OFF_L + LED_NB * REGISTERS_PER_LED
```
    See Also:
    
    Constant Field Values
  - LED0_OFF_H
```
public static final int LED0_OFF_H
```
    [datasheet - p.10] Register address.
    LED0 output and brightness control byte 0.
    
    Equivalent for other LEDs can be accessed with: (for LED number LED_NB)
```
LED0_OFF_H + LED_NB * REGISTERS_PER_LED
```
    See Also:
    
    Constant Field Values
  - REGISTERS_PER_LED
```
public static final int REGISTERS_PER_LED
```
    [datasheet - p.10] Register address.
    Number of registers used for each of the 16 LEDs.
    
    See Also:
    
    Constant Field Values
  - ALL_LED_ON_L
```
public static final int ALL_LED_ON_L
```
    [datasheet - p.13] Register address.
    Load all the LEDn_ON registers, byte 0.
    
    See Also:
    
    Constant Field Values
  - ALL_LED_ON_H
```
public static final int ALL_LED_ON_H
```
    [datasheet - p.13] Register address.
    Load all the LEDn_ON registers, byte 1.
    
    See Also:
    
    Constant Field Values
  - ALL_LED_OFF_L
```
public static final int ALL_LED_OFF_L
```
    [datasheet - p.13] Register address.
    Load all the LEDn_OFF registers, byte 0.
    
    See Also:
    
    Constant Field Values
  - ALL_LED_OFF_H
```
public static final int ALL_LED_OFF_H
```
    [datasheet - p.13] Register address.
    Load all the LEDn_OFF registers, byte 1.
    
    See Also:
    
    Constant Field Values
  - PRE_SCALE
```
public static final int PRE_SCALE
```
    [datasheet - p.13] Register address.
    Prescaled for PWM output frequency.
    
    The PRE_SCALE register defines the frequency at which the outputs modulate. The prescale value is determined with the formula shown in Equation 1, p.25 in datasheet.
```
prescale_value = round(osc_clock/(4096*update_rate) -1
```
    See Also:
    
    Constant Field Values
  - RESTART
```
public static final int RESTART
```
    [datasheet - p.14] Mode register 1, MODE1.
    Restart enabled.
    
    See Also:
    
    Constant Field Values
  - EXTCLK
```
public static final int EXTCLK
```
    [datasheet - p.14] Mode register 1, MODE1.
    Use EXTCLK pin clock.
    
    See Also:
    
    Constant Field Values
  - AI
```
public static final int AI
```
    [datasheet - p.14] Mode register 1, MODE1.
    Register Auto-Increment enabled.
    
    See Also:
    
    Constant Field Values
  - SLEEP
```
public static final int SLEEP
```
    [datasheet - p.14] Mode register 1, MODE1.
    Low power mode. Oscillator off.
    
    See Also:
    
    Constant Field Values
  - SUB1
```
public static final int SUB1
```
    [datasheet - p.14] Mode register 1, MODE1.
    PCA9685 responds to I2C-bus subaddress 1.
    
    See Also:
    
    Constant Field Values
  - SUB2
```
public static final int SUB2
```
    [datasheet - p.14] Mode register 1, MODE1.
    PCA9685 responds to I2C-bus subaddress 2.
    
    See Also:
    
    Constant Field Values
  - SUB3
```
public static final int SUB3
```
    [datasheet - p.14] Mode register 1, MODE1.
    PCA9685 responds to I2C-bus subaddress 3.
    
    See Also:
    
    Constant Field Values
  - ALLCALL
```
public static final int ALLCALL
```
    [datasheet - p.14] Mode register 1, MODE1.
    PCA9685 responds to LED All Call I2C-bus address.
    
    See Also:
    
    Constant Field Values
  - INVRT
```
public static final int INVRT
```
    [datasheet - p.16] Mode register 2, MODE2.
    Output logic state inverted. Value to use when no external driver used. Applicable when OE = 0.
    
    See Also:
    
    Constant Field Values
  - OCH
```
public static final int OCH
```
    [datasheet - p.16] Mode register 2, MODE2.
    Outputs change on ACK.
    
    See Also:
    
    Constant Field Values
  - OUTDRV
```
public static final int OUTDRV
```
    [datasheet - p.16] Mode register 2, MODE2.
    The 16 LEDn outputs are configured with a totem pole structure.
    
    See Also:
    
    Constant Field Values
  - OUTNE
```
public static final int OUTNE
```
    [datasheet - p.16] Mode register 2, MODE2.
    When OE = 1 (output drivers not enabled):
    - LEDn = 1 when OUTDRV = 1
    - LEDn = high-impedance when OUTDRV = 0 (same as OUTNE[1:0] = 10)
    See Also:
    
    Constant Field Values
  - MAX_FREQUENCY
```
public static final int MAX_FREQUENCY
```
    Maximum frequency for the PWM signals generated by the PCA9685, in Hz.
    
    See Also:
    
    Constant Field Values
  - MIN_FREQUENCY
```
public static final int MIN_FREQUENCY
```
    Minimum frequency for the PWM signals generated by the PCA9685, in Hz.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PCA9685
```
public PCA9685()
```
    Default constructor for a PCA9685 using the default i2c address of the component.
  - PCA9685
```
public PCA9685(int i2cAddress)
```
    Constructor for a PCA9685 using a specific i2c address.
    
    Parameters:
    
    i2cAddress - the i2c address of the PCA9685.
- Method Detail
  - setPWMFreq
```
public void setPWMFreq(int frequency)
```
    Sets the PWM frequency, which determines how many full pulses per second are generated by the module.
    
    Parameters:
    
    frequency - the frequency in Hz, in the MAX_FREQUENCY..MIN_FREQUENCY range.
  - setPWM
```
public void setPWM(PCA9685.PCA9685Channel channel,
                   int on,
                   int off)
```
    Sets the start (on) and end (off) of the high segment of the PWM pulse, on a specific channel. You then specify WHEN the PWM signal will turn on, and WHEN it will turn off for each pulse. (! You don't set the PWM frequency itself !).
    
    Parameters:
    
    channel - the channel that should be updated with the new values.
    
    on - the tick, between 0 and 4096, when the signal should transition from low to high.
    
    off - the tick, between on and 4096, when the signal should transition from high to low.
    
    See Also:
    
    setAllPWM(int, int)
  - setAllPWM
```
public void setAllPWM(int on,
                      int off)
```
    Sets the start and end of the high segment of the PWM pulse, for all the PWM channels of the PCA9685.
    
    Parameters:
    
    on - the tick, between 0 and 4096, when the signal should transition from low to high.
    
    off - the tick, between on and 4096, when the signal should transition from high to low.
    
    See Also:
    
    setPWM(PCA9685Channel, int, int)

Class PCA9685

Nested Class Summary

Field Summary

Fields inherited from class com.raspoid.I2CComponent

Constructor Summary

Method Summary

Methods inherited from class com.raspoid.I2CComponent

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_I2C_ADDRESS

MODE1

MODE2

SUBADR1

SUBADR2

SUBADR3

ALLCALLADR

LED0_ON_L

LED0_ON_H

LED0_OFF_L

LED0_OFF_H

REGISTERS_PER_LED

ALL_LED_ON_L

ALL_LED_ON_H

ALL_LED_OFF_L

ALL_LED_OFF_H

PRE_SCALE

RESTART

EXTCLK

AI

SLEEP

SUB1

SUB2

SUB3

ALLCALL

INVRT

OCH

OUTDRV

OUTNE

MAX_FREQUENCY

MIN_FREQUENCY

Constructor Detail

PCA9685

PCA9685

Method Detail

setPWMFreq

setPWM

setAllPWM