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

correct spelling of multiplexer

Browse source
This commit is contained in:
Carl Philipp Klemm 2023-06-30 16:12:39 +02:00
parent 0ec7d189b2
commit 1004ecee2b
4 changed files with 47 additions and 47 deletions
Download patch file Download diff file Expand all files Collapse all files

36
eismultiplexer.h
View file

@ -23,9 +23,9 @@
#include <stdbool.h>
/**
Api to controll EISmulitplexer devices.
Api to controll EISmultiplexer devices.
* @defgroup API User API
* This api allows you to controll the EISmulitplexer device.
* This api allows you to controll the EISmultiplexer device.
* @{
*/
@ -44,64 +44,64 @@ typedef enum {
CHANNEL_NONE = 0,
} channel_t;
struct eismulitplexer {
struct eismultiplexer {
struct usbshm* priv;
sem_t readSem;
channel_t activeChannels;
};
/**
* @brief Attempts to connect to a EISmulitplexer device and initalizes a eismulitplexer struct
* @param muliplexer pointer to a eismulitplexer struct to initalize
* @brief Attempts to connect to a EISmultiplexer device and initalizes a eismultiplexer struct
* @param muliplexer pointer to a eismultiplexer struct to initalize
* @param serial The serial number of the device to connect to, or 0 for any
* @return 0 on sucess and < 0 on failure
*/
int eismulitplexer_connect(struct eismulitplexer* muliplexer, int serial);
int eismultiplexer_connect(struct eismultiplexer* muliplexer, int serial);
/**
* @brief Conects the given channel(s) to the common inputs
* @param muliplexer pointer to a eismulitplexer struct
* @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
*/
int eismulitplexer_connect_channel(struct eismulitplexer* muliplexer, channel_t channel);
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 eismulitplexer struct
* @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
*/
int eismulitplexer_connect_channel_exclusive(struct eismulitplexer* muliplexer, channel_t channel);
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 eismulitplexer struct
* @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
*/
int eismulitplexer_disconnect_channel(struct eismulitplexer* muliplexer, channel_t channel);
int eismultiplexer_disconnect_channel(struct eismultiplexer* muliplexer, channel_t channel);
/**
* @brief Returns the channels currently connected
* @param muliplexer pointer to a eismulitplexer struct
* @param muliplexer pointer to a eismultiplexer struct
* @return channels connected as a bitfield
*/
channel_t eismulitplexer_get_connected(struct eismulitplexer* muliplexer);
channel_t eismultiplexer_get_connected(struct eismultiplexer* muliplexer);
/**
* @brief Turns the led on the pcb on or off
* @param muliplexer pointer to a eismulitplexer struct
* @param muliplexer 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
*/
int eismulitplexer_set_led(struct eismulitplexer* muliplexer, bool on);
int eismultiplexer_set_led(struct eismultiplexer* muliplexer, bool on);
/**
* @brief Disconnects from the eismulitplexer
* @brief Disconnects from the eismultiplexer
*/
void eismulitplexer_disconnect(struct eismulitplexer* muliplexer);
void eismultiplexer_disconnect(struct eismultiplexer* muliplexer);
#ifdef __cplusplus
}