ShockPot.h File Reference

#include "../AnalogSensor.h"
#include "../../Utils/WheelLocation.h"

Include dependency graph for ShockPot.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	ShockPot

Functions
void	initShockPot (ShockPot *shockPot, int hz, int channel, WHEEL_LOCATION location)
	Initializes the ShockPot sensor with the given frequency, channel, and wheel location. More...
float	getShockPotDistance (ShockPot *shockPot)
	Gets the current distance measured by the ShockPot. More...
void	updateShockPot (void *shockPot)
	Updates the ShockPot data. More...
float	transferFunctionShockPot (float rawVal)
	Converts raw ShockPot data to a meaningful distance value. More...

Function Documentation

getShockPotDistance()

float getShockPotDistance

(

ShockPot *

shockPot

)

Gets the current distance measured by the ShockPot.

Parameters

shockPot

Pointer to the ShockPot structure to query.

Returns

The current distance measured by the ShockPot.

Definition at line 13 of file ShockPot.c.

                                              {
    return shockPot->distance;
}

initShockPot()

void initShockPot	(	ShockPot *	shockPot,
		int	hz,
		int	channel,
		WHEEL_LOCATION	location
	)

Initializes the ShockPot sensor with the given frequency, channel, and wheel location.

Parameters

shockPot	Pointer to the ShockPot structure to initialize.
hz	The frequency in Hertz at which the sensor operates.
channel	The analog channel the sensor is connected to.
location	The wheel location as defined by the WHEEL_LOCATION enum.

Definition at line 6 of file ShockPot.c.

                                                                                    {
    initAnalogSensor(&shockPot->base, "ShockPot", hz, channel, shockPot);
    shockPot->distance = -1;
    shockPot->wheel_location = location;
    shockPot->base.sensor.updateable.update = updateShockPot;
}

Here is the call graph for this function:

transferFunctionShockPot()

float transferFunctionShockPot

(

float

rawVal

)

Converts raw ShockPot data to a meaningful distance value.

Parameters

rawVal

The raw data from the ShockPot sensor.

Returns

The converted distance value.

Definition at line 24 of file ShockPot.c.

                                             {
    if (rawVal < 15) {
        printf("ShockPot::transfer_function rawValue is too low\n");
        return -1;
    }
    else if (rawVal > 135) {
        printf("ShockPot::transfer_function rawValue is too high\n");
        return -1;
    }
    return 2.71965 * pow(rawVal, 0.837683) - 16.2622;
}

Here is the caller graph for this function:

updateShockPot()

void updateShockPot

(

void *

shockPot

)

Updates the ShockPot data.

Parameters

shockPot

Pointer to the ShockPot structure to update.

Definition at line 17 of file ShockPot.c.

                                    {
    ShockPot *myShockPot = (ShockPot *)shockPot;
    printf("Implement ShockPot::update\n");
    float rawData = 50.0;
    myShockPot->distance = transferFunctionShockPot(rawData);
}

Here is the call graph for this function:

Here is the caller graph for this function: