org.myrobotlab.service

Class OledSsd1306

java.lang.Object

org.myrobotlab.framework.MessageService

org.myrobotlab.framework.Service

org.myrobotlab.service.OledSsd1306

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, Attachable, Invoker, LoggingSink, MessageSender, MessageSubscriber, NameProvider, NameTypeProvider, ServiceInterface, ServiceQueue, StateSaver, TypeProvider, I2CControl, QueueReporter

public class OledSsd1306
extends Service
implements I2CControl

OledSsd1306 - This service can be used to drive a OLED display using the i2c protocol It's built for the SSD1306 driver

Author:

Mats Onnerby More Info : https://www.adafruit.com/product/326 References : https://github.com/adafruit/Adafruit_SSD1306 This service builds is a conversion from of the Arduino library above to Java Some OLED's are wired for SPI and need to be changed according to this instruction so that you can use the i2c protocol ( as implemented in this program ) http://electronics.stackexchange.com/questions/164680/ssd1306-display -isp-connection-or-i2c-according-to-resistors NB. Some OLED's need a reset pulse at power on. It can be generated using one of the pin's on the Arduino or by adding a 100nF capacitor between the reset pin and GND, and a 10K resistor betwen the reset pin and VCC

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	BLACK
int[]	buffer
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
static int	HIGH
static int	INPUT
static int	INVERSE
boolean	isAttached
static org.slf4j.Logger	log
static int	LOW
int	oledType
static int	OUTPUT
static int	SSD1306_128_32
static int	SSD1306_128_64
static int	SSD1306_96_16
static int	SSD1306_ACTIVATE_SCROLL
static short	SSD1306_CHARGEPUMP
static short	SSD1306_COLUMNADDR
static short	SSD1306_COMSCANDEC
static short	SSD1306_COMSCANINC
static int	SSD1306_DEACTIVATE_SCROLL
static short	SSD1306_DISPLAYALLON
static short	SSD1306_DISPLAYALLON_RESUME
static short	SSD1306_DISPLAYOFF
static short	SSD1306_DISPLAYON
static short	SSD1306_EXTERNALVCC
static short	SSD1306_INVERTDISPLAY
int	SSD1306_LCDHEIGHT
int	SSD1306_LCDWIDTH
static int	SSD1306_LEFT_HORIZONTAL_SCROLL
static short	SSD1306_MEMORYMODE
static short	SSD1306_NORMALDISPLAY
static short	SSD1306_PAGEADDR
static int	SSD1306_RIGHT_HORIZONTAL_SCROLL
static short	SSD1306_SEGREMAP
static int	SSD1306_SET_VERTICAL_SCROLL_AREA
static short	SSD1306_SETCOMPINS
static short	SSD1306_SETCONTRAST
static short	SSD1306_SETDISPLAYCLOCKDIV
static short	SSD1306_SETDISPLAYOFFSET
static short	SSD1306_SETHIGHCOLUMN
static short	SSD1306_SETLOWCOLUMN
static short	SSD1306_SETMULTIPLEX
static short	SSD1306_SETPRECHARGE
static short	SSD1306_SETSTARTLINE
static short	SSD1306_SETVCOMDETECT
static short	SSD1306_SWITCHCAPVCC
static int	SSD1306_VERTICAL_AND_LEFT_HORIZONTAL_SCROLL
static int	SSD1306_VERTICAL_AND_RIGHT_HORIZONTAL_SCROLL
static int	WHITE

Fields inherited from class org.myrobotlab.framework.Service

cfgDir, dnaPool, MESSAGE_RECORDING_FORMAT_BINARY, MESSAGE_RECORDING_FORMAT_XML

Constructor Summary

Constructors

Constructor and Description
OledSsd1306(java.lang.String n)

Method Summary

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(java.lang.String service) Attachable.attach(serviceName) - routes to reference parameter Attachable.attach(Attachable)
void	attach(java.lang.String controllerName, java.lang.String deviceBus, java.lang.String deviceAddress)
void	attachI2CController(I2CController controller)
void	clearRect(int x, int y, int width, int height, boolean on)
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	display()
void	display(int[] image)
void	drawChar(char c, int x, int y, boolean on)
void	drawImage(java.awt.image.BufferedImage image, int x, int y)
void	drawString(java.lang.String string, int x, int y, boolean on)
void	drawStringCentered(java.lang.String string, int y, boolean on)
java.util.Set<java.lang.String>	getAttached() Returns all the currently attached services
java.lang.String	getDeviceAddress()
java.lang.String	getDeviceBus()
static ServiceType	getMetaData() This static method returns all the details of the class without it having to be constructed.
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) returns if the Attachable has been set or not - name interface
static void	main(java.lang.String[] args)
void	onRegistered(ServiceInterface s)
void	refreshControllers()
void	setDeviceAddress(java.lang.String deviceAddress)
void	setDeviceBus(java.lang.String deviceBus)
void	setDisplayType(int displayType)
void	setPixel(int x, int y, boolean on)
void	stopService() Stops the service.

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, 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

HIGH

public static final int HIGH

See Also:

Constant Field Values

LOW

public static final int LOW

See Also:

Constant Field Values

INPUT

public static final int INPUT

See Also:

Constant Field Values

OUTPUT

public static final int OUTPUT

See Also:

