basic_example.h File Reference

BASIC example header. More...

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

Go to the source code of this file.

Functions
int	basic_example_main ()
	basic example main execution. More...

Detailed Description

BASIC example header.

Author

Axel Haslam (ahasl.nosp@m.am@b.nosp@m.aylib.nosp@m.re.c.nosp@m.om)

Copyright 2024(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

basic_example_main()

int basic_example_main

(

)

basic example main execution.

Returns

ret - Result of the example execution. If working correctly, will execute print the sample data.

ret - 0 on success.

basic example main execution.

Returns

ret - Result of the example execution. If working correctly, will execute continuously the while(1) loop and will not return.

basic example main execution.

Returns

ret - Result of the example execution. If working correctly, will execute continuously function basic_app_run and will not return.

ret - Result of the example execution. If working correctly, will execute print the sample data.

ret - 0 on success.

basic example main execution.

Returns

ret - Result of the example execution. If working correctly, will execute continuously the while(1) loop and will not return.

basic example main execution.

Returns

ret - Result of the example execution. If working correctly, will execute continuously function basic_app_run and will not return.

basic example main execution.

Returns

ret - Result of the example execution.

ret - Result of the example execution.

ret - Result of the example execution. If working correctly, will execute print the sample data.

ret - 0 on success.

basic example main execution.

Returns

ret - Result of the example execution. If working correctly, will execute continuously the while(1) loop and will not return.

basic example main execution.

Returns

ret - Result of the example execution. If working correctly, will execute continuously function basic_app_run and will not return.

basic example main execution.

Returns

ret - Result of the example execution.

ret - Result of the example execution.

basic example main execution.

Returns

ret - Result of the example execution. If working correctly, will turn the status led's on and off in the while loop, set some values in the config 2 register, and then return 0.

ret - Result of the example execution. If working correctly, will execute print the sample data.

ret - 0 on success.

basic example main execution.

Returns

ret - Result of the example execution. If working correctly, will execute continuously the while(1) loop and will not return.

basic example main execution.

Returns

ret - Result of the example execution. If working correctly, will execute continuously function basic_app_run and will not return.

basic example main execution.

Returns

ret - Result of the example execution.

ret - Result of the example execution.

basic example main execution.

Returns

ret - Result of the example execution. If working correctly, will turn the status led's on and off in the while loop, set some values in the config 2 register, and then return 0.

basic example main execution.

Returns

ret - Result of the example execution. If working correctly, will show the user for each channels if there is digital input present or not. It also changes delay values for channel 3 and sets the state for channel 0 to OFF. If all these operations were performed correctly 0 will be returned.

basic example main execution.

Returns

ret - Result for the main execution of the example. If working correctly the device's channel 0 will be set to SOURCE mode and also have delay values changed. Counter values for channel 0 will be changed as well and printed afterwards. 0 will be returned at the end in case of succes.

ret - Result of the example execution. If working correctly, will execute print the sample data.

ret - 0 on success.

basic example main execution.

Returns

ret - Result of the example execution. If working correctly, will execute continuously the while(1) loop and will not return.

basic example main execution.

Returns

ret - Result of the example execution. If working correctly, will execute continuously function basic_app_run and will not return.

basic example main execution.

Returns

ret - Result of the example execution.

ret - Result of the example execution.

basic example main execution.

Returns

ret - Result of the example execution. If working correctly, will turn the status led's on and off in the while loop, set some values in the config 2 register, and then return 0.

basic example main execution.

Returns

ret - Result of the example execution. If working correctly, will show the user for each channels if there is digital input present or not. It also changes delay values for channel 3 and sets the state for channel 0 to OFF. If all these operations were performed correctly 0 will be returned.

basic example main execution.

Returns

ret - Result for the main execution of the example. If working correctly the device's channel 0 will be set to SOURCE mode and also have delay values changed. Counter values for channel 0 will be changed as well and printed afterwards. 0 will be returned at the end in case of succes.

Parameter to be passed when the callback is called.

GPIO Pin Interrupt Controller

MAX14906 Initialization

Setting SLED set bit 1 in the config register.

Turning the Status LEDs on, then off.

Setting a current limit for channel 0.

Read current limit for all channels.

Setting the on state for channel 0, and then verifying it.

Parameter to be passed when the callback is called.

GPIO Pin Interrupt Controller

MAX14906 Initialization

Setting SLED set bit 1 in the config register.

Turning the Status LEDs on, then off.

Setting a current limit for channel 0.

Read current limit for all channels.

Setting the on state for channel 0, and then verifying it.

Parameter to be passed when the callback is called.

GPIO Pin Interrupt Controller

MAX14906 Initialization

Setting SLED set bit 1 in the config register.

Turning the Status LEDs on, then off.

Setting a current limit for channel 0.

Read current limit for all channels.

Setting the on state for channel 0, and then verifying it.

Parameter to be passed when the callback is called.

GPIO Pin Interrupt Controller

MAX14906 Initialization

Setting SLED set bit 1 in the config register.

Turning the Status LEDs on, then off.

Setting a current limit for channel 0.

Read current limit for all channels.

Setting the on state for channel 0, and then verifying it.

Maximum value of 3V.

The increment of the AO1 to be used (needs to be smaller then the SR step-size).

Frequency of the signal.

Initializing GPIO 0 of MAX2201X.

Setting its value to HIGH.

Changing operation mode of MAX2201X.

Changing configuration of MAX2201X.

Changing slew-rate configuration of MAX2201X.

Reading the GAIN correction.

Parameter to be passed when the callback is called.

GPIO Pin Interrupt Controller

MAX14906 Initialization

Setting SLED set bit 1 in the config register.

Turning the Status LEDs on, then off.

Setting a current limit for channel 0.

Read current limit for all channels.

Setting the on state for channel 0, and then verifying it.

Maximum value of 3V.

The increment of the AO1 to be used (needs to be smaller then the SR step-size).

Frequency of the signal.

Initializing GPIO 0 of MAX2201X.

Setting its value to HIGH.

Changing operation mode of MAX2201X.

Changing configuration of MAX2201X.

Changing slew-rate configuration of MAX2201X.

Reading the GAIN correction.

Parameter to be passed when the callback is called.

GPIO Pin Interrupt Controller

MAX14906 Initialization

Setting SLED set bit 1 in the config register.

Turning the Status LEDs on, then off.

Setting a current limit for channel 0.

Read current limit for all channels.

Setting the on state for channel 0, and then verifying it.

Maximum value of 3V.

The increment of the AO1 to be used (needs to be smaller then the SR step-size).

Frequency of the signal.

Initializing GPIO 0 of MAX2201X.

Setting its value to HIGH.

Changing operation mode of MAX2201X.

Changing configuration of MAX2201X.

Changing slew-rate configuration of MAX2201X.

Reading the GAIN correction.

Parameter to be passed when the callback is called.

GPIO Pin Interrupt Controller

MAX14906 Initialization

Setting SLED set bit 1 in the config register.

Turning the Status LEDs on, then off.

Setting a current limit for channel 0.

Read current limit for all channels.

Setting the on state for channel 0, and then verifying it.

Maximum value of 3V.

The increment of the AO1 to be used (needs to be smaller then the SR step-size).

Frequency of the signal.

Initializing GPIO 0 of MAX2201X.

Setting its value to HIGH.

Changing operation mode of MAX2201X.

Changing configuration of MAX2201X.

Changing slew-rate configuration of MAX2201X.

Reading the GAIN correction.

Parameter to be passed when the callback is called.

GPIO Pin Interrupt Controller

MAX14906 Initialization

Setting SLED set bit 1 in the config register.

Turning the Status LEDs on, then off.

Setting a current limit for channel 0.

Read current limit for all channels.

Setting the on state for channel 0, and then verifying it.

Maximum value of 3V.

The increment of the AO1 to be used (needs to be smaller then the SR step-size).

Frequency of the signal.

Initializing GPIO 0 of MAX2201X.

Setting its value to HIGH.

Changing operation mode of MAX2201X.

Changing configuration of MAX2201X.

Changing slew-rate configuration of MAX2201X.

Reading the GAIN correction.