uvos/libeismultiplexer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

documentation: fix some spelling

Browse source
This commit is contained in:
Carl Philipp Klemm 2024-01-09 14:05:14 +01:00
parent 7ed44a508c
commit fbf59878d6
5 changed files with 89 additions and 64 deletions
Download patch file Download diff file Expand all files Collapse all files

42
eismultiplexer.h
View file

@ -32,9 +32,9 @@
#include <stdbool.h>
/**
Api to controll EISmultiplexer devices.
API to control EISmultiplexer devices.
* @defgroup API User API
* This api allows you to controll the EISmultiplexer device.
* This API allows you to control the EISmultiplexer device.
* @{
*/
@ -58,50 +58,50 @@ struct eismultiplexer {
};
/**
* @brief Attempts to connect to a EISmultiplexer device and initalizes a eismultiplexer struct
* @param muliplexer pointer to a eismultiplexer struct to initalize
* @brief Attempts to connect to a EISmultiplexer device and initializes a eismultiplexer struct
* @param multiplexer pointer to a eismultiplexer struct to initialize
* @param serial The serial number of the device to connect to, or 0 for any
* @return 0 on sucess and < 0 on failure
* @return 0 on success and < 0 on failure
*/
int eismultiplexer_connect(struct eismultiplexer* muliplexer, uint16_t serial);
/**
* @brief Conects the given channel(s) to the common inputs
* @param muliplexer pointer to a eismultiplexer struct
* @param channel A channel to connect, multiple channels can be specified by or'ing together the chanel flags e.g. (CHANNEL_A | CHANNEL_B)
* @return 0 on sucess and < 0 on failure
* @brief Connects the given channel(s) to the common inputs
* @param multiplexer pointer to a eismultiplexer struct
* @param channel A channel to connect, multiple channels can be specified by or'ing together the channel flags e.g. (CHANNEL_A | CHANNEL_B)
* @return 0 on success and < 0 on failure
*/
int eismultiplexer_connect_channel(struct eismultiplexer* muliplexer, channel_t channel);
/**
* @brief Conects the given channel(s) to the common inputs disconnecting all others
* @param muliplexer pointer to a eismultiplexer struct
* @param channel A channel to connect, multiple channels can be specified by or'ing together the chanel flags e.g. (CHANNEL_A | CHANNEL_B)
* @return 0 on sucess and < 0 on failure
* @brief Connects the given channel(s) to the common inputs disconnecting all others
* @param multiplexer pointer to a eismultiplexer struct
* @param channel A channel to connect, multiple channels can be specified by or'ing together the channel flags e.g. (CHANNEL_A | CHANNEL_B)
* @return 0 on success and < 0 on failure
*/
int eismultiplexer_connect_channel_exclusive(struct eismultiplexer* muliplexer, channel_t channel);
/**
* @brief Disconnect the given channel(s) to the common inputs disconnecting all others
* @param muliplexer pointer to a eismultiplexer struct
* @param channel A channel to connect, multiple channels can be specified by or'ing together the chanel flags e.g. (CHANNEL_A | CHANNEL_B)
* All channels can be dissconnected by passing CHANNEL_NONE
* @return 0 on sucess and < 0 on failure
* @param multiplexer pointer to a eismultiplexer struct
* @param channel A channel to connect, multiple channels can be specified by or'ing together the channel flags e.g. (CHANNEL_A | CHANNEL_B)
* All channels can be disconnected by passing CHANNEL_NONE
* @return 0 on success and < 0 on failure
*/
int eismultiplexer_disconnect_channel(struct eismultiplexer* muliplexer, channel_t channel);
/**
* @brief Returns the channels currently connected
* @param muliplexer pointer to a eismultiplexer struct
* @param multiplexer pointer to a eismultiplexer struct
* @return channels connected as a bitfield
*/
channel_t eismultiplexer_get_connected(struct eismultiplexer* muliplexer);
/**
* @brief Turns the led on the pcb on or off
* @param muliplexer pointer to a eismultiplexer struct
* @brief Turns the led on the PCB on or off
* @param multiplexer pointer to a eismultiplexer struct
* @param on true to turn the led on, false to turn it off
* @return 0 on sucess and < 0 on failure
* @return 0 on success and < 0 on failure
*/
int eismultiplexer_set_led(struct eismultiplexer* muliplexer, bool on);