Achieve high-quality scanning and printing results with TSL3301CL and TM4C129ENCPDT
Affordable excellence in scanning and printing
Published Nov 08, 2023
Click board™
Scanner Click
Dev. board
Fusion for Tiva v8
Compiler
NECTO Studio
MCU
TM4C129ENCPDT
Make scanning and printing a breeze with our user-friendly optical scanning solution, delivering precise results for all your needs.
A
A
Hardware Overview
How does it work?
Scanner Click is based on the TSL3301CL, 102 × 1 linear optical sensor array with onboard A/D conversion from ams OSRAM. The sensor consists of 102 photodiodes, also called pixels, arranged in a linear array. Light energy impinging on a pixel generates a photocurrent, which is then integrated by the active integration circuitry associated with that pixel. During the integration period, a sampling capacitor connects to the output of the integrator through an analog switch. The amount of charge accumulated at each pixel is directly proportional to the light intensity on that pixel and to the integration time. Integration, sampling, output, and reset of the integrators are performed by the control logic in response to commands input via the SDI serial data input pin on the mikroBUS™. Data is then read out on the SDO serial data output pin. A normal sequence of operation consists of a pixel reset, start of integration, integration period, sampling of integrators, and pixel output. Reset sets all the integrators to zero.
Start of integration releases the integrators from the reset state and defines the beginning of the integration period. Sampling the integrators ends the integration period and stores the charge accumulated in each pixel in a sample and hold circuit. Reading the pixels causes the sampled value of each pixel to be converted to 8-bit digital format and output on the SDO serial data output pin. All 102 pixels are output sequentially unless interrupted by an abort command or reset command. Gain adjustment is controlled by three 5-bit DACs, one for each of the the three zones, while offset correction is controlled by three 8-bit sign-magnitude DACs and is performed in the analog domain prior to the digital conversion. There is a separate offset DAC for each of the three zones, where codes 0h - 7Fh correspond to positive offset values and codes 80h – FFh correspond to negative offset values. The programmed offset correction is applied to the sampled energy, and then the gain is applied (i.e. the gain will affect the offset correction). This Click board™
communicates over a serial digital interface (SPI serial interface) that follows a USART format, with start bit, 8 data bits, and one or more stop bits. Data is clocked in synchronously on the rising edge of system clock from SCK pin on the mikroBUS™ and clocked out on the falling edge of system clock. When clocking data out continuously (i.e. reading out pixels) there will be one stop bit between data words. The receive and transmit state machines are independent, which means commands can be issued while reading data. This feature allows starting new integration cycles while reading data. This Click board™ can operate with either 3.3V or 5V logic voltage levels selected via the VCC SEL jumper. This way, both 3.3V and 5V capable MCUs can use the communication lines properly. Also, this Click board™ comes equipped with a library containing easy-to-use functions and an example code that can be used as a reference for further development.
Features overview
Development board
Fusion for TIVA v8 is a development board specially designed for the needs of rapid development of embedded applications. It supports a wide range of microcontrollers, such as different 32-bit ARM® Cortex®-M based MCUs from Texas Instruments, regardless of their number of pins, and a broad set of unique functions, such as the first-ever embedded debugger/programmer over a WiFi network. The development board is well organized and designed so that the end-user has all the necessary elements, such as switches, buttons, indicators, connectors, and others, in one place. Thanks to innovative manufacturing technology, Fusion for TIVA v8 provides a fluid and immersive working experience, allowing access
anywhere and under any circumstances at any time. Each part of the Fusion for TIVA v8 development board contains the components necessary for the most efficient operation of the same board. An advanced integrated CODEGRIP programmer/debugger module offers many valuable programming/debugging options, including support for JTAG, SWD, and SWO Trace (Single Wire Output)), and seamless integration with the Mikroe software environment. Besides, it also includes a clean and regulated power supply module for the development board. It can use a wide range of external power sources, including a battery, an external 12V power supply, and a power source via the USB Type-C (USB-C) connector.
Communication options such as USB-UART, USB HOST/DEVICE, CAN (on the MCU card, if supported), and Ethernet is also included. In addition, it also has the well-established mikroBUS™ standard, a standardized socket for the MCU card (SiBRAIN standard), and two display options for the TFT board line of products and character-based LCD. Fusion for TIVA v8 is an integral part of the Mikroe ecosystem for rapid development. Natively supported by Mikroe software tools, it covers many aspects of prototyping and development thanks to a considerable number of different Click boards™ (over a thousand boards), the number of which is growing every day.
Microcontroller Overview
MCU Card / MCU
Type
8th Generation
Architecture
ARM Cortex-M4
MCU Memory (KB)
1024
Silicon Vendor
Texas Instruments
Pin count
128
RAM (Bytes)
262144
Used MCU Pins
mikroBUS™ mapper
Take a closer look
Click board™ Schematic
Step by step
Project assembly
Start by selecting your development board and Click board™. Begin with the Fusion for Tiva v8 as your development board.
Software Support
Library Description
This library contains API for Scanner Click driver.
Key functions:
scanner_clock- Pulse function.scanner_serial_write_reg- Write function.scanner_read_pixel- Read pixels.
Open Source
Code example
The complete application code and a ready-to-use project are available through the NECTO Studio Package Manager for direct installation in the NECTO Studio. The application code can also be found on the MIKROE GitHub account.
/*!
* \file
* \brief Scanner Click example
*
* # Description
* This example reads data from Scanner Clicks.
*
* The demo application is composed of two sections :
*
* ## Application Init
* Initializes the driver and starts up the module.
*
* ## Application Task
* Reads the array of 102 pixels and displays the results on the USB UART
* as frequently as possible.
*
* \author MikroE Team
*
*/
// ------------------------------------------------------------------- INCLUDES
#include "board.h"
#include "log.h"
#include "scanner.h"
// ------------------------------------------------------------------ VARIABLES
static scanner_t scanner;
static log_t logger;
// ------------------------------------------------------ APPLICATION FUNCTIONS
void application_init ( void )
{
log_cfg_t log_cfg;
scanner_cfg_t cfg;
/**
* Logger initialization.
* Default baud rate: 115200
* Default log level: LOG_LEVEL_DEBUG
* @note If USB_UART_RX and USB_UART_TX
* are defined as HAL_PIN_NC, you will
* need to define them manually for log to work.
* See @b LOG_MAP_USB_UART macro definition for detailed explanation.
*/
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, "--->>> APP INIT <<<---\r\n" );
// Click initialization.
scanner_cfg_setup( &cfg );
SCANNER_MAP_MIKROBUS( cfg, MIKROBUS_1 );
scanner_init( &scanner, &cfg );
Delay_ms ( 300 );
scanner_startup( &scanner );
Delay_ms ( 100 );
scanner_serial_write_reg( &scanner, SCANNER_REG_MODE, SCANNER_DATA_NORMAL_MODE );
for ( uint8_t data_cnt = 0; data_cnt < 3; )
{
scanner_serial_write_reg( &scanner, SCANNER_REG_OFFSET_LEFT + ( 2 * data_cnt ), 25 );
data_cnt++;
scanner_serial_write_reg( &scanner, SCANNER_REG_GAIN_LEFT + ( 2 * data_cnt ), 25 );
data_cnt++;
}
log_printf( &logger, "--->>> APP TASK <<<--- \r\n" );
}
void application_task ( void )
{
uint8_t pixels[ 102 ];
scanner_read_pixel( &scanner, pixels );
log_printf( &logger, "left center right\r\n" );
for ( uint8_t cnt = 0; cnt < 34; cnt++ )
{
log_printf( &logger, " %u %u %u \r\n", ( uint16_t ) pixels[ cnt ],
( uint16_t ) pixels[ cnt + 34 ],
( uint16_t ) pixels[ cnt + 68 ] );
}
log_printf( &logger, "----------------\r\n" );
}
int main ( void )
{
/* Do not remove this line or clock might not be set correctly. */
#ifdef PREINIT_SUPPORTED
preinit();
#endif
application_init( );
for ( ; ; )
{
application_task( );
}
return 0;
}
// ------------------------------------------------------------------------ END
