Utilities

Macros
#define	UTILS_DEBUG_LED_PIN   PB0
#define	TRASHCAN   ((void *)0)
#define	STATUS_ASSERT(status)
	Macro to assert a status and flash a debug LED.

Functions
uint8_t	utils_joystick_print_pos (struct io_joystick_position *pos)
	Prints joystick position (x/y) via UART.
uint8_t	utils_joystick_print_raw (struct io_joystick_device *dev)
	Prints raw ADC joystick readings via UART.
int16_t	map (uint8_t x, uint8_t in_min, uint8_t in_max, int16_t out_min, int16_t out_max)
	Maps a value from one range to another (taken from https://docs.arduino.cc/language-reference/en/functions/math/map/).

Detailed Description

Macro Definition Documentation

STATUS_ASSERT

#define STATUS_ASSERT

(

status

)

#include <utils.h>

Value:

  {                                                                            \
    DDRB |= (1 << UTILS_DEBUG_LED_PIN);                                        \
                                                                               \
    if (status) {                                                              \
      PORTB |= (1 << UTILS_DEBUG_LED_PIN);                                     \
    }                                                                          \
    while (status > 0) {                                                       \
      PORTB ^= (1 << UTILS_DEBUG_LED_PIN);                                     \
      _delay_ms(500);                                                          \
    }                                                                          \
  }

Macro to assert a status and flash a debug LED.

Parameters

status

Negative sets LED; positive triggers LED flashing; zero does nothing

Definition at line 26 of file utils.h.

#define STATUS_ASSERT(status)                                                  \
  {                                                                            \
    DDRB |= (1 << UTILS_DEBUG_LED_PIN);                                        \
                                                                               \
    if (status) {                                                              \
      PORTB |= (1 << UTILS_DEBUG_LED_PIN);                                     \
    }                                                                          \
    while (status > 0) {                                                       \
      PORTB ^= (1 << UTILS_DEBUG_LED_PIN);                                     \
      _delay_ms(500);                                                          \
    }                                                                          \
  }

Referenced by main().

TRASHCAN

#define TRASHCAN   ((void *)0)

#include <utils.h>

Definition at line 19 of file utils.h.

Referenced by io_avr_buttons_read(), MCP2515_bit_modify(), menu_handler(), page_back(), page_select(), spi_duplex(), spi_push(), spi_recieve(), spi_recieve_n(), spi_send(), and spi_send_n().

UTILS_DEBUG_LED_PIN

#define UTILS_DEBUG_LED_PIN   PB0

#include <utils.h>

Debug LED pin for error status

Definition at line 17 of file utils.h.

Function Documentation

map()

int16_t map	(	uint8_t	x,
		uint8_t	in_min,
		uint8_t	in_max,
		int16_t	out_min,
		int16_t	out_max )

#include <utils.h>

Maps a value from one range to another (taken from https://docs.arduino.cc/language-reference/en/functions/math/map/).

Parameters

x	Input value
in_min	Input range minimum
in_max	Input range maximum
out_min	Output range minimum
out_max	Output range maximum

Returns

Mapped value in output range

Definition at line 63 of file utils.c.

                             {
  // do all math in 32-bit to avoid overflow
  int32_t num = (int32_t)(x - in_min) * (out_max - out_min);
  int32_t den = (int32_t)(in_max - in_min);
  int32_t result = num / den + out_min;
  return (int16_t)result;
}

Referenced by io_joystick_read_position().

utils_joystick_print_pos()

uint8_t utils_joystick_print_pos

(

struct io_joystick_position *

pos

)

#include <utils.h>

Prints joystick position (x/y) via UART.

Parameters

pos	Pointer to joystick position struct

Returns

0 on success

Definition at line 21 of file utils.c.

                                                                   {
  struct ADC_meas data;
 
  ADC_read_all(&data);
 
  char raw_x_str[5] = "";
  char raw_y_str[5] = "";
  itoa(pos->x, raw_x_str, 10);
  itoa(pos->y, raw_y_str, 10);
 
  USART_SendString("Joystick X: ");
  USART_SendString(raw_x_str);
  USART_SendString("\t");
 
  USART_SendString("Joystick Y: ");
  USART_SendString(raw_y_str);
  USART_SendString("\n");
 
  return 0;
}

utils_joystick_print_raw()

uint8_t utils_joystick_print_raw

(

struct io_joystick_device *

dev

)

#include <utils.h>

Prints raw ADC joystick readings via UART.

Parameters

dev	Pointer to joystick device

Returns

0 on success

Definition at line 42 of file utils.c.

                                                                 {
  struct ADC_meas data;
 
  ADC_read_all(&data);
 
  char raw_x_str[5] = "";
  char raw_y_str[5] = "";
  itoa(data.channel[dev->adc_channel_x], raw_x_str, 10);
  itoa(data.channel[dev->adc_channel_y], raw_y_str, 10);
 
  USART_SendString("Joystick X: ");
  USART_SendString(raw_x_str);
  USART_SendString("\t");
 
  USART_SendString("Joystick Y: ");
  USART_SendString(raw_y_str);
  USART_SendString("\n");
 
  return 0;
}