RIOT/tests/drivers/pca9685/main.c

/*
 * Copyright (C) 2018 Gunar Schorcht
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */

/**
 * @ingroup     tests
 * @brief       Test application for the PCA9685 I2C PWM controller
 * @author      Gunar Schorcht <gunar@schorcht.net>
 * @file
 *
 * ## Overview
 *
 * This test application demonstrates the usage of the PCA9685 driver interface
 * and can be used to test each PCA9685 PWM device with shell commands.
 *
 * The application bases on the test application for PWM peripheral drivers
 * which is under following copyright:
 *
 *      Copyright (C) 2014-2015 Freie Universität Berlin
 *      @author Hauke Petersen <hauke.petersen@fu-berlin.de>
 *      @author Semjon Kerner <semjon.kerner@fu-berlin.de>
 *
 * ## Usage
 *
 * To use the test application, compile it with
 *
 *      make -C tests/drivers/pca9685 BOARD=...
 *
 * Please check the default configuration parameters in
 * `$(RIOTBASE)/drivers/pca9685/include/pca9685_params.h` and adopt them
 * if necessary.
 *
 * If the active LOW output enable pin /OE is used, the GPIO has to be defined
 * as parameter, e.g.
 *
 *      CFLAGS="-DPCA9685_PARAM_INT_PIN=\(GPIO\(0,6\)\)" \
 *      make -C tests/drivers/pca9685 BOARD=...
 */

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <limits.h>

#include "xtimer.h"
#include "shell.h"
#include "timex.h"

#include "pca9685.h"
#include "pca9685_params.h"

#define OSC_INTERVAL    (10LU * US_PER_MS) /* 10 ms */
#define OSC_STEP        (10)
#define OSC_MODE        PWM_LEFT
#define OSC_FREQU       (1000U)
#define OSC_STEPS       (1000U)
#define PWR_SLEEP       (1U)

/* Number of configured PCA9685 I/O expander devices */
#define PCA9685_NUMOF   ARRAY_SIZE(pca9685_params)

/* PCA9685 devices allocation */
pca9685_t pca9685_dev[PCA9685_NUMOF];

static uint32_t initiated;

static unsigned _get_dev(const char *dev_str)
{
    unsigned dev = atoi(dev_str);
    if (dev >= PCA9685_NUMOF) {
        printf("Error: PWM device %u is unknown\n", dev);
        return UINT_MAX;
    }

    return dev;
}

static int _init(int argc, char** argv)
{
    if (argc != 5) {
        printf("usage: %s <dev> <mode> <frequency> <resolution>\n", argv[0]);
        printf("\tdev: device by number between 0 and %u\n", PCA9685_NUMOF - 1);
        puts("\tmode:\n");
        puts("\t\t0: left aligned\n");
        puts("\t\t1: right aligned\n");
        puts("\t\t2: center aligned\n");
        puts("\tfrequency: desired frequency in Hz\n");
        puts("\tresolution: number between 2 and 65535");
        return 1;
    }

    unsigned dev = _get_dev(argv[1]);
    if (dev == UINT_MAX) {
        return 1;
    }

    pwm_mode_t pwm_mode;
    switch(atoi(argv[2])) {
        case(0):
            pwm_mode = PWM_LEFT;
            break;
        case(1):
            pwm_mode = PWM_RIGHT;
            break;
        case(2):
            pwm_mode = PWM_CENTER;
            break;
        default:
            printf("Error: mode %d is not supported.\n", atoi(argv[2]));
            return 1;
    }

    uint32_t pwm_freq = pca9685_pwm_init(&pca9685_dev[dev], pwm_mode,
                                         (uint32_t)atoi(argv[3]),
                                         (uint16_t)atoi(argv[4]));
    if (pwm_freq != 0) {
        printf("The pwm frequency is set to %" PRIu32 "\n", pwm_freq);
        initiated |= (1 << dev);
        return 0;
    }

    puts("Error: device is not initiated");
    return 1;
}

static int _set(int argc, char**argv)
{
    if (argc != 4) {
        printf("usage: %s <dev> <ch> <val>\n", argv[0]);
        printf("\tdev: device by number between 0 and %d\n", PCA9685_NUMOF - 1);
        puts("\tch: channel of device (if 16, all channels are set)\n");
        puts("\tval: duty cycle\n");
        return 1;
    }

    unsigned dev = _get_dev(argv[1]);
    if (dev == UINT_MAX) {
        return 1;
    }

    if ((initiated & (1 << dev)) == 0) {
        puts("Error: pwm is not initiated.\n");
        puts("Execute init function first.\n");
        return 1;
    }

    uint8_t chan = atoi(argv[2]);
    if (chan > pca9685_pwm_channels(&pca9685_dev[dev])) {
        printf("Error: channel %d is unknown.\n", chan);
        return 1;
    }

    pca9685_pwm_set(&pca9685_dev[dev], chan, (uint16_t)atoi(argv[3]));
    return 0;
}

