no-OS
Loading...
Searching...
No Matches
Functions
relay.c File Reference

Relay implementation file. More...

#include "no_os_print_log.h"
#include "common_data.h"
#include "relay.h"
Include dependency graph for relay.c:

Functions

int relay_init (struct no_os_gpio_desc **relay)
 Initialize relay component.
 
int relay_open (struct no_os_gpio_desc *relay)
 Open relay command.
 
int relay_close (struct no_os_gpio_desc *relay)
 Close relay command.
 
int relay_state (struct no_os_gpio_desc *relay, uint8_t *state)
 Relay command line state.
 
uint8_t get_relay_status (void)
 Get relay status.
 
void set_relay_status (void)
 Set relay status to CLOSED - 1.
 
void reset_relay_status (void)
 Set relay status to OPENED - 0.
 

Detailed Description

Relay implementation file.

Author
GMois (georg.nosp@m.e.mo.nosp@m.is@an.nosp@m.alog.nosp@m..com), REtz (radu..nosp@m.etz@.nosp@m.analo.nosp@m.g.co.nosp@m.m)

Copyright (c) 2023 Analog Devices, Inc.

SPDX-License-Identifier: BSD-3-Clause

Function Documentation

◆ get_relay_status()

uint8_t get_relay_status ( void )

Get relay status.

Returns
1 - RELAY CLOSED, 0 - RELAY OPENED

◆ relay_close()

int relay_close ( struct no_os_gpio_desc * relay)

Close relay command.

Parameters
relay- relay GPIO pin description
Returns
0 in case of success, error code otherwise

◆ relay_init()

int relay_init ( struct no_os_gpio_desc ** relay)

Initialize relay component.

Parameters
relay- relay GPIO pin description
Returns
0 in case of success, error code otherwise

◆ relay_open()

int relay_open ( struct no_os_gpio_desc * relay)

Open relay command.

Parameters
relay- relay GPIO pin description
Returns
0 in case of success, error code otherwise

◆ relay_state()

int relay_state ( struct no_os_gpio_desc * relay,
uint8_t * state )

Relay command line state.

Parameters
relay- relay GPIO pin description
state- relay state (0 - OPEN, 1 - CLOSED)
Returns
0 in case of success, error code otherwise

◆ reset_relay_status()

void reset_relay_status ( void )

Set relay status to OPENED - 0.

Set relay status to OPENED - 0

◆ set_relay_status()

void set_relay_status ( void )

Set relay status to CLOSED - 1.

Set relay status to CLOSED - 1