EZO Carrier ORP Click Driver

API for configuring and manipulating EZO Carrier ORP Click driver. More...

Topics
	EZO Carrier ORP Device Settings
	Settings for registers of EZO Carrier ORP Click driver.
	EZO Carrier ORP MikroBUS Map
	MikroBUS pin mapping of EZO Carrier ORP Click driver.

Macros
#define	EZOCARRIERORP_DEVICE_ADDRESS   0x61
	EZO Carrier ORP device address setting.

Functions
void	ezocarrierorp_cfg_setup (ezocarrierorp_cfg_t *cfg)
	EZO Carrier ORP configuration object setup function.
void	ezocarrierorp_drv_interface_sel (ezocarrierorp_cfg_t *cfg, ezocarrierorp_drv_t drv_sel)
	EZO Carrier EC driver interface setup function.
err_t	ezocarrierorp_init (ezocarrierorp_t *ctx, ezocarrierorp_cfg_t *cfg)
	EZO Carrier ORP initialization function.
err_t	ezocarrierorp_generic_write (ezocarrierorp_t *ctx, uint8_t *data_in, uint16_t len)
	EZO Carrier ORP data writing function.
err_t	ezocarrierorp_generic_read (ezocarrierorp_t *ctx, uint8_t *data_out, uint16_t len)
	EZO Carrier ORP data reading function.
void	ezocarrierorp_send_cmd (ezocarrierorp_t *ctx, uint8_t *cmd)
	Send command function.
void	ezocarrierorp_send_cmd_with_par (ezocarrierorp_t *ctx, uint8_t *cmd, uint8_t *param_buf)
	Send command function with parameter.
void	ezocarrierorp_send_cmd_check (ezocarrierorp_t *ctx, uint8_t *cmd)
	Check the sent command.

Detailed Description

API for configuring and manipulating EZO Carrier ORP Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Macro Definition Documentation

EZOCARRIERORP_DEVICE_ADDRESS

#define EZOCARRIERORP_DEVICE_ADDRESS   0x61

EZO Carrier ORP device address setting.

Specified setting for device slave address selection of EZO Carrier ORP Click driver.

Function Documentation

ezocarrierorp_cfg_setup()

void ezocarrierorp_cfg_setup

(

ezocarrierorp_cfg_t *

cfg

)

EZO Carrier ORP configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See ezocarrierorp_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

ezocarrierorp_drv_interface_sel()

void ezocarrierorp_drv_interface_sel	(	ezocarrierorp_cfg_t *	cfg,
		ezocarrierorp_drv_t	drv_sel )

EZO Carrier EC driver interface setup function.

This function sets a serial driver interface which will be used further in the click driver.

Parameters

[out]	cfg	: Click configuration structure. See ezocarrierorp_cfg_t object definition for detailed explanation.
[in]	drv_sel	: Driver interface selection. See ezocarrierorp_drv_t object definition for detailed explanation.

Returns

Nothing.

Note

This driver selection should be call before init function to configure the driver to work with the serial interface which is consistent with the real state of the hardware. If this function is not called, the default driver interface will be set.

ezocarrierorp_generic_read()

err_t ezocarrierorp_generic_read	(	ezocarrierorp_t *	ctx,
		uint8_t *	data_out,
		uint16_t	len )

EZO Carrier ORP data reading function.

This function reads a desired number of data bytes by using UART serial interface.

Parameters

[in]	ctx	: Click context object. See ezocarrierorp_t object definition for detailed explanation.
[out]	data_out	: Output read data.
[in]	len	: Number of bytes to be read.

Returns

• >0 - Number of data bytes read,
• <=0 - Error/Empty Ring buffer. See #err_t definition for detailed explanation.

Note

None.

ezocarrierorp_generic_write()

err_t ezocarrierorp_generic_write	(	ezocarrierorp_t *	ctx,
		uint8_t *	data_in,
		uint16_t	len )

EZO Carrier ORP data writing function.

This function writes a desired number of data bytes by using UART serial interface.

Parameters

[in]	ctx	: Click context object. See ezocarrierorp_t object definition for detailed explanation.
[in]	data_in	: Data buffer for sending.
[in]	len	: Number of bytes for sending.

Returns

• >=0 - Success,
• <0 - Error. See #err_t definition for detailed explanation.

Note

None.

ezocarrierorp_init()

err_t ezocarrierorp_init	(	ezocarrierorp_t *	ctx,
		ezocarrierorp_cfg_t *	cfg )

EZO Carrier ORP initialization function.

This function initializes all necessary pins and peripherals used for this click board.

Parameters

[out]	ctx	: Click context object. See ezocarrierorp_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See ezocarrierorp_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

ezocarrierorp_send_cmd()

void ezocarrierorp_send_cmd	(	ezocarrierorp_t *	ctx,
		uint8_t *	cmd )

Send command function.

This function sends a specified command to the click module.

Parameters

[in]	ctx	: Click context object. See ezocarrierorp_t object definition for detailed explanation.
[in]	cmd	: Command buffer.

Returns

Nothing.

Note

None.

ezocarrierorp_send_cmd_check()

void ezocarrierorp_send_cmd_check	(	ezocarrierorp_t *	ctx,
		uint8_t *	cmd )

Check the sent command.

This function checks the command that is sent.

Parameters

[in]	ctx	: Click context object. See ezocarrierorp_t object definition for detailed explanation.
[in]	cmd	: Command buffer.

Returns

Nothing.

Note

None.

ezocarrierorp_send_cmd_with_par()

void ezocarrierorp_send_cmd_with_par	(	ezocarrierorp_t *	ctx,
		uint8_t *	cmd,
		uint8_t *	param_buf )

Send command function with parameter.

This function sends a command with specified parameter to the click module.

Parameters

[in]	ctx	: Click context object. See ezocarrierorp_t object definition for detailed explanation.
[in]	cmd	: Command buffer.
[in]	param_buf	: Parameter buffer.

Returns

Nothing.

Note

None.