Azoteq / IQSDisplayTerminal

Azoteq IQS624 Serial Terminal Display Class

Dependents:   IQS624_HelloWorld Nucleo_ACM1602_I2C_DC_Angle

Library: IQSDisplayTerminal

Library for formatted display of IQS624 registers on a serial terminal

Screen Capture

Below is a screen capture of formatted output on a serial terminal program.
Note that over a million frames were captured with zero I2C errors. /media/uploads/AzqDev/iqs624-display-screencap-1m.gif

IQS624 Summary

Ultra low power I2C sensor for 2D Magnetic Angle, Capacitive touch and Inductive Proximity

IQS624 mbed Component Link

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


IQS624 Pinout

/media/uploads/AzqDev/iqs624-pinout-s3.gif

/media/uploads/AzqDev/iqs624-and-lpc1768-tiny.gif

IQS624 Connected to mbed LPC1768 board. The five wires are power(2), I2C(2) and RDY(1).

IQS624 Data Sheet

Azoteq IQS624 Data sheet & Evaluation Kit Information: http://bit.ly/IQS624_ds



IQS624 YouTube Link

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

IQSdisplayTerminal.cpp@5:9d903309117c, 2017-02-08 (annotated)

Committer:
AzqDev
Date:
Wed Feb 08 01:38:14 2017 +0000
Revision:
5:9d903309117c
Parent:
3:7932615d9349
Child:
6:9814a972e4bf
Added youtube link

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AzqDev 0:77730e5a870b 1 // A class library to display Azoteq IQS62x registers on a terminal
AzqDev 3:7932615d9349 2
AzqDev 1:1c22cfb8b555 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 1:1c22cfb8b555 4
AzqDev 3:7932615d9349 5 // More info on IQS624 sensor IC: http://bit.ly/IQS624_info
AzqDev 3:7932615d9349 6
AzqDev 5:9d903309117c 7 // IQS624 1-minute youtube video: http://bit.ly/IQS624-video
AzqDev 5:9d903309117c 8
AzqDev 0:77730e5a870b 9 #include "IQSdisplayTerminal.h"
AzqDev 0:77730e5a870b 10
AzqDev 2:1403d6a6af7b 11 // constructor
AzqDev 2:1403d6a6af7b 12 #if defined(TARGET_TEENSY3_1) || defined (TARGET_TEENSY3_2) || IQS_USE_USBSERIAL
AzqDev 2:1403d6a6af7b 13 IQS62xDisplay::IQS62xDisplay() : USBSerial() // use our own USB device stack
AzqDev 2:1403d6a6af7b 14 #else
AzqDev 2:1403d6a6af7b 15 IQS62xDisplay::IQS62xDisplay() : Serial(USBTX,USBRX) // use mbed default serial port
AzqDev 2:1403d6a6af7b 16 #endif
AzqDev 1:1c22cfb8b555 17
AzqDev 2:1403d6a6af7b 18 {
AzqDev 0:77730e5a870b 19 frameCounter=0;
AzqDev 2:1403d6a6af7b 20 baud(DISPLAY_BAUD_RATE);
AzqDev 0:77730e5a870b 21 }
AzqDev 0:77730e5a870b 22
AzqDev 2:1403d6a6af7b 23 #if defined(TARGET_TEENSY3_1) || defined (TARGET_TEENSY3_2) || IQS_USE_USBSERIAL
AzqDev 2:1403d6a6af7b 24 void IQS62xDisplay::baud(int baudRate){}
AzqDev 2:1403d6a6af7b 25 #endif
AzqDev 2:1403d6a6af7b 26
AzqDev 0:77730e5a870b 27 // display a startup message to serial port
AzqDev 0:77730e5a870b 28 void IQS62xDisplay::helloMessage(bool waitForUser) {
AzqDev 0:77730e5a870b 29 puts("\x1b[2J \x1b[?25l \x1b[H"); // ANSII/VT100 codes to clear screen, invisible cursor, home cursor
AzqDev 0:77730e5a870b 30 printf(" IQS62x Register Display\r\n\r\n");
AzqDev 0:77730e5a870b 31 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:77730e5a870b 32 printf("Handy hint - In many terminal programs, Alt-B (break) will reset your Nucleo Board.\r\n\r\n");
AzqDev 0:77730e5a870b 33 printf("Press any key to continue...\r\n");
AzqDev 2:1403d6a6af7b 34 if ( waitForUser ) while( ! readable() ); // wait for keypress to continue
AzqDev 0:77730e5a870b 35 puts("\x1b[2J \x1b[?25l \x1b[H"); // ANSII/VT100 codes to clear screen, invisible cursor, home cursor
AzqDev 0:77730e5a870b 36 }
AzqDev 0:77730e5a870b 37
AzqDev 0:77730e5a870b 38 // show headings and I2C error count
AzqDev 0:77730e5a870b 39 void IQS62xDisplay::showStatus(int I2Cspeed, int I2CErrorCount) {
AzqDev 0:77730e5a870b 40 frameCounter++;
AzqDev 0:77730e5a870b 41 puts("\x1b[H"); // ANSI/VT100 command for cursor home
AzqDev 0:77730e5a870b 42 printf("\t\t\t");
AzqDev 0:77730e5a870b 43 printf("\t IQS62x Register Display\r\n\r\n"); // heading
AzqDev 0:77730e5a870b 44 printf("\t Frame number %06d", frameCounter);
AzqDev 0:77730e5a870b 45 printf("\t I2C Speed %dk", I2Cspeed/1000);
AzqDev 0:77730e5a870b 46 printf("\t I2C Errors %d", I2CErrorCount);
AzqDev 0:77730e5a870b 47 }
AzqDev 0:77730e5a870b 48
AzqDev 0:77730e5a870b 49 // formatted hex display of IQS62x registers
AzqDev 0:77730e5a870b 50 void IQS62xDisplay::showRegisters(char * buffer) {
AzqDev 0:77730e5a870b 51 #define ShowLine(FROM,TO) for(int j=(FROM);j<=(TO);j++)printf("%02x ",buffer[j])
AzqDev 0:77730e5a870b 52 printf("\r\n\r\n Device ID [00] "); ShowLine(0x00,0x0f);
AzqDev 0:77730e5a870b 53 printf("\r\n\r\n System Flags [10] "); ShowLine(0x10,0x1f);
AzqDev 0:77730e5a870b 54 printf("\r\n\r\n Counters [20] "); ShowLine(0x20,0x2f);
AzqDev 0:77730e5a870b 55 printf("\r\n\r\n Averages [30] "); ShowLine(0x30,0x3f);
AzqDev 0:77730e5a870b 56 printf("\r\n\r\n Touch Setup [40] "); ShowLine(0x40,0x4f);
AzqDev 0:77730e5a870b 57 printf("\r\n\r\n Touch Threshold [50] "); ShowLine(0x50,0x5f);
AzqDev 0:77730e5a870b 58 printf("\r\n\r\n Small Usr Setup [60] "); ShowLine(0x60,0x6f);
AzqDev 0:77730e5a870b 59 printf("\r\n\r\n Hall Settings [70] "); ShowLine(0x70,0x7f);
AzqDev 0:77730e5a870b 60 printf("\r\n\r\n Wheel Values [80] "); ShowLine(0x80,0x8f);
AzqDev 0:77730e5a870b 61 printf("\r\n\r\n System Setup [d0] "); ShowLine(0xd0,0xdf);
AzqDev 0:77730e5a870b 62 printf("\r\n\r\n");
AzqDev 0:77730e5a870b 63 }