Tramontana (Javadocs: tramontana

java.lang.Object
- tramontana.library.Tramontana

public class Tramontana
extends java.lang.Object

Tramontana is a platform for interactive spaces.

Author:: Pierluigi Dalla Rosa

Field Summary

Fields
Modifier and Type Field and Description

java.lang.String ipAddress

static java.lang.String VERSION

Fields
Modifier and Type	Field and Description
`java.lang.String`	`ipAddress`
`static java.lang.String`	`VERSION`

Constructor Summary

Constructors
Constructor and Description

Tramontana(PApplet parent, java.lang.String IP)

Constructors
Constructor and Description
`Tramontana(PApplet parent, java.lang.String IP)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`blinkColorEmbedded(int ledIndex, int red, int green, int blue)` blinkColorEmbedded works similar to `setColorEmbedded`.
`void`	`getBatteryLevel()`
`void`	`makeVibrate()` Actuate the haptic engine.
`void`	`onMessageEvent(java.lang.String msg)` Deprecated. Don't listen to onMessageEvent.
`void`	`playAudio(java.lang.String url)` Play a sound file (must be MP3 or WAV or AIF).
`void`	`playVideo(java.lang.String url)` Play a video file (must be MP4).
`void`	`pulseFlashLight(int numberOfPulses, float duration, float intensity)` Pulse the led light for the numberOfPulses (first parameter).
`void`	`reconnect()` Reconnect can be called if you lose connection with a tramontana node.
`void`	`releaseAnalogEmbedded()`
`void`	`releaseAttitude()`
`void`	`releaseAudioJack()`
`void`	`releaseButtonsEventEmbedded()`
`void`	`releaseDistance()`
`void`	`releaseLDREmbedded()`
`void`	`releaseMagnetometer()`
`void`	`releaseOrientation()`
`void`	`releasePowerSource()`
`void`	`releaseRxEmbedded()`
`void`	`releaseTouch()`
`void`	`releaseTouchDrag()`
`void`	`sendAttitudeDataToOSC(float frequency, int port)` Activate the OSC engine to send accelerometer information, useful to communicate with wekinator for example or a live performance installation that requires better realtime performances than websockets.
`void`	`sendAttitudeDataToOSC(float frequency, int port, java.lang.String ip)`
`void`	`sendMessage(java.lang.String msg)` Deprecated. Don't use sendMessage.
`void`	`sendSerialMessageEmbedded(java.lang.String msg)` sendSerialMessageEmbedded allows to connect a tramontana board with an other serial board like an Arduino.
`void`	`sendTouchDataToOSC(int maxNumFingers)` Activate the OSC engine to send touch data, useful to communicate with wekinator for example or a live performance installation that requires better realtime performances than websockets.
`void`	`sendTouchDataToOSC(int maxNumFingers, int port)`
`void`	`sendTouchDataToOSC(int maxNumFingers, int port, java.lang.String ip)`
`void`	`setAllColorEmbedded(int red, int green, int blue)` setAllColorEmbedded will affect all the leds connected to a tramontana board (max 255).
`void`	`setBrightness(float brightness)` Change iDevice brightness.
`void`	`setColor(float red, float green, float blue, float intensity)` Change the screen color.
`void`	`setColor(int red, int green, int blue, int intensity)` Change the screen color.
`void`	`setColorEmbedded(int ledIndex, int red, int green, int blue)` setColorEmbedded allows to change the color of leds connected to tramontana board (led should be WS2812).
`void`	`setFlashLight(float onValue)` Actuate the flash light.
`void`	`setRelayEmbeddedOff(int relayIndex)` setRelayEmbedded is a method to deactivate relay modules on tramontana boards.
`void`	`setRelayEmbeddedOn(int relayIndex)` setRelayEmbeddedOn is a method to activate relay modules on tramontana boards.
`void`	`setServoEmbedded(int servoIndex, int value)` SetServoEmbedded is a method to control servo motors on tramontana boards.
`void`	`showImage(java.lang.String url)` Display an image from URL (must be PNG, JPEG or GIF[won't be animated, send videos instead]).
`void`	`stopAttitudeDataToOSC()`
`void`	`stopTouchDataToOSC()`
`void`	`subscribeAnalogEmbedded(int frequency)` EMBEDDED You can subscribe to the analog input on Tramontana NANO or Tramontana PICO.
`void`	`subscribeAttitude()` Subscribe to Motion sensor (accelerometer).
`void`	`subscribeAttitude(int frequency)`
`void`	`subscribeAudioJack()` Be notified if the audio jack is inserted or removed.
`void`	`subscribeButtonsEventEmbedded()` EMBEDDED Listen for buttons event from Tramontana NANO or Tramontana PICO.
`void`	`subscribeDistance()` Subscribe to the distance sensor.
`void`	`subscribeLDREmbedded(int frequency)` EMBEDDED You can subscribe to the integrated LDR on Tramontana NANO or Tramontana PICO.
`void`	`subscribeMagnetometer()` Subscribe to magnetometer.
`void`	`subscribeOrientation()` Subscribe to orientation change.
`void`	`subscribePowerSource()` Be notified if the power source change.
`void`	`subscribeRxEmbedded()` EMBEDDED Subscribe RX will make Tramontana NANO or Tramontana PICO act as proxy for incoming messaging coming on the serial port It is possible to intercept the messages from Processing with the method: void onEmbeddedRxEvent(String ip,String msg) { println("serial message received:"+msg); }
`void`	`subscribeTouch()` Subscribe to the touch events.
`void`	`subscribeTouch(java.lang.Boolean multitouch)`
`void`	`subscribeTouchDrag()`
`void`	`subscribeTouchDrag(java.lang.Boolean multitouch)`
`void`	`takePicture()` takePicture will take a picture with your camera.
`void`	`takePicture(int camera)`
`void`	`takePictureWithUI(int camera)` takePictureWithUI will take a picture showing the modal view provided by iOS for taking pictures.
`void`	`transitionColors(float r1, float g1, float b1, float a1, float r2, float g2, float b2, float a2, float duration)` Provide two colors and duration.
`static java.lang.String`	`version()` return the version of the Library.

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

- Field Detail
  - ipAddress
```
public java.lang.String ipAddress
```
  - VERSION
```
public static final java.lang.String VERSION
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Tramontana
```
public Tramontana(PApplet parent,
                  java.lang.String IP)
```
- Method Detail
  - reconnect
```
public void reconnect()
```
    Reconnect can be called if you lose connection with a tramontana node.
  - sendMessage
```
public void sendMessage(java.lang.String msg)
```
    Deprecated. Don't use sendMessage.
  - onMessageEvent
```
public void onMessageEvent(java.lang.String msg)
```
    Deprecated. Don't listen to onMessageEvent.
  - setServoEmbedded
```
public void setServoEmbedded(int servoIndex,
                             int value)
```
    SetServoEmbedded is a method to control servo motors on tramontana boards.
    
    Parameters:
    
    servoIndex - will define the index of the servo you want to control
    
    the - second parameter is a number between 0 and 180.
  - setRelayEmbeddedOff
```
public void setRelayEmbeddedOff(int relayIndex)
```
    setRelayEmbedded is a method to deactivate relay modules on tramontana boards.
    
    Parameters:
    
    relayIndex - will define the index of the relay you want to turn OFF
  - setRelayEmbeddedOn
```
public void setRelayEmbeddedOn(int relayIndex)
```
    setRelayEmbeddedOn is a method to activate relay modules on tramontana boards.
    
    Parameters:
    
    relayIndex - will define the index of the relay you want to turn ON
  - sendSerialMessageEmbedded
```
public void sendSerialMessageEmbedded(java.lang.String msg)
```
    sendSerialMessageEmbedded allows to connect a tramontana board with an other serial board like an Arduino.
    
    Parameters:
    
    relayIndex - will define the index of the relay you want to control
    
    the - second parameter can be 0 (relay off) and 1 (relay on).
  - setColorEmbedded
```
public void setColorEmbedded(int ledIndex,
                             int red,
                             int green,
                             int blue)
```
    setColorEmbedded allows to change the color of leds connected to tramontana board (led should be WS2812). The index number 0 is controlling the onboard LED.
    
    Parameters:
    
    ledIndex - will define the index of the led you want to control
    
    red - component.
    
    blue - component.
    
    green - component.
  - blinkColorEmbedded
```
public void blinkColorEmbedded(int ledIndex,
                               int red,
                               int green,
                               int blue)
```
    blinkColorEmbedded works similar to setColorEmbedded.
    
    Parameters:
    
    ledIndex - will define the index of the led you want to control
    
    red - component.
    
    blue - component.
    
    green - component.
  - setAllColorEmbedded
```
public void setAllColorEmbedded(int red,
                                int green,
                                int blue)
```
    setAllColorEmbedded will affect all the leds connected to a tramontana board (max 255).
    
    Parameters:
    
    red - component.
    
    blue - component.
    
    green - component.
  - makeVibrate
```
public void makeVibrate()
```
    Actuate the haptic engine.
  - setBrightness
```
public void setBrightness(float brightness)
```
    Change iDevice brightness. brightness should be between 0.0 and 1.0
  - setColor
```
public void setColor(int red,
                     int green,
                     int blue,
                     int intensity)
```
    Change the screen color. Parameters 'int red, int green, int blue, int intensity' should be between 0 and 255
  - setColor
```
public void setColor(float red,
                     float green,
                     float blue,
                     float intensity)
```
    Change the screen color. Parameters 'float red, float green, float blue, float intensity' should be between 0.0 and 1.0
  - setFlashLight
```
public void setFlashLight(float onValue)
```
    Actuate the flash light. Input value between 0.0 (off) and 1.0 (full brightness)
  - pulseFlashLight
```
public void pulseFlashLight(int numberOfPulses,
                            float duration,
                            float intensity)
```
    Pulse the led light for the numberOfPulses (first parameter). Each pulse will have the duration specified in the second parameter. The last parameter determines the intensity of the LED.
  - showImage
```
public void showImage(java.lang.String url)
```
    Display an image from URL (must be PNG, JPEG or GIF[won't be animated, send videos instead]). Image URL can be from the internet or local file (update through iTunes).
  - playAudio
```
public void playAudio(java.lang.String url)
```
    Play a sound file (must be MP3 or WAV or AIF). The URL of audio files can be from the internet or local file (update through iTunes).
  - playVideo
```
public void playVideo(java.lang.String url)
```
    Play a video file (must be MP4). The URL of video files can be from the internet or local file (update through iTunes). When the end of the video is reached the device will invoke the method onVideoEndEvent
  - takePicture
```
public void takePicture()
```
    takePicture will take a picture with your camera. It is possible to choose the parameters:
    
    Parameters:
    
    (int) - which camera 0 frontal camera, 1 back camera
  - takePicture
```
public void takePicture(int camera)
```
  - takePictureWithUI
```
public void takePictureWithUI(int camera)
```
    takePictureWithUI will take a picture showing the modal view provided by iOS for taking pictures.
    
    Parameters:
    
    (int) - which camera 0 frontal camera, 1 back camera
  - transitionColors
```
public void transitionColors(float r1,
                             float g1,
                             float b1,
                             float a1,
                             float r2,
                             float g2,
                             float b2,
                             float a2,
                             float duration)
```
    Provide two colors and duration. The screen of your iDevice will be changing the color screen accordingly.
  - getBatteryLevel
```
public void getBatteryLevel()
```
  - sendAttitudeDataToOSC
```
public void sendAttitudeDataToOSC(float frequency,
                                  int port)
```
    Activate the OSC engine to send accelerometer information, useful to communicate with wekinator for example or a live performance installation that requires better realtime performances than websockets.
  - sendAttitudeDataToOSC
```
public void sendAttitudeDataToOSC(float frequency,
                                  int port,
                                  java.lang.String ip)
```
  - sendTouchDataToOSC
```
public void sendTouchDataToOSC(int maxNumFingers)
```
    Activate the OSC engine to send touch data, useful to communicate with wekinator for example or a live performance installation that requires better realtime performances than websockets.
  - sendTouchDataToOSC
```
public void sendTouchDataToOSC(int maxNumFingers,
                               int port)
```
  - sendTouchDataToOSC
```
public void sendTouchDataToOSC(int maxNumFingers,
                               int port,
                               java.lang.String ip)
```
  - stopAttitudeDataToOSC
```
public void stopAttitudeDataToOSC()
```
  - stopTouchDataToOSC
```
public void stopTouchDataToOSC()
```
  - subscribeDistance
```
public void subscribeDistance()
```
    Subscribe to the distance sensor.
  - releaseDistance
```
public void releaseDistance()
```
  - subscribeTouch
```
public void subscribeTouch()
```
    Subscribe to the touch events. Doesn't support multitouch.
  - subscribeTouch
```
public void subscribeTouch(java.lang.Boolean multitouch)
```
  - releaseTouch
```
public void releaseTouch()
```
  - subscribeTouchDrag
```
public void subscribeTouchDrag()
```
  - subscribeTouchDrag
```
public void subscribeTouchDrag(java.lang.Boolean multitouch)
```
  - releaseTouchDrag
```
public void releaseTouchDrag()
```
  - subscribeAttitude
```
public void subscribeAttitude()
```
    Subscribe to Motion sensor (accelerometer).
    
    Parameters:
    
    the - parameter specify the update frequency in Hz. Keep it low, suggested: 5Hz, default: 1Hz Test
  - subscribeAttitude
```
public void subscribeAttitude(int frequency)
```
  - releaseAttitude
```
public void releaseAttitude()
```
  - subscribeAudioJack
```
public void subscribeAudioJack()
```
    Be notified if the audio jack is inserted or removed.
  - releaseAudioJack
```
public void releaseAudioJack()
```
  - subscribePowerSource
```
public void subscribePowerSource()
```
    Be notified if the power source change.
  - releasePowerSource
```
public void releasePowerSource()
```
  - subscribeMagnetometer
```
public void subscribeMagnetometer()
```
    Subscribe to magnetometer. The magnetometer is filtering low magnetic fields. You will be notified if a consistent magnetic field is near your iDevice.
  - releaseMagnetometer
```
public void releaseMagnetometer()
```
  - subscribeOrientation
```
public void subscribeOrientation()
```
    Subscribe to orientation change.
  - releaseOrientation
```
public void releaseOrientation()
```
  - subscribeRxEmbedded
```
public void subscribeRxEmbedded()
```
    EMBEDDED Subscribe RX will make Tramontana NANO or Tramontana PICO act as proxy for incoming messaging coming on the serial port It is possible to intercept the messages from Processing with the method: void onEmbeddedRxEvent(String ip,String msg) { println("serial message received:"+msg); }
  - releaseRxEmbedded
```
public void releaseRxEmbedded()
```
  - subscribeButtonsEventEmbedded
```
public void subscribeButtonsEventEmbedded()
```
    EMBEDDED Listen for buttons event from Tramontana NANO or Tramontana PICO. The second parameter (btnIndex) identify which of the two buttons and the third parameter (btnValue) correspond to the state of the button, 1 pressed, 0 depressed. void onEmbeddedBtnsEvent(String ip,int btnIndex, int btnValue) { println("serial message received:"+msg); }
  - releaseButtonsEventEmbedded
```
public void releaseButtonsEventEmbedded()
```
  - subscribeAnalogEmbedded
```
public void subscribeAnalogEmbedded(int frequency)
```
    EMBEDDED You can subscribe to the analog input on Tramontana NANO or Tramontana PICO. The board will send an updated reading with the specified frequency. The value is received by the method: void onEmbeddedAnalogUpdate(String ip, int value) { println(value); }
  - releaseAnalogEmbedded
```
public void releaseAnalogEmbedded()
```
  - subscribeLDREmbedded
```
public void subscribeLDREmbedded(int frequency)
```
    EMBEDDED You can subscribe to the integrated LDR on Tramontana NANO or Tramontana PICO. The board will send an updated reading of the light value with the specified frequency. void onEmbeddedLDRUpdate(String ip, int value) { println(value); }
  - releaseLDREmbedded
```
public void releaseLDREmbedded()
```
  - version
```
public static java.lang.String version()
```
    return the version of the Library.
    
    Returns:
    
    String

Class Tramontana

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ipAddress

VERSION

Constructor Detail

Tramontana

Method Detail

reconnect

sendMessage

onMessageEvent

setServoEmbedded

setRelayEmbeddedOff

setRelayEmbeddedOn

sendSerialMessageEmbedded

setColorEmbedded

blinkColorEmbedded

setAllColorEmbedded

makeVibrate

setBrightness

setColor

setColor

setFlashLight

pulseFlashLight

showImage

playAudio

playVideo

takePicture

takePicture

takePictureWithUI

transitionColors

getBatteryLevel

sendAttitudeDataToOSC

sendAttitudeDataToOSC

sendTouchDataToOSC

sendTouchDataToOSC

sendTouchDataToOSC

stopAttitudeDataToOSC

stopTouchDataToOSC

subscribeDistance

releaseDistance

subscribeTouch

subscribeTouch

releaseTouch

subscribeTouchDrag

subscribeTouchDrag

releaseTouchDrag

subscribeAttitude

subscribeAttitude

releaseAttitude

subscribeAudioJack

releaseAudioJack

subscribePowerSource

releasePowerSource

subscribeMagnetometer

releaseMagnetometer

subscribeOrientation

releaseOrientation

subscribeRxEmbedded

releaseRxEmbedded

subscribeButtonsEventEmbedded

releaseButtonsEventEmbedded

subscribeAnalogEmbedded

releaseAnalogEmbedded

subscribeLDREmbedded

releaseLDREmbedded

version