Ads1115

java.lang.Object
- org.myrobotlab.framework.MessageService
- - org.myrobotlab.framework.Service
  - - org.myrobotlab.service.Ads1115

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, Attachable, Invoker, LoggingSink, MessageSender, MessageSubscriber, NameProvider, NameTypeProvider, ServiceInterface, ServiceQueue, StateSaver, TypeProvider, I2CControl, PinArrayControl, QueueReporter
```
public class Ads1115
extends Service
implements I2CControl, PinArrayControl
```
AdaFruit Ina219 Shield Controller Service

Author:

Mats https://learn.adafruit.com/adafruit-4-channel-adc-breakouts /programming The code here is to a large extent based on the Adafruit C++ libraries here: https://github.com/adafruit/Adafruit_ADS1X15 Next follows the license agreement from Adafruit that this service is based on. It has been converted fron C++ to Java. Software License Agreement (BSD License) Copyright (c) 2012, Adafruit Industries All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holders nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class Ads1115.Publisher
Publisher - Publishes pin data at a regular interval

Nested Classes
Modifier and Type	Class and Description
`class`	`Ads1115.Publisher` Publisher - Publishes pin data at a regular interval

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`adc0`
`int`	`adc1`
`int`	`adc2`
`int`	`adc3`
`I2CController`	`controller`
`java.lang.String`	`controllerName`
`java.util.List<java.lang.String>`	`controllers`
`java.lang.String`	`deviceAddress`
`java.util.List<java.lang.String>`	`deviceAddressList`
`java.lang.String`	`deviceBus`
`java.util.List<java.lang.String>`	`deviceBusList`
`boolean`	`isAttached`
`static org.slf4j.Logger`	`log`
`double`	`voltage0`
`double`	`voltage1`
`double`	`voltage2`
`double`	`voltage3`

Fields inherited from class org.myrobotlab.framework.Service
cfgDir, dnaPool, MESSAGE_RECORDING_FORMAT_BINARY, MESSAGE_RECORDING_FORMAT_XML

Constructor Summary

Constructors
Constructor and Description

Ads1115(java.lang.String n)

