Beginner
10 min

Achieve limitless control with AS5013 and STM32F413ZH

Tiny but mighty!

Joystick Click with Nucleo 144 with STM32F413ZH MCU

Published Feb 14, 2024

Click board™

Joystick Click

Dev. board

Nucleo 144 with STM32F413ZH MCU

Compiler

NECTO Studio

MCU

STM32F413ZH

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

Nucleo-144 with STM32F413ZH MCU board offers an accessible and adaptable avenue for users to explore new ideas and construct prototypes. It allows users to tailor their experience by selecting from a range of performance and power consumption features offered by the STM32 microcontroller. With compatible boards, the

internal or external SMPS dramatically decreases power usage in Run mode. Including the ST Zio connector, expanding ARDUINO Uno V3 connectivity, and ST morpho headers facilitate easy expansion of the Nucleo open development platform. The integrated ST-LINK debugger/programmer enhances convenience by

eliminating the need for a separate probe. Moreover, the board is accompanied by comprehensive free software libraries and examples within the STM32Cube MCU Package, further enhancing its utility and value.

Nucleo 144 with STM32F413ZH MCU double side image

Microcontroller Overview

MCU Card / MCU

default

Architecture

ARM Cortex-M4

MCU Memory (KB)

1536

Silicon Vendor

STMicroelectronics

Pin count

144

RAM (Bytes)

327680

You complete me!

Accessories

Click Shield for Nucleo-144 comes equipped with four mikroBUS™ sockets, with one in the form of a Shuttle connector, allowing all the Click board™ devices to be interfaced with the STM32 Nucleo-144 board with no effort. This way, MIKROE allows its users to add any functionality from our ever-growing range of Click boards™, such as WiFi, GSM, GPS, Bluetooth, ZigBee, environmental sensors, LEDs, speech recognition, motor control, movement sensors, and many more. Featuring an ARM Cortex-M microcontroller, 144 pins, and Arduino™ compatibility, the STM32 Nucleo-144 board offers limitless possibilities for prototyping and creating diverse applications. These boards are controlled and powered conveniently through a USB connection to program and efficiently debug the Nucleo-144 board out of the box, with an additional USB cable connected to the USB mini port on the board. Simplify your project development with the integrated ST-Link debugger and unleash creativity using the extensive I/O options and expansion capabilities. This Click Shield also has several switches that perform functions such as selecting the logic levels of analog signals on mikroBUS™ sockets and selecting logic voltage levels of the mikroBUS™ sockets themselves. Besides, the user is offered the possibility of using any Click board™ with the help of existing bidirectional level-shifting voltage translators, regardless of whether the Click board™ operates at a 3.3V or 5V logic voltage level. Once you connect the STM32 Nucleo-144 board with our Click Shield for Nucleo-144, you can access hundreds of Click boards™, working with 3.3V or 5V logic voltage levels.

Click Shield for Nucleo-144 accessories 1 image

Used MCU Pins

mikroBUS™ mapper

NC
NC
AN
Reset
PA13
RST
Pushbutton Detection
PA4
CS
NC
NC
SCK
NC
NC
MISO
NC
NC
MOSI
Power Supply
3.3V
3.3V
Ground
GND
GND
NC
NC
PWM
Interrupt
PF13
INT
NC
NC
TX
NC
NC
RX
I2C Clock
PF1
SCL
I2C Data
PF0
SDA
NC
NC
5V
Ground
GND
GND
1

Take a closer look

Click board™ Schematic

Joystick Click Schematic schematic

Step by step

Project assembly

Click Shield for Nucleo-144 accessories 1 image hardware assembly

Start by selecting your development board and Click board™. Begin with the Nucleo 144 with STM32F413ZH MCU as your development board.

Click Shield for Nucleo-144 accessories 1 image hardware assembly
Nucleo 144 with STM32F446ZE MCU front image hardware assembly
Charger 27 Click front image hardware assembly
Prog-cut hardware assembly
Charger 27 Click complete accessories setup image hardware assembly
Board mapper by product8 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
STM32F413ZH Nucleo 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

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

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 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 );
    }
}

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

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.