com.ociweb.iot.grove.temp_and_humid.TempAndHumidTwig Maven / Gradle / Ivy

Go to download
package com.ociweb.iot.grove.temp_and_humid;

import java.nio.ByteBuffer;
import java.nio.ByteOrder;

import com.ociweb.iot.hardware.I2CConnection;
import com.ociweb.iot.hardware.IODevice;
import com.ociweb.iot.maker.FogCommandChannel;
import com.ociweb.iot.maker.IODeviceTransducer;

/**
 * Stores information necessary for reading from the Temperature and Humidity sensor from Grove
 * 
 * TODO: This class is currently based on the GrovePi hardware. Does not support regular hardware interface.
 */
public class TempAndHumidTwig implements IODevice{

	public byte addr = 0x04;
	private byte[] readData = new byte[9];
	private byte connection;
	private byte module_type;
	public enum MODULE_TYPE{
		DHT11,DHT22,DHT21,DHT2301;
	}
	
	public TempAndHumidTwig(int connection, MODULE_TYPE module_type) {
		this.connection = (byte) connection;
		switch(module_type){
		case DHT11 :
			this.module_type = 0;
			break;
		case DHT22 :
			this.module_type = 1;
			break;
		case DHT21 :
			this.module_type = 2;
			break;
		case DHT2301 :
			this.module_type = 3;
			break;
		}
	}

	/**
	 * Allows the {@link com.ociweb.pronghorn.iot.i2c.I2CJFFIStage} to sample the sensor by providing the right i2c commands and delays.
	 * See {@link com.ociweb.iot.hardware.I2CConnection} for command details.
	 * 
	 * TODO: This method should be moved to a Dexter GrovePi specific class.
	 * 
	 * @return I2CConnection
	 */
	public I2CConnection getI2CConnection(){
		byte[] TEMPHUMID_READCMD = {0x01, 40, connection, module_type, 0x00};
	    byte[] TEMPHUMID_SETUP = {0x01, 0x05, 0x00, 0x00, 0x00}; 
	    byte TEMPHUMID_ADDR = 0x04;
	    byte TEMPHUMID_BYTESTOREAD = 9;
	    byte TEMPHUMID_REGISTER = connection;
	    return new I2CConnection(this, TEMPHUMID_ADDR, TEMPHUMID_READCMD, TEMPHUMID_BYTESTOREAD, TEMPHUMID_REGISTER, TEMPHUMID_SETUP);
	}
	
	/**
	 * Is passed information from the read pipe and interprets it to usable data. 
	 * 		Returns a 2-element int[], [Temperature, Humidity].
	 * Note: Sensor resolution only returns values to the nearest int, so we return an int array, 
	 * 		despite the data being returned from the GrovePi as a float.
	 * 
	 * TODO: This method should be moved to a Dexter GrovePi specific class.
	 * 
	 * @param backing
	 * @param position
	 * @param length
	 * @param mask
	 * @return int array length 2. [temperature, humidity]
	 */
	public int[] interpretGrovePiData(byte[] backing, int position, int length, int mask){
		assert(length == 9) : "Incorrect length of data passed into DHT sensor";
		for (int i = 0; i < readData.length; i++) {
			readData[i] = backing[(position + i)&mask];
		}
		int[] temp = {(int)ByteBuffer.wrap(readData).order(ByteOrder.LITTLE_ENDIAN).getFloat(1), 
				(int)ByteBuffer.wrap(readData).order(ByteOrder.LITTLE_ENDIAN).getFloat(5)};
		return temp;
	}
	
	
	@Override
	/**
	 * Is passed information from the read pipe in the maker app and checks for validity
	 * 
	 * @param backing
	 * @param position
	 * @param length
	 * @param mask
	 * @return boolean isValid
	 */
	public boolean isValid(byte[] backing, int position, int length, int mask){
		for (int i = 0; i < readData.length; i++) {
			readData[i] = backing[(position + i)&mask];
		}
		return length==9 && readData[1]!=-1 && readData[5]!=-1;
	}

	@Override
	public boolean isInput() {
		return true;
	}

	@Override
	public boolean isOutput() {
		return false;
	}
	
	@Override
    public int pullResponseMinWaitNS() {
    	return 0;
    }

	@Override
	public boolean isPWM() {
		return false;
	}

	@Override
	public int range() {
		return 0;
	}

    @Override
    public int defaultPullRateMS() {
       return 600;      
    }
    
    @Override
    public int pinsUsed() {
        return 1;
    }

	@Override
	public  F newTransducer(FogCommandChannel... ch) {
		// TODO Auto-generated method stub
		return null;
	}
    
}