Beginner
10 min

Achieve limitless control with AS5013 and PIC18F57Q43

Tiny but mighty!

Joystick Click with Curiosity Nano with PIC18F57Q43

Published Feb 13, 2024

Click board™

Joystick Click

Dev Board

Curiosity Nano with PIC18F57Q43

Compiler

NECTO Studio

MCU

PIC18F57Q43

Control devices or systems by moving a knob in different directions

A

A

Hardware Overview

How does it work?

Joystick Click is based on the AS5013 and N50P105, a miniature magnetic joystick module, and a complete hall sensor IC from ams AG. The N50P105 represents a smart navigation key concept based on contactless magnetic movement detection. That's precisely why this Click board™ is characterized by high reliability due to magnetic contact-less sensing. On the other hand, the two-dimensional linear encoder AS5013, mounted into the joystick, directly provides the X and Y coordinate through an I2C interface, thus forming a high-quality joystick. The AS5013 includes five integrated Hall sensing elements for detecting up to

±2mm lateral displacement, high-resolution ADC, XY coordinate, and motion detection engine combined with a smart power management controller. The X and Y positions coordinate, and magnetic field information for each Hall sensor element is transmitted over a 2-wire I2C compliant interface to the host MCU with a maximum clock frequency of 3.4MHz. Also, the AS5013 allows choosing the least significant bit (LSB) of its I2C slave address using the SMD jumper labeled I2C ADD. Also, an additional feature of this board represents an integrated mechanical push button built into the N50P105 joystick providing a "Select"

function that can be digitally tracked via the CS pin on the mikroBUS™ socket marked as TST. Alongside its interrupt feature routed to the INT pin of the mikroBUS™ socket, the AS5013 also provides an active-low Reset function routed to the RST pin on the mikroBUS™ socket. This Click board™ can only be operated with a 3.3V logic voltage level. The board must perform appropriate logic voltage level conversion before using MCUs with different logic levels. However, the Click board™ comes equipped with a library containing functions and an example code that can be used as a reference for further development.

Joystick Click hardware overview image

Features overview

Development board

PIC18F57Q43 Curiosity Nano evaluation kit is a cutting-edge hardware platform designed to evaluate microcontrollers within the PIC18-Q43 family. Central to its design is the inclusion of the powerful PIC18F57Q43 microcontroller (MCU), offering advanced functionalities and robust performance. Key features of this evaluation kit include a yellow user LED and a responsive

mechanical user switch, providing seamless interaction and testing. The provision for a 32.768kHz crystal footprint ensures precision timing capabilities. With an onboard debugger boasting a green power and status LED, programming and debugging become intuitive and efficient. Further enhancing its utility is the Virtual serial port (CDC) and a debug GPIO channel (DGI

GPIO), offering extensive connectivity options. Powered via USB, this kit boasts an adjustable target voltage feature facilitated by the MIC5353 LDO regulator, ensuring stable operation with an output voltage ranging from 1.8V to 5.1V, with a maximum output current of 500mA, subject to ambient temperature and voltage constraints.

PIC18F57Q43 Curiosity Nano double side image

Microcontroller Overview

MCU Card / MCU

default

Architecture

PIC

MCU Memory (KB)

128

Silicon Vendor

Microchip

Pin count

48

RAM (Bytes)

8196

You complete me!

Accessories

Curiosity Nano Base for Click boards is a versatile hardware extension platform created to streamline the integration between Curiosity Nano kits and extension boards, tailored explicitly for the mikroBUS™-standardized Click boards and Xplained Pro extension boards. This innovative base board (shield) offers seamless connectivity and expansion possibilities, simplifying experimentation and development. Key features include USB power compatibility from the Curiosity Nano kit, alongside an alternative external power input option for enhanced flexibility. The onboard Li-Ion/LiPo charger and management circuit ensure smooth operation for battery-powered applications, simplifying usage and management. Moreover, the base incorporates a fixed 3.3V PSU dedicated to target and mikroBUS™ power rails, alongside a fixed 5.0V boost converter catering to 5V power rails of mikroBUS™ sockets, providing stable power delivery for various connected devices.

Curiosity Nano Base for Click boards accessories 1 image

Used MCU Pins

mikroBUS™ mapper

NC
NC
AN
Reset
PA7
RST
Pushbutton Detection
PD4
CS
NC
NC
SCK
NC
NC
MISO
NC
NC
MOSI
Power Supply
3.3V
3.3V
Ground
GND
GND
NC
NC
PWM
Interrupt
PA6
INT
NC
NC
TX
NC
NC
RX
I2C Clock
PB2
SCL
I2C Data
PB1
SDA
NC
NC
5V
Ground
GND
GND
1

Take a closer look

Schematic

Joystick Click Schematic schematic

Step by step

Project assembly

Curiosity Nano Base for Click boards front image hardware assembly

Start by selecting your development board and Click board™. Begin with the Curiosity Nano with PIC18F57Q43 as your development board.

