relay.h File Reference

Relay interface file. More...

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

Go to the source code of this file.

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

Detailed Description

Relay interface 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.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of Analog Devices, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Function Documentation

get_relay_status()

uint8_t get_relay_status

(

void

)

Get relay status.

Get relay status

Returns

1 - RELAY CLOSED, 0 - RELAY OPENED

relay_close()

int relay_close

(

struct no_os_gpio_desc *

relay

)

Close relay command.

Close relay command

Parameters

relay

- relay GPIO pin description

Returns

0 in case of success, error code otherwise

Here is the caller graph for this function:

relay_init()

int relay_init

(

struct no_os_gpio_desc **

relay

)

Initialize relay component.

Initialize relay

Parameters

relay

- relay GPIO pin description

Returns

0 in case of success, error code otherwise

Here is the caller graph for this function:

relay_open()

int relay_open

(

struct no_os_gpio_desc *

relay

)

Open relay command.

Open relay cmmand

Parameters

relay

- relay GPIO pin description

Returns

0 in case of success, error code otherwise

Here is the caller graph for this function:

relay_state()

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

Relay command line 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

Here is the caller graph for this function:

reset_relay_status()

void reset_relay_status

(

void

)

Set relay status to OPENED - 0.

Set relay status to OPENED - 0

Returns

none

Here is the caller graph for this function:

set_relay_status()

void set_relay_status

(

void

)

Set relay status to CLOSED - 1.

Set relay status to CLOSED - 1

Returns

none