inc_encoder_params.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2025 TU Dresden
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once
 
#include "board.h"
#include "inc_encoder.h"
#include "saul_reg.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef CONFIG_INC_ENCODER_GEAR_RED_RATIO
#  define CONFIG_INC_ENCODER_GEAR_RED_RATIO 204
#endif
 
#ifndef CONFIG_INC_ENCODER_PPR
#  define CONFIG_INC_ENCODER_PPR 13
#endif
 
#if IS_USED(MODULE_INC_ENCODER_HARDWARE)
#  ifndef CONFIG_INC_ENCODER_HARDWARE_PERIOD_MS
#    define CONFIG_INC_ENCODER_HARDWARE_PERIOD_MS 200
#  endif
#endif
 
#if IS_USED(MODULE_INC_ENCODER_SOFTWARE)
#  ifndef INC_ENCODER_INTERRUPT
#    define INC_ENCODER_INTERRUPT GPIO_PIN(1, 10)
#  endif
 
#  ifndef INC_ENCODER_DIRECTION
#    define INC_ENCODER_DIRECTION GPIO_PIN(1, 11)
#  endif
#endif /* IS_USED(MODULE_INC_ENCODER_SOFTWARE) */
 
#if IS_USED(MODULE_INC_ENCODER_HARDWARE)
#ifndef INC_ENCODER_QDEC_DEV
#  define INC_ENCODER_QDEC_DEV QDEC_DEV(0)
#endif
#endif /* IS_USED(MODULE_INC_ENCODER_HARDWARE) */
 
#if IS_USED(MODULE_INC_ENCODER_SOFTWARE)
#  ifndef INC_ENCODER_PARAMS
#    define INC_ENCODER_PARAMS { .interrupt = INC_ENCODER_INTERRUPT, \
                                 .direction = INC_ENCODER_DIRECTION }
#  endif
#elif IS_USED(MODULE_INC_ENCODER_HARDWARE)
 
#  ifndef INC_ENCODER_PARAMS
#    define INC_ENCODER_PARAMS { .qdec_dev = INC_ENCODER_QDEC_DEV }
#  endif
#endif
#ifndef INC_ENCODER_SAUL_INFO
#  define INC_ENCODER_SAUL_INFO { { .name = "Incremental Rotary Encoder RPM Sensor" }, \
                                  { .name = "Incremental Rotary Encoder Pulse Count Sensor" } }
#endif
 
static const inc_encoder_params_t inc_encoder_params[] =
{
    INC_ENCODER_PARAMS
};
 
static const saul_reg_info_t inc_encoder_saul_info[][2] =
{
    INC_ENCODER_SAUL_INFO
};
 
#ifdef __cplusplus
}
#endif