API for configuring and manipulating pH Click driver. More...

Topics
	pH Device Settings
	Settings for registers of pH Click driver.

	pH MikroBUS Map
	MikroBUS pin mapping of pH Click driver.

Functions
void	ph_cfg_setup (ph_cfg_t *cfg)
	pH configuration object setup function.

err_t	ph_init (ph_t ctx, ph_cfg_t cfg)
	pH initialization function.

err_t	ph_default_cfg (ph_t *ctx)
	pH default configuration function.

err_t	ph_generic_write (ph_t ctx, uint8_t data_buf, uint16_t len)
	pH data writing function.

err_t	ph_generic_read (ph_t ctx, uint8_t data_buf, uint16_t max_len)
	pH data reading function.

void	ph_uart_write (ph_t *ctx, uint8_t input)
	UART Write Single Byte function.

void	ph_uart_read_until (ph_t ctx, char p_rx_data, char *delim)
	UART read until delimiter function.

void	ph_send_cmd (ph_t ctx, char p_cmd)
	Send command function.

void	ph_send_cmd_resp (ph_t ctx, char p_cmd, char *p_resp)
	Send command and get response function.

void	ph_send_cmd_w_num (ph_t ctx, char p_cmd, char flt_val, char p_resp)
	Send command with number and get response function.

void	ph_get_cmd_resp (ph_t ctx, char p_cmd, char *p_resp)
	Send get response function.

void	ph_switch_led (ph_t ctx, uint8_t state, char p_resp)
	Toggle LED function.

void	ph_chk_led_state (ph_t ctx, char p_resp)
	Check LED state function.

void	ph_find_dev (ph_t ctx, char p_resp)
	Find device function.

void	ph_cont_read (ph_t ctx, uint8_t time, char p_resp)
	Set Continous read function.

void	ph_chk_cont_read (ph_t ctx, char p_resp)
	Check Continous read settings function.

void	ph_perf_calib (ph_t ctx, char point, float flt_val, char *p_resp)
	Perform Calibration function.

void	ph_chk_calib (ph_t ctx, char p_resp)
	Check if Calibration was performed function.

void	ph_chk_slope (ph_t ctx, char p_resp)
	Check slope function.

void	ph_get_calib_exp_bytes_num (ph_t ctx, char p_resp)
	Export calibration data function.

void	ph_import_calib (ph_t ctx, uint8_t in_calib, char *p_resp)
	Import calibration data function.

void	ph_factory_rst (ph_t ctx, char p_resp)
	Perform Factory Reset function.

void	ph_set_temp_comp (ph_t ctx, float flt_val, char p_resp)
	Set Temperature Compensation function.

void	ph_get_temp_comp (ph_t ctx, char p_resp)
	Get Temperature Compensation function.

void	ph_set_name (ph_t ctx, char p_dev_name, char *p_resp)
	Set name function.

void	ph_show_name (ph_t ctx, char p_dev_name)
	Show Device Name function.

void	ph_get_dev_info (ph_t ctx, char p_resp)
	Get Device Information function.

void	ph_check_status (ph_t ctx, char p_resp)
	Check Device Status function.

void	ph_sleep (ph_t *ctx)
	Enter Sleep mode function.

void	ph_chng_baud_rate (ph_t ctx, char baud_rate, char *p_resp)
	Change Baud Rate function.

void	ph_chk_baud_rate (ph_t ctx, char p_resp)
	Check Baud Rate applied function.

void	ph_protocol_lock (ph_t ctx, uint8_t state, char p_resp)
	Protocol Lock enable/disable function.

void	ph_check_protocol_lock (ph_t ctx, char p_resp)
	Check Protocol Lock function.

void	ph_chng_i2c_adr (ph_t ctx, uint32_t i2c_adr, char p_resp)
	Change Device's I2C slave address function.

void	ph_single_read (ph_t ctx, char p_resp)
	Perform single read function.

uint8_t	ph_response (ph_t ctx, char p_resp)
	pH Response handler function

void	ph_clr_log_buf (char *p_str)
	Clear log buffer function.

Detailed Description

API for configuring and manipulating pH Click driver.

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

Function Documentation

◆ ph_cfg_setup()

void ph_cfg_setup ( ph_cfg_t * cfg )

