TOP Contributors

  1. MIKROE (2784 codes)
  2. Alcides Ramos (405 codes)
  3. Shawon Shahryiar (307 codes)
  4. jm_palomino (133 codes)
  5. Bugz Bensce (97 codes)
  6. S P (73 codes)
  7. dany (71 codes)
  8. MikroBUS.NET Team (35 codes)
  9. NART SCHINACKOW (34 codes)
  10. Armstrong Subero (27 codes)

Most Downloaded

  1. Timer Calculator (141697 times)
  2. FAT32 Library (74777 times)
  3. Network Ethernet Library (59218 times)
  4. USB Device Library (49226 times)
  5. Network WiFi Library (44999 times)
  6. FT800 Library (44536 times)
  7. GSM click (31200 times)
  8. mikroSDK (30103 times)
  9. microSD click (27586 times)
  10. PID Library (27540 times)
Libstock prefers package manager

Package Manager

We strongly encourage users to use Package manager for sharing their code on Libstock website, because it boosts your efficiency and leaves the end user with no room for error. [more info]

< Back
mikroSDK Library

Joystick Click

Rating:

0

Author: MIKROE

Last Updated: 2024-10-31

Package Version: 2.1.0.16

mikroSDK Library: 2.0.0.0

Category: Pushbutton/Switches

Downloaded: 403 times

Not followed.

License: MIT license  

Joystick Click is a smart navigation key concept based on contactless, magnetic movement detection.

No Abuse Reported

Do you want to subscribe in order to receive notifications regarding "Joystick Click" changes.

Do you want to unsubscribe in order to stop receiving notifications regarding "Joystick Click" changes.

Do you want to report abuse regarding "Joystick Click".

  • mikroSDK Library 1.0.0.0
  • Comments (0)

mikroSDK Library Blog


Joystick Click

Joystick Click is a smart navigation key concept based on contactless, magnetic movement detection.

joystick_click.png

Click Product page


Click library

  • Author : MikroE Team
  • Date : Nov 2019.
  • Type : I2C type

Software Support

We provide a library for the Joystick Click as well as a demo application (example), developed using MikroElektronika compilers. The demo can run on all the main MikroElektronika development boards.

Package can be downloaded/installed directly form compilers IDE(recommended way), or downloaded from our LibStock, or found on mikroE github account.

Library Description

This library contains API for Joystick Click driver.

Standard key functions :

  • Config Object Initialization function.

    void joystick_cfg_setup ( joystick_cfg_t *cfg );

  • Initialization function.

    JOYSTCIK_RETVAL joystick_init ( joystick_t ctx, joystick_cfg_t cfg );

  • Click Default Configuration function.

    void joystick_default_cfg ( joystick_t *ctx );

Example key functions :

  • Get joystick position function

    uint8_t joystick_get_position( joystick_t *ctx );

  • Get state of Joystick button function

    uint8_t joystick_press_button( joystick_t *ctx );

  • General soft reset function

    void joystick_soft_reset( joystick_t *ctx );

Examples 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.


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_100ms( );

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

Application Task

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.


void application_task ( void ) 
{
    //  Task implementation.

    button_state = joystick_press_button( &joystick );

    position = joystick_get_position( &joystick );

    Delay_10ms( );

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

The full application code, and ready to use projects can be installed directly form compilers IDE(recommneded) or found on LibStock page or mikroE GitHub accaunt.

Other mikroE Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.Joystick

Additional notes and informations

Depending on the development board you are using, you may need USB UART Click, USB UART 2 Click or RS232 Click to connect to your PC, for development systems with no UART to USB interface available on the board. The terminal available in all Mikroelektronika compilers, or any other terminal application of your choice, can be used to read the message.


ALSO FROM THIS AUTHOR

Boost 6 Click

0

The Boost 6 Click is a Click board™ which features the TPS55332-Q1, a monolithic high-voltage switching regulator with integrated 3-A, 60-V power MOSFET.

[Learn More]

SPI Isolator Click

0

The Click is designed to run on either 3.3V or 5V power supply. It communicates with the target microcontroller over SPI interface.

[Learn More]

LSM303AGR Click

0

LSM303AGR Click is a magnetometer and accelerometer device, capable of sensing both the magnetic and gravitational field along three orthogonal axes. It uses the LSM303AGR from STMicroelectronics, an integrated MEMS IC with plenty of features that allow accurate and reliable sensing, even in presence of foreign objects made of iron and similar materials that exhibit ferromagnetic behavior. An extensive interrupt engine can be programmed to generate an interrupt signal for free-falling events, motion detection, and magnetic field detection. The Click board™ can sense the magnetic field in the range of ±50 G (gauss) and ±2g, ±4g, ±8g, and ±16g selectable ranges for the full-scale acceleration detection (gravity force).

[Learn More]