No description, website, or topics provided.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.idea
app
gradle/wrapper
tittlesdk
.gitignore
README.md
build.gradle
gradle.properties
gradlew
gradlew.bat
settings.gradle

README.md

Tittle SDK

Version: 1.0
Minimum SDK version: 21

Overview

Tittle SDK allows you to set up, search and control Tittle lights.

Installation

Make sure settings.gradle has the library listed at the top:

include ':app', ':tittlesdk-release'

Add dependency to the SDK to build.gradle:

implementation project(":tittlesdk-release")

Add permissions for android.permission.INTERNET and android.permission.ACCESS_NETWORK_STATE to your ApplicationManifest.xml

<!-- INTERNET PERMISSION IS NEEDED FOR CONNECTING TO TITTLE VIA WIFI -->
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

Usage

SDK currently supports three actions:

  1. Connect Tittle to Wifi
  2. Send commands to Tittle
  3. Search Tittles

Connect Tittle to Wifi

Tittle uses Wifi to receive commands from your Android device. Tittle app has two ways to connect to wifi "Smart config" and "Standard config". The SDK only supports Standard config for the time being.

Tittle Light support Smart Config or standard config for wifi configuration. This SDK now only support Standard Config.

  • Step 1. Switch the Tittle Light to AP mode.

    You need to do the following steps for your Tittle

    • Press and hold the power button for 5 seconds until your tittle blinks in white color then release.

    • Press and hold again the power button for 3 seconds until your tittle blinks in yellow.

    • Go to the wifi setting in your phone and connect a network called "Tittle-AP".

  • Step 2. Once your phone has connected to "Tittle-AP", setup connection with Tittle

// The name of the network to which you want to connect your Tittle to
String ssid = "My wifi name"; 

// Password of the network to connect
String password = "wifi password"; 

// Get the ip of the phone (in the Tittle-AP network). Make sure you have connected your phone to the
// Tittle-AP when you run this.
InetAddress handsetIp = InetAddress.getByName(Util.getIPAddress());

// Timeout for the config in ms. Config can take 30+ seconds so long timeout is necessary.
int timeout = 45000; 

// listener class needs to implement the StandardConfig.StandardConfigListener interface, and will be called
// when the config has completed or failed / time'd out
config = new StandardConfig(ssid, password, handsetIp, timeout, listener);
config.connect();		
  • Step 3. If the config succeeds, listener callback will be called with the IP address of the Tittle in the network it connected to. To start sending commands, switch your phone to the network that Tittle connected to.

Send commands to Tittle

To send commands to Tittle use TittleLightControl class. Create an instance of the class with

String ip = "192.168.1.2" // IP of the tittle device in your network
TittleLightControl tittle = new TittleLightControl(ip, listener);

listener needs to implement the TittleLightControl.TittleLightControlListener interface.

Use setLightMode to switch on the light. Set intensity to 0 to switch light off.

tittle.setLightMode(255, 255, 255, 255); // RGB color and ligth intensity as integers in 0 - 255 range
tittle.setLightMode(255, 255, 255, 0); // Turn off the light

Search Tittles

If there are Tittle's already connected to wifi, you can search them with TittleScanner class.

// First get the IP address of your device
InetAddress handsetIp = InetAddress.getByName(Util.getIPAddress());
TittleScanner scanner = new TittleScanner(handsetIp);
// How long should we scan in ms. Broadcasts to Tittle are sent every 5 seconds, 
// so use multiple's of 5000
int timeout = 20000; 
// listener should implement TittleScanner.TittleScannerListener interface. Listener 
// will be called each time Tittle's are found and once the scan has finished.
scanner.scan(timeout, listener);

Sample project

See sample project at https://github.com/clarityhk/tittle-sdk-samples/tree/master/android_sample