pH configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out] cfg : Click configuration structure. See ph_cfg_t object definition for detailed explanation.

Returns: Nothing.

Note: The all used pins will be set to unconnected state.

◆ ph_check_protocol_lock()

void ph_check_protocol_lock	(	ph_t *	ctx,
		char *	p_resp )

Check Protocol Lock function.

Function is used to check if the device is lock to UART mode.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[out]	p_resp	: Pointer to response. data.

Returns: Nothing.

◆ ph_check_status()

void ph_check_status	(	ph_t *	ctx,
		char *	p_resp )

Check Device Status function.

Function is used to check status of the device.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[out]	p_resp	: Pointer to response.

Returns: Nothing.

◆ ph_chk_baud_rate()

void ph_chk_baud_rate	(	ph_t *	ctx,
		char *	p_resp )

Check Baud Rate applied function.

Function is used to check the baud rate.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[out]	p_resp	: Pointer to response.

Returns: Nothing.

Note: Default speed is 9600.

◆ ph_chk_calib()

void ph_chk_calib	(	ph_t *	ctx,
		char *	p_resp )

Check if Calibration was performed function.

Function is used to check if calibration was performed.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[out]	p_resp	: Pointer to response.

Returns: Nothing.

Note: ?Cal,0 <cr> not calibrated. ?Cal,1 <cr> one point calibration performed. ?Cal,2 <cr> two point calibration performed. ?Cal,3 <cr> three point calibration performed.

◆ ph_chk_cont_read()

void ph_chk_cont_read	(	ph_t *	ctx,
		char *	p_resp )

Check Continous read settings function.

Function is used to check the settings of the continous read.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[out]	p_resp	: Pointer to response.

Returns: Nothing.

◆ ph_chk_led_state()

void ph_chk_led_state	(	ph_t *	ctx,
		char *	p_resp )

Check LED state function.

Function is used to check the state of the LED.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[out]	p_resp	: Pointer to response.

Returns: Nothing.

◆ ph_chk_slope()

void ph_chk_slope	(	ph_t *	ctx,
		char *	p_resp )

Check slope function.

Function is used to check the slope of the probe.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[out]	p_resp	: Pointer to response.

Returns: Nothing.

◆ ph_chng_baud_rate()

void ph_chng_baud_rate	(	ph_t *	ctx,
		char *	baud_rate,
		char *	p_resp )

Change Baud Rate function.

Function is used to change the baud rate.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[in]	baud_rate	: Baud rate.
[out]	p_resp	: Pointer to response.

Returns: Nothing.

Note: Default speed is 9600.

◆ ph_chng_i2c_adr()

void ph_chng_i2c_adr	(	ph_t *	ctx,
		uint32_t	i2c_adr,
		char *	p_resp )

Change Device's I2C slave address function.

Function is used to set I2C address and reboot into I2C mode.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[in]	i2c_adr	: Device slave address.
[out]	p_resp	: Pointer to response. data.

Returns: Nothing.

Note: Default I2C address 99 (0x63).

◆ ph_clr_log_buf()

void ph_clr_log_buf ( char * p_str )

Clear log buffer function.

Function is used to empty log's data buffer.

Parameters

[in] p_str : Data buffer.

Returns: Nothing.

◆ ph_cont_read()

void ph_cont_read	(	ph_t *	ctx,
		uint8_t	time,
		char *	p_resp )

Set Continous read function.

Function is used to enable, disable or change settings of the continous read.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[in]	time	: Defines reading interval ranging from 1 to 90 seconds, if 0 is applied continous reading is disabled.
[out]	p_resp	: Pointer to response.

Returns: Nothing.

◆ ph_default_cfg()

err_t ph_default_cfg ( ph_t * ctx )

pH default configuration function.

This function executes a default configuration of pH click board.

Parameters

[in] ctx : Click context object. See ph_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: This function can consist any necessary configuration or setting to put device into operating mode.

◆ ph_factory_rst()

void ph_factory_rst	(	ph_t *	ctx,
		char *	p_resp )

Perform Factory Reset function.

Function is used to perform factory reset.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[out]	p_resp	: Pointer to response.

Returns: Nothing.

◆ ph_find_dev()