Constructors
Constructor and Description
`Ads1115(java.lang.String n)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`attach(Attachable service)` This attach when overriden "routes" to the appropriately typed parameterized attach within a service.
`void`	`attach(I2CController controller, java.lang.String deviceBus, java.lang.String deviceAddress)`
`void`	`attach(PinArrayListener listener)`
`void`	`attach(PinListener listener, java.lang.Integer pinAddress)`
`void`	`attach(java.lang.String service)` Attachable.attach(serviceName) - routes to reference parameter Attachable.attach(Attachable)
`void`	`attach(java.lang.String listener, int pinAddress)`
`void`	`attach(java.lang.String controllerName, java.lang.String deviceBus, java.lang.String deviceAddress)`
`void`	`attachI2CController(I2CController controller)`
`java.util.Map<java.lang.String,PinDefinition>`	`createPinList()`
`void`	`detach(Attachable service)` This detach when overriden "routes" to the appropriately typed parameterized detach within a service.
`void`	`detach(java.lang.String service)` Attachable.detach(serviceName) - routes to reference parameter Attachable.detach(Attachable)
`void`	`detachI2CController(I2CController controller)`
`void`	`disablePin(java.lang.Integer address)`
`void`	`disablePins()`
`void`	`enablePin(java.lang.Integer address)`
`void`	`enablePin(java.lang.Integer address, java.lang.Integer rate)`
`java.util.Set<java.lang.String>`	`getAttached()` Returns all the currently attached services
`I2CController`	`getController()`
`java.lang.String`	`getControllerName()`
`java.lang.String`	`getDeviceAddress()`
`java.lang.String`	`getDeviceBus()`
`int`	`getGain()`
`int`	`getLastConversionResults()`
`static ServiceType`	`getMetaData()` This static method returns all the details of the class without it having to be constructed.
`PinDefinition`	`getPin(java.lang.Integer address)`
`PinDefinition`	`getPin(java.lang.String pinName)`
`java.util.List<PinDefinition>`	`getPinList()`
`void`	`init_ADS1015()` This method initiates the ADS1015
`void`	`init_ADS1115()` This method initiates the ADS1115
`boolean`	`isAttached(Attachable instance)` the "routing" isAttached - when overridden by a service this "routes" to the appropriate typed isAttached
`boolean`	`isAttached(java.lang.String name)` GOOD DESIGN - this method is the same pretty much for all Services could be a Java 8 default implementation to the interface
`static void`	`main(java.lang.String[] args)`
`void`	`onRegistered(ServiceInterface s)`
`void`	`pinMode(java.lang.Integer address, java.lang.String mode)`
`java.lang.Integer`	`pinNameToAddress(java.lang.String pinName)`
`PinData`	`publishPin(PinData pinData)`
`PinData[]`	`publishPinArray(PinData[] pinData)` publish all read pin data in one array at once
`PinDefinition`	`publishPinDefinition(PinDefinition pinDef)`
`int`	`read(java.lang.Integer address)`
`int`	`read(java.lang.String pinName)`
`int`	`readADC_Differential_0_1()`
`int`	`readADC_Differential_2_3()`
`int`	`readADC_SingleEnded(int channel)`
`void`	`refresh()` This method reads all four A/D pins
`java.util.List<java.lang.String>`	`refreshControllers()`
`void`	`setDeviceAddress(java.lang.String deviceAddress)`
`void`	`setDeviceBus(java.lang.String deviceBus)`
`void`	`setGain(int gain)`
`double`	`setSampleRate(double rate)`
`void`	`startComparator_SingleEnded(int channel, int threshold)`
`void`	`write(java.lang.Integer address, java.lang.Integer value)`

Methods inherited from class org.myrobotlab.framework.Service
addListener, addListener, addTask, addTask, addTask, addTaskOneShot, allowDisplay, allowDisplay, broadcastState, buildDna, buildDna, buildDnaKeys, buildDnaNames, clearLastError, close, containsTask, copyShallowFrom, createPeer, createPeer, createRootReserved, detach, echoHeartbeat, error, error, error, getCfgDir, getComm, getDeclaredMethodNames, getDeclaredMethods, getDescription, getDna, getDnaString, getHostName, getInbox, getInstanceId, getIntanceName, getInterfaceSet, getLastError, getMessageSet, getMetaData, getMethodMap, getMethodNames, getMethods, getMethodToolTip, getMsg, getName, getNotifyList, getNotifyListKeySet, getOutbox, getPeerKey, getPeerName, getServiceResourceFile, getSimpleName, getTasks, getThisThread, getType, hasError, hasPeers, help, help, in, info, info, invoke, invoke, invoke, invokeOn, isLocal, isReady, isRunning, isRuntime, isVirtual, load, load, logTimeEnable, mergeDna, mergeDna, mergePeerDna, movePeerDna, out, out, preProcessHook, preRoutingHook, publishError, publishQueueStats, publishState, publishStats, publishStatus, purgeTask, purgeTasks, releasePeers, releaseService, removeAllListeners, removeListener, requiresSecurity, reserve, reserve, reserveRoot, reserveRoot, reserveRootAs, run, save, save, save, send, send, send, send, sendBlocking, sendBlocking, sendBlocking, sendBlocking, sendPeer, setInstanceId, setName, setPeer, setSecurityProvider, setState, setThisThread, setVirtual, sleep, stackToString, startHeartbeat, startPeer, startPeer, startRecording, startService, stopHeartbeat, stopMsgRecording, stopService, subscribe, subscribe, subscribe, toString, unsubscribe, unsubscribe, unsubscribe, updateStats, warn, warn

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

Methods inherited from interface org.myrobotlab.framework.interfaces.Attachable
detach, isLocal

Methods inherited from interface org.myrobotlab.framework.interfaces.NameProvider
getName

- Field Detail
  - log
```
public static final org.slf4j.Logger log
```
  - controller
```
public transient I2CController controller
```
  - deviceAddressList
```
public java.util.List<java.lang.String> deviceAddressList
```
  - deviceAddress
```
public java.lang.String deviceAddress
```
  - deviceBusList
```
public java.util.List<java.lang.String> deviceBusList
```
  - deviceBus
```
public java.lang.String deviceBus
```
  - adc0
```
public int adc0
```
  - adc1
```
public int adc1
```
  - adc2
```
public int adc2
```
  - adc3
```
public int adc3
```
  - voltage0
```
public double voltage0
```
  - voltage1
```
public double voltage1
```
  - voltage2
```
public double voltage2
```
  - voltage3
```
public double voltage3
```
  - controllers
```
public java.util.List<java.lang.String> controllers
```
  - controllerName
```
public java.lang.String controllerName
```
  - isAttached
```
public boolean isAttached
```
- Constructor Detail
  - Ads1115
```
public Ads1115(java.lang.String n)
```
- Method Detail
  - main
```
public static void main(java.lang.String[] args)
```
  - onRegistered
```
public void onRegistered(ServiceInterface s)
```
  - refreshControllers
```
public java.util.List<java.lang.String> refreshControllers()
```
  - getController
```
public I2CController getController()
```
  - getControllerName
```
public java.lang.String getControllerName()
```
  - setDeviceBus
```
public void setDeviceBus(java.lang.String deviceBus)
```
    Specified by:
    
    setDeviceBus in interface I2CControl
  - setDeviceAddress
```
public void setDeviceAddress(java.lang.String deviceAddress)
```
    Specified by:
    
    setDeviceAddress in interface I2CControl
  - refresh
```
public void refresh()
```
    This method reads all four A/D pins
  - init_ADS1015
```
public void init_ADS1015()
```
    This method initiates the ADS1015
  - init_ADS1115
```
public void init_ADS1115()
```
    This method initiates the ADS1115
  - setGain
```
public void setGain(int gain)
```
  - getGain
```
public int getGain()
```
  - readADC_SingleEnded
```
public int readADC_SingleEnded(int channel)
```
  - readADC_Differential_0_1
```
public int readADC_Differential_0_1()
```
  - readADC_Differential_2_3
```
public int readADC_Differential_2_3()
```
  - startComparator_SingleEnded
```
public void startComparator_SingleEnded(int channel,
                                        int threshold)