Constant Field Values

controllers

public java.util.List<java.lang.String> controllers

controllerName

public java.lang.String controllerName

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

SSD1306_SETCONTRAST

public static short SSD1306_SETCONTRAST

SSD1306_DISPLAYALLON_RESUME

public static short SSD1306_DISPLAYALLON_RESUME

SSD1306_DISPLAYALLON

public static short SSD1306_DISPLAYALLON

SSD1306_NORMALDISPLAY

public static short SSD1306_NORMALDISPLAY

SSD1306_INVERTDISPLAY

public static short SSD1306_INVERTDISPLAY

SSD1306_DISPLAYOFF

public static short SSD1306_DISPLAYOFF

SSD1306_DISPLAYON

public static short SSD1306_DISPLAYON

SSD1306_SETDISPLAYOFFSET

public static short SSD1306_SETDISPLAYOFFSET

SSD1306_SETCOMPINS

public static short SSD1306_SETCOMPINS

SSD1306_SETVCOMDETECT

public static short SSD1306_SETVCOMDETECT

SSD1306_SETDISPLAYCLOCKDIV

public static short SSD1306_SETDISPLAYCLOCKDIV

SSD1306_SETPRECHARGE

public static short SSD1306_SETPRECHARGE

SSD1306_SETMULTIPLEX

public static short SSD1306_SETMULTIPLEX

SSD1306_SETLOWCOLUMN

public static short SSD1306_SETLOWCOLUMN

SSD1306_SETHIGHCOLUMN

public static short SSD1306_SETHIGHCOLUMN

SSD1306_SETSTARTLINE

public static short SSD1306_SETSTARTLINE

SSD1306_MEMORYMODE

public static short SSD1306_MEMORYMODE

SSD1306_COLUMNADDR

public static short SSD1306_COLUMNADDR

SSD1306_PAGEADDR

public static short SSD1306_PAGEADDR

SSD1306_COMSCANINC

public static short SSD1306_COMSCANINC

SSD1306_COMSCANDEC

public static short SSD1306_COMSCANDEC

SSD1306_SEGREMAP

public static short SSD1306_SEGREMAP

SSD1306_CHARGEPUMP

public static short SSD1306_CHARGEPUMP

SSD1306_EXTERNALVCC

public static short SSD1306_EXTERNALVCC

SSD1306_SWITCHCAPVCC

public static short SSD1306_SWITCHCAPVCC

SSD1306_128_64

public static int SSD1306_128_64

SSD1306_128_32

public static int SSD1306_128_32

SSD1306_96_16

public static int SSD1306_96_16

oledType

public int oledType

BLACK

public static final int BLACK

See Also:

Constant Field Values

WHITE

public static final int WHITE

See Also:

Constant Field Values

INVERSE

public static final int INVERSE

See Also:

Constant Field Values

SSD1306_ACTIVATE_SCROLL

public static int SSD1306_ACTIVATE_SCROLL

SSD1306_DEACTIVATE_SCROLL

public static int SSD1306_DEACTIVATE_SCROLL

SSD1306_SET_VERTICAL_SCROLL_AREA

public static int SSD1306_SET_VERTICAL_SCROLL_AREA

SSD1306_RIGHT_HORIZONTAL_SCROLL

public static int SSD1306_RIGHT_HORIZONTAL_SCROLL

SSD1306_LEFT_HORIZONTAL_SCROLL

public static int SSD1306_LEFT_HORIZONTAL_SCROLL

SSD1306_VERTICAL_AND_RIGHT_HORIZONTAL_SCROLL

public static int SSD1306_VERTICAL_AND_RIGHT_HORIZONTAL_SCROLL

SSD1306_VERTICAL_AND_LEFT_HORIZONTAL_SCROLL

public static int SSD1306_VERTICAL_AND_LEFT_HORIZONTAL_SCROLL

SSD1306_LCDWIDTH

public int SSD1306_LCDWIDTH

SSD1306_LCDHEIGHT

public int SSD1306_LCDHEIGHT

buffer

public int[] buffer

isAttached

public boolean isAttached

Constructor Detail

OledSsd1306

public OledSsd1306(java.lang.String n)

Method Detail

main

public static void main(java.lang.String[] args)

onRegistered

public void onRegistered(ServiceInterface s)

refreshControllers

public void refreshControllers()

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

setDisplayType

public void setDisplayType(int displayType)

setPixel

public void setPixel(int x,
                     int y,
                     boolean on)

drawString

public void drawString(java.lang.String string,
                       int x,
                       int y,
                       boolean on)

drawStringCentered

public void drawStringCentered(java.lang.String string,
                               int y,
                               boolean on)

clearRect

public void clearRect(int x,
                      int y,
                      int width,
                      int height,
                      boolean on)

drawChar

public void drawChar(char c,
                     int x,
                     int y,
                     boolean on)

drawImage

public void drawImage(java.awt.image.BufferedImage image,
                      int x,
                      int y)

display

public void display(int[] image)

display

public void display()

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

isAttached

public boolean isAttached(java.lang.String name)

Description copied from interface: Attachable

returns if the Attachable has been set or not - name 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

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

stopService

public void stopService()

Description copied from class: Service

Stops the service. Stops threads.

Specified by:

stopService in interface ServiceInterface

Overrides:

stopService in class Service

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