void ph_find_dev	(	ph_t *	ctx,
		char *	p_resp )

Find device function.

Function is used to find the device.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[out]	p_resp	: Pointer to response.

Returns: Nothing.

Note: When the command is issued LED blinks white.

◆ ph_generic_read()

err_t ph_generic_read	(	ph_t *	ctx,
		uint8_t *	data_buf,
		uint16_t	max_len )

pH data reading function.

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

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[out]	data_buf	: Output read data.
[in]	max_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.

◆ ph_generic_write()

err_t ph_generic_write	(	ph_t *	ctx,
		uint8_t *	data_buf,
		uint16_t	len )

pH data writing function.

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

Parameters

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

Returns

>=0 - Success,
<0 - Error.

See #err_t definition for detailed explanation.

◆ ph_get_calib_exp_bytes_num()

void ph_get_calib_exp_bytes_num	(	ph_t *	ctx,
		char *	p_resp )

Export calibration data function.

Function is used to export calibration data.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[out]	p_resp	: Pointer to exported calibration data

Returns: Nothing.

Note: Up 10 12 byte strings to export.

◆ ph_get_cmd_resp()

void ph_get_cmd_resp	(	ph_t *	ctx,
		char *	p_cmd,
		char *	p_resp )

Send get response function.

Function is used to get response from a command.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[in]	p_cmd	: Pointer to input command.
[out]	p_resp	: Pointer to response.

Returns: Nothing.

◆ ph_get_dev_info()

void ph_get_dev_info	(	ph_t *	ctx,
		char *	p_resp )

Get Device Information function.

Function is used to read information about the device.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[out]	p_resp	: Pointer to response.

Returns: Nothing.

◆ ph_get_temp_comp()

void ph_get_temp_comp	(	ph_t *	ctx,
		char *	p_resp )

Get Temperature Compensation function.

Function is used to get temperature compensation.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[out]	p_resp	: Pointer to response.

Returns: Nothing.

Note: Temperature is always in degrees centigrade.

◆ ph_import_calib()

void ph_import_calib	(	ph_t *	ctx,
		uint8_t *	in_calib,
		char *	p_resp )

Import calibration data function.

Function is used to import calibration data.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[in]	in_calib	: Pointer to imported calibration data.
[out]	p_resp	: Pointer to response.

Returns: Nothing.

Note: Up 10 12 byte strings to import.

◆ ph_init()

err_t ph_init	(	ph_t *	ctx,
		ph_cfg_t *	cfg )

pH initialization function.

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

Parameters

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

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

◆ ph_perf_calib()

void ph_perf_calib	(	ph_t *	ctx,
		char *	point,
		float	flt_val,
		char *	p_resp )

Perform Calibration function.

Function is used to perform calibration.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[in]	point	: Pointer to calibration point ( mid, low or high ).
[in]	flt_val	: Float value representing calibration reference.
[out]	p_resp	: Pointer to response.

Returns: Nothing.

Note: Cal,mid,n <cr> single point calibration at midpoint. Cal,low,n <cr> two point calibration at lowpoint. Cal,high,n <cr> three point calibration at highpoint.

◆ ph_protocol_lock()

void ph_protocol_lock	(	ph_t *	ctx,
		uint8_t	state,
		char *	p_resp )

Protocol Lock enable/disable function.

Function is used to lock device to UART mode.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[in]	state	: lock/unlock the protocol.
[out]	p_resp	: Pointer to response.

Returns: Nothing.

◆ ph_response()

uint8_t ph_response	(	ph_t *	ctx,
		char *	p_resp )

pH Response handler function

Function is used to handle collected data.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[out]	p_resp	: Pointer to collected data.

Returns: Lenght of the read data.

◆ ph_send_cmd()

void ph_send_cmd	(	ph_t *	ctx,
		char *	p_cmd )

Send command function.

Function is used to send command and does not expect response.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[in]	p_cmd	: Pointer to input command

Returns: Nothing.

◆ ph_send_cmd_resp()

void ph_send_cmd_resp	(	ph_t *	ctx,
		char *	p_cmd,
		char *	p_resp )

Send command and get response function.

Function is used to send command and gets the response.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[in]	p_cmd	: Pointer to input command.
[out]	p_resp	: Pointer to response.