```
  - getLastConversionResults
```
public int getLastConversionResults()
```
  - isAttached
```
public boolean isAttached(java.lang.String name)
```
    GOOD DESIGN - this method is the same pretty much for all Services could be a Java 8 default implementation to the interface
    
    Specified by:
    
    isAttached in interface Attachable
    
    Overrides:
    
    isAttached in class Service
    
    Parameters:
    
    name - - name of service
    
    Returns:
    
    True or False depending if service is attached
  - getPinList
```
public java.util.List<PinDefinition> getPinList()
```
    Specified by:
    
    getPinList in interface PinArrayControl
  - read
```
public int read(java.lang.Integer address)
```
    Specified by:
    
    read in interface PinArrayControl
  - read
```
public int read(java.lang.String pinName)
```
    Specified by:
    
    read in interface PinArrayControl
  - pinMode
```
public void pinMode(java.lang.Integer address,
                    java.lang.String mode)
```
    Specified by:
    
    pinMode in interface PinArrayControl
  - write
```
public void write(java.lang.Integer address,
                  java.lang.Integer value)
```
    Specified by:
    
    write in interface PinArrayControl
  - publishPin
```
public PinData publishPin(PinData pinData)
```
    Specified by:
    
    publishPin in interface PinArrayControl
  - publishPinArray
```
public PinData[] publishPinArray(PinData[] pinData)
```
    publish all read pin data in one array at once
    
    Specified by:
    
    publishPinArray in interface PinArrayControl
  - attach
```
public void attach(java.lang.String listener,
                   int pinAddress)