Curiosity Nano Base for Click boards front image hardware assembly
Charger 27 Click front image hardware assembly
PIC18F47Q10 Curiosity Nano front image hardware assembly
Prog-cut hardware assembly
Charger 27 Click complete accessories setup image hardware assembly
Curiosity Nano with PICXXX Access MB 1 - upright/background hardware assembly
Necto image step 2 hardware assembly
Necto image step 3 hardware assembly
Necto image step 4 hardware assembly
Necto image step 5 hardware assembly
Necto image step 6 hardware assembly
PIC18F57Q43 Curiosity MCU Step hardware assembly
Necto No Display image step 8 hardware assembly
Necto image step 9 hardware assembly
Necto image step 10 hardware assembly
Debug Image Necto Step hardware assembly

Track your results in real time

Application Output via Debug Mode

1. Once the code example is loaded, pressing the "DEBUG" button initiates the build process, programs it on the created setup, and enters Debug mode.

2. After the programming is completed, a header with buttons for various actions within the IDE becomes visible. Clicking the green "PLAY" button starts reading the results achieved with the Click board™. The achieved results are displayed in the Application Output tab.

DEBUG_Application_Output

Software Support

Library Description

This library contains API for Joystick Click driver.

Key functions:

  • joystick_get_position - Get joystick position function

  • joystick_press_button - Get state of Joystick button function

  • joystick_soft_reset - General soft reset function

Open Source

Code example

This example can be found in NECTO Studio. Feel free to download the code, or you can copy the code below.

/*!
 * \file 
 * \brief Joystick Click example
 * 
 * # Description
 * This application configures and enables use of the joystick.
 *
 * The demo application is composed of two sections :
 * 
 * ## Application Init 
 * Initialization driver enables - device,
 *  sets default configuration and starts write log.
 * 
 * ## Application Task  
 * (code snippet) This is a example which demonstrates the use of Joystick Click board.
 * Joystick Click communicates with register via I2C by write and read from register,
 * read joystick position and press button state.
 * Results are being sent to the Usart Terminal where you can track their changes.
 * All data logs on usb uart when the sensor is triggered.
 * 
 * 
 * \author MikroE Team
 *
 */
// ------------------------------------------------------------------- INCLUDES

#include "board.h"
#include "log.h"
#include "joystick.h"

// ------------------------------------------------------------------ VARIABLES

static joystick_t joystick;
static log_t logger;

uint8_t position;
uint8_t button_state;
uint8_t position_old = 1;
uint8_t button_state_old = 1;

// ------------------------------------------------------ APPLICATION FUNCTIONS

void application_init ( void )
{
    log_cfg_t log_cfg;
    joystick_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, "---- Application Init ----" );

    //  Click initialization.

    joystick_cfg_setup( &cfg );
    JOYSTCIK_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    joystick_init( &joystick, &cfg );

    Delay_ms( 100 );

    joystick_default_cfg( &joystick );

    log_printf( &logger,  "*********************\r\n" );
    log_printf( &logger,  "    Configuration    \r\n" );
    log_printf( &logger,  "*********************\r\n" );
    log_printf( &logger,  "    Joystick Click   \r\n" );
    log_printf( &logger,  "*********************\r\n" );

    Delay_ms( 100 );
}

void application_task ( void ) 
{
    //  Task implementation.

    button_state = joystick_press_button( &joystick );

    position = joystick_get_position( &joystick );

    Delay_ms( 10 );

    if ( ( button_state == 1 ) && ( button_state_old == 0 ) )
    {
        button_state_old = 1;

        log_printf( &logger, "  Button is pressed \r\n" );
        log_printf( &logger, "*********************\r\n" );
    }

    if ( ( button_state == 0 ) && ( button_state_old == 1 ) )
    {
        button_state_old = 0;
    }

    if ( position_old != position )
    {
        switch ( position )
        {
            case 0 :
            {
                log_printf( &logger,"    Start position    \r\n" );
                break;
            }
            case 1 :
            {
                log_printf( &logger, "         Top    \r\n" );
                break;
            }
            case 2 :
            {
                log_printf( &logger, "      Top-Right    \r\n" );
                break;
            }
            case 3 :
            {
                log_printf( &logger, "        Right    \r\n" );
                break;
            }
            case 4 :
            {
                log_printf( &logger, "     Bottom-Right    \r\n" );
                break;
            }
            case 5 :
            {
                log_printf( &logger, "        Bottom    \r\n" );
                break;
            }
            case 6 :
            {
                log_printf( &logger, "     Bottom-Left    \r\n" );
                break;
            }
            case 7 :
            {
                log_printf( &logger, "         Left    \r\n" );
                break;
            }
            case 8 :
            {
                log_printf( &logger, "       Top-Left    \r\n" );
                break;
            }
        }

        log_printf( &logger, "*********************\r\n" );

        position_old = position;

        Delay_ms( 100 );
    }
}

void main ( void )
{
    application_init( );

    for ( ; ; )
    {
        application_task( );
    }
}


// ------------------------------------------------------------------------ END

Additional Support

Resources

Love this project?

'Buy This Kit' button takes you directly to the shopping cart where you can easily add or remove products.