Returns: Nothing.

◆ ph_send_cmd_w_num()

void ph_send_cmd_w_num	(	ph_t *	ctx,
		char *	p_cmd,
		char *	flt_val,
		char *	p_resp )

Send command with number and get response function.

Function is used to send command alongside floating point number and gets the response.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
	p_cmd	pointer to input command
	name	flt_val input float value
[out]	p_resp	: Pointer to response.

Returns: Nothing.

◆ ph_set_name()

void ph_set_name	(	ph_t *	ctx,
		char *	p_dev_name,
		char *	p_resp )

Set name function.

Function is used to name the device.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[in]	p_dev_name	: Pointer to the devices name.
[out]	p_resp	: Pointer to response.

Returns: Nothing.

Note: Must not exceed 16 ASCII characters.

◆ ph_set_temp_comp()

void ph_set_temp_comp	(	ph_t *	ctx,
		float	flt_val,
		char *	p_resp )

Set Temperature Compensation function.

Function is used to set temperature compensation.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[in]	flt_val	: Compensation temperature.
[out]	p_resp	: Pointer to response.

Returns: Nothing.

Note: Temperature changes of < 2 deg C are insignificant. Temperature is always in degrees centigrade.

◆ ph_show_name()

void ph_show_name	(	ph_t *	ctx,
		char *	p_dev_name )

Show Device Name function.

Function is used to show the device's name.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[in]	p_dev_name	: Pointer to the devices name

Returns: Nothing.

◆ ph_single_read()

void ph_single_read	(	ph_t *	ctx,
		char *	p_resp )

Perform single read function.

Function is used to perform single read of the pH value.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[out]	p_resp	: Pointer to pH value of the tested substance.

Returns: Nothing.

◆ ph_sleep()

void ph_sleep ( ph_t * ctx )

Enter Sleep mode function.

Function is used to enter the sleep mode.

Parameters

[in] ctx : Click context object. See ph_t object definition for detailed explanation.

Returns: Nothing.

◆ ph_switch_led()

void ph_switch_led	(	ph_t *	ctx,
		uint8_t	state,
		char *	p_resp )

Toggle LED function.

Function is used to turn LED on or off.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[in]	state	: Turns LED on or off
[out]	p_resp	: Pointer to response.

Returns: Nothing.

◆ ph_uart_read_until()

void ph_uart_read_until	(	ph_t *	ctx,
		char *	p_rx_data,
		char *	delim )

UART read until delimiter function.

Function reads data until it finds delimiter.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[out]	p_tx_data	: Pointer to output data.
[in]	delim	: Delimiter.

Returns: Nothing.

◆ ph_uart_write()

void ph_uart_write	(	ph_t *	ctx,
		uint8_t	input )

UART Write Single Byte function.

Writes sinle byte.

Parameters

[in]	ctx	: Click context object. See ph_t object definition for detailed explanation.
[in]	input	: Byte for sending.

Returns: Nothing.

Topics

Functions

Detailed Description

Function Documentation

◆ ph_cfg_setup()

◆ ph_check_protocol_lock()

◆ ph_check_status()

◆ ph_chk_baud_rate()

◆ ph_chk_calib()

◆ ph_chk_cont_read()

◆ ph_chk_led_state()

◆ ph_chk_slope()

◆ ph_chng_baud_rate()

◆ ph_chng_i2c_adr()

◆ ph_clr_log_buf()

◆ ph_cont_read()

◆ ph_default_cfg()

◆ ph_factory_rst()

◆ ph_find_dev()

◆ ph_generic_read()

◆ ph_generic_write()

◆ ph_get_calib_exp_bytes_num()

◆ ph_get_cmd_resp()

◆ ph_get_dev_info()

◆ ph_get_temp_comp()

◆ ph_import_calib()

◆ ph_init()

◆ ph_perf_calib()

◆ ph_protocol_lock()

◆ ph_response()

◆ ph_send_cmd()

◆ ph_send_cmd_resp()

◆ ph_send_cmd_w_num()

◆ ph_set_name()

◆ ph_set_temp_comp()

◆ ph_show_name()

◆ ph_single_read()

◆ ph_sleep()

◆ ph_switch_led()

◆ ph_uart_read_until()

◆ ph_uart_write()