```
  - attach
```
public void attach(PinListener listener,
                   java.lang.Integer pinAddress)
```
    Specified by:
    
    attach in interface PinArrayControl
  - attach
```
public void attach(PinArrayListener listener)
```
    Specified by:
    
    attach in interface PinArrayControl
  - enablePin
```
public void enablePin(java.lang.Integer address)
```
    Specified by:
    
    enablePin in interface PinArrayControl
  - disablePin
```
public void disablePin(java.lang.Integer address)
```
    Specified by:
    
    disablePin in interface PinArrayControl
  - disablePins
```
public void disablePins()
```
    Specified by:
    
    disablePins in interface PinArrayControl
  - createPinList
```
public java.util.Map<java.lang.String,PinDefinition> createPinList()
```
  - pinNameToAddress
```
public java.lang.Integer pinNameToAddress(java.lang.String pinName)
```
  - setSampleRate
```
public double setSampleRate(double rate)
```
  - publishPinDefinition
```
public PinDefinition publishPinDefinition(PinDefinition pinDef)
```
  - getMetaData
```
public static ServiceType getMetaData()
```
    This static method returns all the details of the class without it having to be constructed. It has description, categories, dependencies, and peer definitions.
    
    Returns:
    
    ServiceType - returns all the data
  - enablePin
```
public void enablePin(java.lang.Integer address,
                      java.lang.Integer rate)
```
    Specified by:
    
    enablePin in interface PinArrayControl
  - attach
```
public void attach(java.lang.String service)
            throws java.lang.Exception
```
    Description copied from class: Service
    
    Attachable.attach(serviceName) - routes to reference parameter Attachable.attach(Attachable)
    
    Specified by:
    
    attach in interface Attachable
    
    Overrides:
    
    attach in class Service
    
    Parameters:
    
    service - - service name
    
    Throws:
    
    java.lang.Exception - - thrown if error
  - attach
```
public void attach(Attachable service)
            throws java.lang.Exception
```
    Description copied from class: Service
    This attach when overriden "routes" to the appropriately typed parameterized attach within a service. When overriden, the first thing it should do is check to see if the referenced service is already attached. If it is already attached it should simply return. If its attached to this service, it should first attach itself, modifying its own data if necessary. The last thing it should do is call the parameterized service's attach. This gives the other service an opportunity to attach. e.g.
```
 
 public void attach(Attachable service) {
    if (ServoControl.class.isAssignableFrom(service.getClass())) {
        attachServoControl((ServoControl) service);
        return;
    }
    
    ...  route to more attach functions   ....
    
    error("%s doesn't know how to attach a %s", getClass().getSimpleName(), service.getClass().getSimpleName());
  }
  
  And within attachServoControl :
  
  public void attachServoControl(ServoControl service) {
       // guard
       if (!isAttached(service)){
           return;
       }
       
       ... attach logic ....
 
       // call to attaching service
       service.attach(this);  
 }  
 
```
    Specified by:
    
    attach in interface Attachable
    
    Overrides:
    
    attach in class Service
    
    Parameters:
    
    service - - the service to attach from this service
    
    Throws:
    
    java.lang.Exception - - throws on error and cannot attach
  - attach
```
public void attach(java.lang.String controllerName,
                   java.lang.String deviceBus,
                   java.lang.String deviceAddress)
```
    Specified by:
    
    attach in interface I2CControl
  - attach
```
public void attach(I2CController controller,
                   java.lang.String deviceBus,
                   java.lang.String deviceAddress)
