Azoteq / IQS621DisplayTerminal

Register display for Azoteq IQS621 ultra low power I2C multi-function sensor.

Dependents:   IQS621_HelloWorld

A library that performs a register dump of the Azoteq IQS621 ultra low power multisensor registers.

More information on the IQS621 here:

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


Low Cost Evaluation Board For Azoteq IQS621ultra low power I2C sensor for ambient light, magnetic field, capacitance, inductive proximity and temperature.


Serial Terminal Output

/media/uploads/AzqDev/iqs621-1-display-i2c-ultra-low-power-sensor-for-ambient-light-capacitive-touch-magnetic-field.gif
IQS621 Register display as performed by mbed LPC1768.
Note the frame number - over half a million register dumps were performed with zero I2C errors.

IQS621DisplayTerminal.cpp@7:2cb11d8fa4a8, 2017-05-14 (annotated)

Committer:
AzqDev
Date:
Sun May 14 20:48:26 2017 +0000
Revision:
7:2cb11d8fa4a8
Parent:
5:2f315f806f0c
Child:
8:28ab2dd50b9f
Reversed showAllRegister logic

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AzqDev 0:6a124fa2a919 1 // A class library to display Azoteq IQS621 registers on a terminal
AzqDev 0:6a124fa2a919 2
AzqDev 0:6a124fa2a919 3 // 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.
AzqDev 0:6a124fa2a919 4
AzqDev 0:6a124fa2a919 5 // More info on IQS621 sensor IC: http://bit.ly/IQS621-info
AzqDev 0:6a124fa2a919 6
AzqDev 0:6a124fa2a919 7 // IQS621 1-minute youtube video: N.A.
AzqDev 0:6a124fa2a919 8
AzqDev 0:6a124fa2a919 9 #include "IQS621DisplayTerminal.h"
AzqDev 0:6a124fa2a919 10
AzqDev 0:6a124fa2a919 11 // constructor
AzqDev 0:6a124fa2a919 12 #if defined(TARGET_TEENSY3_1) || defined (TARGET_TEENSY3_2) || IQS_USE_USBSERIAL
AzqDev 0:6a124fa2a919 13 IQS621Display::IQS621Display() : USBSerial() // use our own USB device stack
AzqDev 0:6a124fa2a919 14 #else
AzqDev 0:6a124fa2a919 15 IQS621Display::IQS621Display() : Serial(USBTX,USBRX) // use mbed default serial port
AzqDev 0:6a124fa2a919 16 #endif
AzqDev 0:6a124fa2a919 17
AzqDev 5:2f315f806f0c 18 {
AzqDev 0:6a124fa2a919 19 frameCounter=0;
AzqDev 0:6a124fa2a919 20 baud(DISPLAY_BAUD_RATE);
AzqDev 5:2f315f806f0c 21 }
AzqDev 0:6a124fa2a919 22
AzqDev 0:6a124fa2a919 23 #if defined(TARGET_TEENSY3_1) || defined (TARGET_TEENSY3_2) || IQS_USE_USBSERIAL
AzqDev 5:2f315f806f0c 24 void IQS621Display::baud(int baudRate) {}
AzqDev 0:6a124fa2a919 25 #endif
AzqDev 0:6a124fa2a919 26
AzqDev 0:6a124fa2a919 27 // display a startup message to serial port
AzqDev 5:2f315f806f0c 28 void IQS621Display::helloMessage(bool waitForUser)
AzqDev 5:2f315f806f0c 29 {
AzqDev 0:6a124fa2a919 30 puts("\x1b[2J \x1b[?25l \x1b[H"); // ANSII/VT100 codes to clear screen, invisible cursor, home cursor
AzqDev 5:2f315f806f0c 31 printf(" IQS621 Register Display\r\n\r\n");
AzqDev 0:6a124fa2a919 32 printf("To get a smooth screen refresh effect, use a terminal program that supports ANSI/VT100 escape codes such as Tera Term.\r\n\r\n");
AzqDev 0:6a124fa2a919 33 printf("Handy hint - In many terminal programs, Alt-B (break) will reset your mbed Board.\r\n\r\n");
AzqDev 0:6a124fa2a919 34 printf("Press any key to continue...\r\n");
AzqDev 0:6a124fa2a919 35 if ( waitForUser ) while( ! readable() ); // wait for keypress to continue
AzqDev 0:6a124fa2a919 36 puts("\x1b[2J \x1b[?25l \x1b[H"); // ANSII/VT100 codes to clear screen, invisible cursor, home cursor
AzqDev 0:6a124fa2a919 37 }
AzqDev 0:6a124fa2a919 38
AzqDev 0:6a124fa2a919 39 // show headings and I2C error count
AzqDev 5:2f315f806f0c 40 void IQS621Display::showStatus(int I2Cspeed, int I2CErrorCount)
AzqDev 5:2f315f806f0c 41 {
AzqDev 0:6a124fa2a919 42 frameCounter++;
AzqDev 0:6a124fa2a919 43 puts("\x1b[H"); // ANSI/VT100 command for cursor home
AzqDev 5:2f315f806f0c 44 printf("\t");
AzqDev 0:6a124fa2a919 45 printf("\t IQS621 Register Display\r\n\r\n"); // heading
AzqDev 0:6a124fa2a919 46 printf("\t Frame number %06d", frameCounter);
AzqDev 0:6a124fa2a919 47 printf("\t I2C Speed %dk", I2Cspeed/1000);
AzqDev 0:6a124fa2a919 48 printf("\t I2C Errors %d", I2CErrorCount);
AzqDev 0:6a124fa2a919 49 }
AzqDev 0:6a124fa2a919 50
AzqDev 5:2f315f806f0c 51
AzqDev 5:2f315f806f0c 52 // dump one line of text from the buffer with VT100 color formatting
AzqDev 5:2f315f806f0c 53 void IQS621Display::showLine(char * buffer, char * color, int startbyte, int endbyte)
AzqDev 5:2f315f806f0c 54 {
AzqDev 5:2f315f806f0c 55 for (int i=startbyte; i<=endbyte; i++) {
AzqDev 3:10112b6b8d3c 56 if ( color == NULL || color[i] == 0 )
AzqDev 5:2f315f806f0c 57 printf("%02x ", buffer[i]);
AzqDev 3:10112b6b8d3c 58 else
AzqDev 5:2f315f806f0c 59 #define USE_IQS_COLOR_DISPLAY
AzqDev 5:2f315f806f0c 60 #ifndef DONT_USE_IQS_COLOR_DISPLAY
AzqDev 5:2f315f806f0c 61 printf("\x1b[32m%02x\x1b[30m ", buffer[i]); // print out in green (ANSI VT100 code)
AzqDev 5:2f315f806f0c 62 #else
AzqDev 5:2f315f806f0c 63 printf("%02x ", buffer[i]); // print out in black & white
AzqDev 5:2f315f806f0c 64 #endif
AzqDev 5:2f315f806f0c 65 }
AzqDev 5:2f315f806f0c 66 }
AzqDev 3:10112b6b8d3c 67
AzqDev 0:6a124fa2a919 68 // formatted hex display of IQS621 registers
AzqDev 5:2f315f806f0c 69 void IQS621Display::showRegisters(char * buffer, char * color, bool showAllRegisters)
AzqDev 5:2f315f806f0c 70 {
AzqDev 5:2f315f806f0c 71 bool d = showAllRegisters; // if true show all 16 registers per line
AzqDev 7:2cb11d8fa4a8 72 printf("\r\n\r\n Device ID & Version (46) [00] "); showLine(buffer,color,0x00,d?0x0f:0x02);
AzqDev 7:2cb11d8fa4a8 73 printf("\r\n\r\n Events and Flags [10] "); showLine(buffer,color,0x10,d?0x1f:0x1e);
AzqDev 7:2cb11d8fa4a8 74 printf("\r\n\r\n Channels 0-6 Raw Values [20] "); showLine(buffer,color,0x20,d?0x2f:0x2d);
AzqDev 7:2cb11d8fa4a8 75 printf("\r\n\r\n Long Term Average Data [30] "); showLine(buffer,color,0x30,d?0x3f:0x33);
AzqDev 7:2cb11d8fa4a8 76 printf("\r\n\r\n Proxfusion Settings [40] "); showLine(buffer,color,0x40,d?0x4f:0x4d);
AzqDev 7:2cb11d8fa4a8 77 printf("\r\n\r\n Proxfusion Thresholds [50] "); showLine(buffer,color,0x50,d?0x5f:0x54);
AzqDev 7:2cb11d8fa4a8 78 printf("\r\n\r\n Metal Detect Threshold [60] "); showLine(buffer,color,0x60,d?0x6f:0x63);
AzqDev 7:2cb11d8fa4a8 79 printf("\r\n\r\n Ambient Light Settings [70] "); showLine(buffer,color,0x70,d?0x7f:0x73);
AzqDev 7:2cb11d8fa4a8 80 printf("\r\n\r\n Ambient Light Thresholds [80] "); showLine(buffer,color,0x80,d?0x8f:0x83);
AzqDev 7:2cb11d8fa4a8 81 printf("\r\n\r\n Hall Sensor Settings [90] "); showLine(buffer,color,0x90,d?0x9f:0x93);
AzqDev 7:2cb11d8fa4a8 82 printf("\r\n\r\n Hall Switch Thresholds [A0] "); showLine(buffer,color,0xa0,d?0xaf:0xa2);
AzqDev 7:2cb11d8fa4a8 83 printf("\r\n\r\n Temperature Cal/Limits [C0] "); showLine(buffer,color,0xc0,d?0xcf:0xc3);
AzqDev 7:2cb11d8fa4a8 84 printf("\r\n\r\n Device & Power Settings [D0] "); showLine(buffer,color,0xd0,d?0xdf:0xd7);
AzqDev 0:6a124fa2a919 85 printf("\r\n\r\n");
AzqDev 0:6a124fa2a919 86 }