com.diozero.devices

Class McpAdc

java.lang.Object

com.diozero.internal.provider.AbstractDeviceFactory

com.diozero.devices.McpAdc

All Implemented Interfaces:

AnalogInputDeviceFactoryInterface, DeviceFactoryInterface, Closeable, AutoCloseable

public class McpAdc
extends AbstractDeviceFactory
implements AnalogInputDeviceFactoryInterface

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	McpAdc.McpAdcBoardPinInfo
static class	McpAdc.Type The MCP3204/3208 devices offer the choice of using the analog input channels configured as single-ended inputs or pseudo-differential pairs.

Field Summary

Fields

Modifier and Type	Field and Description
static McpAdc.Type	MCP3001
static McpAdc.Type	MCP3002
static McpAdc.Type	MCP3004
static McpAdc.Type	MCP3008
static McpAdc.Type	MCP3201
static McpAdc.Type	MCP3202
static McpAdc.Type	MCP3204
static McpAdc.Type	MCP3208
static McpAdc.Type	MCP3301
static McpAdc.Type	MCP3302
static McpAdc.Type	MCP3304

Fields inherited from class com.diozero.internal.provider.AbstractDeviceFactory

closed, deviceStates

Constructor Summary

Constructors

Constructor and Description
McpAdc(McpAdc.Type type, int chipSelect, float vRef)
McpAdc(McpAdc.Type type, int controller, int chipSelect, float vRef)

Method Summary

Modifier and Type	Method and Description
void	close()
AnalogInputDeviceInterface	createAnalogInputDevice(String key, PinInfo pinInfo)
BoardPinInfo	getBoardPinInfo()
String	getName()
float	getValue(int adcPin) Read the analog value in the range 0..1 or -1..1 (if the ADC type is signed)
float	getVRef()

Methods inherited from class com.diozero.internal.provider.AbstractDeviceFactory

createI2CKey, createPinKey, createSpiKey, deviceClosed, deviceOpened, getDevice, getDevice, isClosed, isDeviceOpened

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.diozero.internal.provider.AnalogInputDeviceFactoryInterface

provisionAnalogInputDevice

Methods inherited from interface com.diozero.internal.provider.DeviceFactoryInterface

createI2CKey, createPinKey, createSpiKey, deviceClosed, deviceOpened, getDevice, getDevice, isClosed, isDeviceOpened

Field Detail

MCP3001

public static final McpAdc.Type MCP3001

See Also:

MCP3001

MCP3002

public static final McpAdc.Type MCP3002

See Also:

MCP3002

MCP3004

public static final McpAdc.Type MCP3004

See Also:

MCP3004

MCP3008

public static final McpAdc.Type MCP3008

See Also:

MCP3008

MCP3201

public static final McpAdc.Type MCP3201

See Also:

MCP3201

MCP3202

public static final McpAdc.Type MCP3202

See Also:

MCP3202

MCP3204

public static final McpAdc.Type MCP3204

See Also:

MCP3204

MCP3208

public static final McpAdc.Type MCP3208

See Also:

MCP3208

MCP3301

public static final McpAdc.Type MCP3301

See Also:

MCP3301

MCP3302

public static final McpAdc.Type MCP3302

See Also:

MCP3302

MCP3304

public static final McpAdc.Type MCP3304

See Also:

MCP3304

Constructor Detail

McpAdc

public McpAdc(McpAdc.Type type,
              int chipSelect,
              float vRef)
       throws RuntimeIOException

Throws:

RuntimeIOException

McpAdc

public McpAdc(McpAdc.Type type,
              int controller,
              int chipSelect,
              float vRef)
       throws RuntimeIOException

Throws:

RuntimeIOException

Method Detail

getVRef

public float getVRef()

Specified by:

getVRef in interface AnalogInputDeviceFactoryInterface

close

public void close()
           throws RuntimeIOException

Specified by:

close in interface DeviceFactoryInterface

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class AbstractDeviceFactory

Throws:

RuntimeIOException

getValue

public float getValue(int adcPin)
               throws RuntimeIOException

Read the analog value in the range 0..1 or -1..1 (if the ADC type is signed)

Parameters:

adcPin - Pin on the MCP device

Returns:

the unscaled value (-1..1)

Throws:

RuntimeIOException - if an I/O error occurs

createAnalogInputDevice

public AnalogInputDeviceInterface createAnalogInputDevice(String key,
                                                          PinInfo pinInfo)
                                                   throws RuntimeIOException

Specified by:

createAnalogInputDevice in interface AnalogInputDeviceFactoryInterface

Throws:

RuntimeIOException

getName

public String getName()

Specified by:

getName in interface DeviceFactoryInterface

getBoardPinInfo

public BoardPinInfo getBoardPinInfo()

Specified by:

getBoardPinInfo in interface DeviceFactoryInterface