no_os_pid.h File Reference

Header file for PID control utility. More...

#include <stdlib.h>
#include <stdio.h>
#include <stdint.h>

Include dependency graph for no_os_pid.h:

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

Go to the source code of this file.

Classes
struct	no_os_pid_range
	Range definition for limiting PID control output or internal integrator accumulator. More...
struct	no_os_pid_config
	Configuration of the PID. More...

Functions
int	no_os_pid_init (struct no_os_pid **pid, struct no_os_pid_config config)
int	no_os_pid_control (struct no_os_pid *pid, int SP, int PV, int *output)
int	no_os_pid_hysteresis (struct no_os_pid *pid, unsigned int hyst)
int	no_os_pid_reset (struct no_os_pid *pid)
int	no_os_pid_remove (struct no_os_pid *pid)

Detailed Description

Header file for PID control utility.

Author

Darius Berghe (dariu.nosp@m.s.be.nosp@m.rghe@.nosp@m.anal.nosp@m.og.co.nosp@m.m)

Copyright 2023(c) Analog Devices, Inc.

All rights reserved.

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

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• 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.
• 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.
• The use of this software may or may not infringe the patent rights of one or more patent holders. This license does not release you from the requirement that you obtain separate licenses from these patent holders to use this software.
• Use of the software either in source or binary form, must be run on or directly connected to an Analog Devices Inc. component.

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, 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

no_os_pid_control()

int no_os_pid_control	(	struct no_os_pid *	pid,
		int	SP,
		int	PV,
		int *	output
	)

Here is the caller graph for this function:

no_os_pid_hysteresis()

int no_os_pid_hysteresis	(	struct no_os_pid *	pid,
		unsigned int	hyst
	)

Here is the caller graph for this function:

no_os_pid_init()

int no_os_pid_init	(	struct no_os_pid **	pid,
		struct no_os_pid_config	config
	)

no_os_pid_remove()

int no_os_pid_remove

(

struct no_os_pid *

pid

)

Here is the caller graph for this function:

no_os_pid_reset()

int no_os_pid_reset

(

struct no_os_pid *

pid

)

Here is the caller graph for this function: