Library to read and write Azoteq IQS6xx device registers via I2C.

Dependents:   IQS620_HelloWorld IQS622_HelloWorld IQS624_HelloWorld IQS621_HelloWorld ... more

Library: IQS62x

Library to read and write Azoteq IQS6xx device registers via I2C.

Supported Devices

Components / IQS620A
Ultra low power sensor for magnetic field, capacitive touch and inductive proximity. Empowers next-generation user interfaces.

Components / IQS621
Azoteq IQS621 ultra low power sensor for ambient light, magnetic field, capacitance and inductive proximity. Empowers next-generation user interfaces.

Components / IQS622
Azoteq IQS622 ultra low power sensor for ambient light, active (reflective) IR, magnetic field, capacitance and inductive proximity. Empowers next-generation user interfaces.

Components / IQS624
Ultra low power sensor for rotating magnetic field, capacitive touch, and inductive proximity. Empowers next-generation user interfaces.

Handy Table of ProxFusion Device Features


ALS = Ambient Light Sensor PIR = Passive Infrared

/media/uploads/AzqDev/mbed-azoteq-proxfusion-handy-table-of-product-features.jpg

IQS62x.cpp

Committer:
AzqDev
Date:
2017-05-12
Revision:
11:4d6d1da5bd31
Parent:
10:8fdac52881aa
Child:
12:5a9bbbd6e312

File content as of revision 11:4d6d1da5bd31:

// A class library for Azoteq IQS62x devices

// Copyright 2017 Azoteq. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

// More info on IQS624 sensor IC: http://www.azoteq.com/products/proxfusion/iqs624?mbed

// IQS624 1-minute youtube video: http://bit.ly/IQS624Video

#include "IQS62x.h"

// constructor
IQS62xIO::IQS62xIO() : 
    i2c( IQS_I2C_DATA_PIN, IQS_I2C_CLOCK_PIN ), // first run the constructor for mbed class I2C
    IQSready( IQS_READY_PIN )                   // first run the constructor for mbed class DigitalIn
{    
    registers = I2CBuffer; // pointer to the receive buffer
    I2CErrorCount = 0; // reset I2C error count
    i2c.frequency( I2Cspeed ); // I2C clock frequency
}    

// write a single byte to an IQS62x register
void IQS62xIO::writeRegister(int address, int data) {
    char twoBytes [2];
    int numberOfBytes = 2;
    twoBytes[0] = address & 0xff;
    twoBytes[1] = data & 0xff;
    waitForReady();
    if(0!=i2c.write(I2C_ADR,twoBytes,numberOfBytes,false)) 
        I2CErrorCount++;
}

// configure the IQS62x
#include "deviceType.h" // to check if we should override the configuration definition
#ifndef OVERRIDE_CONFIGURE
// if there is no override for configure() then we use this simple version
void IQS62xIO::configure() {
    writeRegister(0xd0,0x40); // simplest config : just acknowledge/clear the reset flag
}
#endif

// read N registers, starting at provided offset
void IQS62xIO::readIqsRegisters(int start, int count){
    memset(I2CBuffer,0x55,I2CBufferSize); // "clear" i2c receive buffer
    waitForReady();
    char i2c_start_address [1]; 
    i2c_start_address[0] = start & 0xff;
    int numberOfBytes = 1;
    // write start address to the IQS62x address register
    if(0!=i2c.write(I2C_ADR,i2c_start_address,numberOfBytes,false)) 
        I2CErrorCount++;
    waitForReady();
    numberOfBytes = count % I2CBufferSize;
    // read register values into a buffer
    if(0!=i2c.read(I2C_ADR,I2CBuffer,numberOfBytes,false))
        I2CErrorCount++;
}

// wait for IQS62x to provide a ready signal (low) on IQS62x_ready pin
void IQS62xIO::waitForReady() {
    int timeout=0; 
    while (1) {
        if(IQSready==1) break;
        if (timeout++ > 1000000) goto fatal_error; 
    }
    timeout=0;
    while (1) {
        if(IQSready==0) break;
        if (timeout++ > 1000000) goto fatal_error;
    }
    return;
    fatal_error:
        error ("Fatal Error: IQS62x ready pin is not toggling");
}