upm  1.7.1
Sensor/Actuator repository for libmraa (v2.0.0)
Data Structures | Functions | Typedefs
Include dependency graph for cjq4435.h:

API Description

/*
* Author: Jon Trulson <jtrulson@ics.com>
* Copyright (c) 2017 Intel Corporation.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#include <unistd.h>
#include <signal.h>
#include <upm_utilities.h>
#include "cjq4435.h"
int shouldRun = true;
void sig_handler(int signo)
{
if (signo == SIGINT)
shouldRun = false;
}
int main ()
{
signal(SIGINT, sig_handler);
// Instantiate a CJQ4435 MOSFET on a PWM capable digital pin D3
if (!mosfet)
{
printf("cjq4435_init() failed.\n");
return 1;
}
cjq4435_set_period_ms(mosfet, 10);
cjq4435_enable(mosfet, true);
while (shouldRun)
{
// start with a duty cycle of 0.0 (off) and increment to 1.0 (on)
for (float i=0.0; i <= 1.0; i+=0.1)
{
upm_delay_ms(100);
}
upm_delay(1);
// Now bring it back down
// start with a duty cycle of 1.0 (on) and decrement to 0.0 (off)
for (float i=1.0; i >= 0.0; i-=0.1)
{
upm_delay_ms(100);
}
upm_delay(1);
}
printf("Exiting...\n");
cjq4435_close(mosfet);
return 0;
}

Go to the source code of this file.

Data Structures

struct  _cjq4435_context
 

Functions

cjq4435_context cjq4435_init (int pin)
 
void cjq4435_close (cjq4435_context dev)
 
upm_result_t cjq4435_set_period_us (const cjq4435_context dev, int us)
 
upm_result_t cjq4435_set_period_ms (const cjq4435_context dev, int us)
 
upm_result_t cjq4435_set_period_seconds (const cjq4435_context dev, float seconds)
 
upm_result_t cjq4435_enable (const cjq4435_context dev, bool enable)
 
upm_result_t cjq4435_set_duty_cycle (const cjq4435_context dev, float dutyCycle)
 
void cjq4435_on (const cjq4435_context dev)
 
void cjq4435_off (const cjq4435_context dev)
 

Typedefs

typedef struct _cjq4435_contextcjq4435_context
 

Function Documentation

cjq4435_context cjq4435_init ( int  pin)

CJQ4435 initializer

Parameters
pinDigital pin to use; this pin must be PWM-capable
Returns
Initialized device context, or NULL on error.

Here is the call graph for this function:

void cjq4435_close ( cjq4435_context  dev)

CJQ4435 destructor

Parameters
devDevice context

Here is the caller graph for this function:

upm_result_t cjq4435_set_period_us ( const cjq4435_context  dev,
int  us 
)

Sets a period in microseconds

Parameters
devDevice context
usPeriod in microseconds
Returns
UPM result

Here is the caller graph for this function:

upm_result_t cjq4435_set_period_ms ( const cjq4435_context  dev,
int  us 
)

Sets a period in milliseconds

Parameters
devDevice context
msPeriod in milliseconds
Returns
UPM result

Here is the caller graph for this function:

upm_result_t cjq4435_set_period_seconds ( const cjq4435_context  dev,
float  seconds 
)

Sets a period in seconds

Parameters
devDevice context
secondsPeriod in seconds
Returns
UPM result

Here is the caller graph for this function:

upm_result_t cjq4435_enable ( const cjq4435_context  dev,
bool  enable 
)

Enables output

Parameters
devDevice context
enableEnables PWM output if true, disables otherwise
Returns
UPM result

Here is the caller graph for this function:

upm_result_t cjq4435_set_duty_cycle ( const cjq4435_context  dev,
float  dutyCycle 
)

Sets a duty cycle. Duty cycle is a floating-point number between 0.0 (always off) and 1.0 (always on). It represents a proportion of time, per period, during which the output is driven high.

Parameters
devDevice context
dutyCycleDuty cycle to use
Returns
UPM result

Here is the caller graph for this function:

void cjq4435_on ( const cjq4435_context  dev)

Shortcut to turn the output to continuous on (high)

Parameters
devDevice context

Here is the call graph for this function:

Here is the caller graph for this function:

void cjq4435_off ( const cjq4435_context  dev)

Shortcut to turn the output to continuous off (low)

Parameters
devDevice context

Here is the call graph for this function:

Here is the caller graph for this function:

Typedef Documentation

Device context