static int _oscillate(int argc, char** argv)
{
    (void)argc;
    (void)argv;

    int state = 0;
    int step = OSC_STEP;
    xtimer_ticks32_t last_wakeup = xtimer_now();

    puts("\nRIOT PWM test");
    puts("Connect an LED or scope to PWM pins to see something.\n");

    printf("Available PWM device between 0 and %d\n", PCA9685_NUMOF - 1);
    for (unsigned i = 0; i < PCA9685_NUMOF; i++) {
        uint32_t real_f = pca9685_pwm_init(&pca9685_dev[i], OSC_MODE, OSC_FREQU, OSC_STEPS);
        if (real_f == 0) {
            printf("Error: initializing PWM device %u.\n", i);
            return 1;
        }
        else {
            printf("Initialized PWM device %u @ %" PRIu32 "Hz.\n", i, real_f);
        }
    }

    puts("\nLetting the PWM pins oscillate now...");
    while (1) {
        for (unsigned i = 0; i < PCA9685_NUMOF; i++) {
            for (uint8_t chan = 0; chan < pca9685_pwm_channels(&pca9685_dev[i]); chan++) {
                pca9685_pwm_set(&pca9685_dev[i], chan, state);
            }
        }

        state += step;
        if (state <= 0 || state >= (int)OSC_STEPS) {
            step = -step;
        }

        xtimer_periodic_wakeup(&last_wakeup, OSC_INTERVAL);
    }

    return 0;
}

static int _power(int argc, char** argv)
{
    if (argc != 3) {
        printf("usage: %s <dev> <state>\n", argv[0]);
        printf("\tdev: device by number between 0 and %d\n", PCA9685_NUMOF - 1);
        puts("\tstate:\n");
        puts("\t\t0: power off\n");
        puts("\t\t1: power on\n");
        return 1;
    }

    unsigned dev = _get_dev(argv[1]);
    if (dev == UINT_MAX) {
        return 1;
    }

    switch (atoi(argv[2])) {
        case (0):
            puts("Powering down PWM device.\n");
            pca9685_pwm_poweroff(&pca9685_dev[dev]);
            break;
        case (1):
            puts("Powering up PWM device.\n");
            pca9685_pwm_poweron(&pca9685_dev[dev]);
            break;
        default:
            puts("Error: power state not available.\n");
            return 1;
    }
    return 0;
}

static int _power_test(int argc, char** argv)
{
    if (argc != 2) {
        printf("usage: %s <dev>\n", argv[0]);
        printf("\tdev: device by number between 0 and %d\n", PCA9685_NUMOF - 1);
        return 1;
    }

    unsigned dev = _get_dev(argv[1]);
    if (dev == UINT_MAX) {
        return 1;
    }

    printf("Powering down PWM device and sleeping for %u second(s)...\n",
           PWR_SLEEP);
    pca9685_pwm_poweroff(&pca9685_dev[dev]);

    xtimer_sleep(PWR_SLEEP);

    puts("Powering up PWM device.\n");
    pca9685_pwm_poweron(&pca9685_dev[dev]);

    return 0;
}

static const shell_command_t shell_commands[] = {
    { "init", "initial pwm configuration", _init },
    { "set", "set pwm duty cycle", _set },
    { "power", "set pwm power", _power },
    { "powertest", "test power on/off functions", _power_test },
    { "osci", "blocking, default oscillation test", _oscillate },
    { NULL, NULL, NULL }
};

int main(void)
{
    puts("PWM peripheral driver test\n");
    initiated = 0;

    /* initialize configured PCA9685 devices */
    for (unsigned i = 0; i < PCA9685_NUMOF; i++) {
        if (pca9685_init(&pca9685_dev[i], &pca9685_params[i]) != PCA9685_OK) {
            puts("[Failed]");
            return 1;
        }
    }
    char line_buf[SHELL_DEFAULT_BUFSIZE];
    shell_run(shell_commands, line_buf, SHELL_DEFAULT_BUFSIZE);

    return 0;
}