```
    Specified by:
    
    attach in interface I2CControl
  - attachI2CController
```
public void attachI2CController(I2CController controller)
```
    Specified by:
    
    attachI2CController in interface I2CControl
  - detach
```
public void detach(java.lang.String service)
```
    Description copied from class: Service
    
    Attachable.detach(serviceName) - routes to reference parameter Attachable.detach(Attachable)
    
    Specified by:
    
    detach in interface Attachable
    
    Overrides:
    
    detach in class Service
    
    Parameters:
    
    service - - name of service
  - detach
```
public void detach(Attachable service)
```
    Description copied from class: Service
    This detach when overriden "routes" to the appropriately typed parameterized detach within a service. When overriden, the first thing it should do is check to see if the referenced service is already detached. If it is already detached it should simply return. If its detached to this service, it should first detach itself, modifying its own data if necessary. The last thing it should do is call the parameterized service's detach. This gives the other service an opportunity to detach. e.g.
```
 
 public void detach(Attachable service) {
    if (ServoControl.class.isAssignableFrom(service.getClass())) {
        detachServoControl((ServoControl) service);
        return;
    }
    
    ...  route to more detach functions   ....
    
    error("%s doesn't know how to detach a %s", getClass().getSimpleName(), service.getClass().getSimpleName());
  }
  
  And within detachServoControl :
  
  public void detachServoControl(ServoControl service) {
       // guard
       if (!isAttached(service)){
           return;
       }
       
       ... detach logic ....
 
       // call to detaching service
       service.detach(this);  
 }  
 
```
    Specified by:
    
    detach in interface Attachable
    
    Overrides:
    
    detach in class Service
    
    Parameters:
    
    service - - the service to detach from this service
  - detachI2CController
```
public void detachI2CController(I2CController controller)
```
    Specified by:
    
    detachI2CController in interface I2CControl
  - getAttached
```
public java.util.Set<java.lang.String> getAttached()
```
    Returns all the currently attached services
    
    Specified by:
    
    getAttached in interface Attachable
    
    Overrides:
    
    getAttached in class Service
    
    Returns:
    
    the set of attached service names to this service
  - getDeviceBus
```
public java.lang.String getDeviceBus()
```
    Specified by:
    
    getDeviceBus in interface I2CControl
  - getDeviceAddress
```
public java.lang.String getDeviceAddress()
```
    Specified by:
    
    getDeviceAddress in interface I2CControl
  - isAttached
```
public boolean isAttached(Attachable instance)
```
    Description copied from class: Service
    
    the "routing" isAttached - when overridden by a service this "routes" to the appropriate typed isAttached
    
    Specified by:
    
    isAttached in interface Attachable
    
    Overrides:
    
    isAttached in class Service
    
    Parameters:
    
    instance - - referenced service to test
    
    Returns:
    
    true if service is already attached false otherwise
  - getPin
```
public PinDefinition getPin(java.lang.String pinName)
```
    Specified by:
    
    getPin in interface PinArrayControl
  - getPin
```
public PinDefinition getPin(java.lang.Integer address)
```
    Specified by:
    
    getPin in interface PinArrayControl

Class Ads1115

Nested Class Summary

Field Summary

Fields inherited from class org.myrobotlab.framework.Service

Constructor Summary

Method Summary

Methods inherited from class org.myrobotlab.framework.Service

Methods inherited from class java.lang.Object

Methods inherited from interface org.myrobotlab.framework.interfaces.Attachable

Methods inherited from interface org.myrobotlab.framework.interfaces.NameProvider

Field Detail

log

controller

deviceAddressList

deviceAddress

deviceBusList

deviceBus

adc0

adc1

adc2

adc3

voltage0

voltage1

voltage2

voltage3

controllers

controllerName

isAttached

Constructor Detail

Ads1115

Method Detail

main

onRegistered

refreshControllers

getController

getControllerName

setDeviceBus

setDeviceAddress

refresh

init_ADS1015

init_ADS1115

setGain

getGain

readADC_SingleEnded

readADC_Differential_0_1

readADC_Differential_2_3

startComparator_SingleEnded

getLastConversionResults

isAttached

getPinList

read

read

pinMode

write

publishPin

publishPinArray

attach

attach

attach

enablePin

disablePin

disablePins

createPinList

pinNameToAddress

setSampleRate

publishPinDefinition

getMetaData

enablePin

attach

attach

attach

attach

attachI2CController

detach

detach

detachI2CController

getAttached

getDeviceBus

getDeviceAddress

isAttached