Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: HelloWorld_IKA01A1
Fork of
X_NUCLEO_IKA01A1
by 
ST Expansion SW Team
XNucleoIKA01A1 Class Reference
Class XNucleoIKA01A1 represents multifunctional expansion board based on operational amplifiers. More...
#include <XNucleoIKA01A1.h>
Public Member Functions | |
| bool | init (void) |
| Initialize the singleton's operational amplifiers to default settings. | |
| ~XNucleoIKA01A1 (void) | |
| Destructor. | |
Static Public Member Functions | |
| static XNucleoIKA01A1 * | instance (PinName instrumentAmpPin, PinName currentSensorPin, PinName photoSensorPin, PinName windCmpSignalPin_1, PinName windCmpSignalPin_2, PinName ledDriverPin, double ledDriverPeriod_us) |
| Getting a singleton instance of XNucleoIKA01A1 class. | |
Protected Member Functions | |
| XNucleoIKA01A1 (PinName instrumentAmpPin, PinName currentSensorPin, PinName photoSensorPin, PinName windCmpSignalPin_1, PinName windCmpSignalPin_2, PinName ledDriverPin, double ledDriverPeriod_us) | |
| Constructor. | |
| bool | init_TSZ124 (void) |
| Initialize the TSZ124 component. | |
| bool | init_TSU104 (void) |
| Initialize the TSU104 component. | |
| bool | init_TSV734 (void) |
| Initialize the TSV734 component. | |
Detailed Description
Class XNucleoIKA01A1 represents multifunctional expansion board based on operational amplifiers.
It provides an easy-to-use and affordable solution for different multifunctional use cases with your STM32 Nucleo board. For current sensing configuration and the instrumentation amplifier configuration, a highly accurate operational amplifier (TSZ124) is used. The expansion board also contains Nanopower (TSU104) and Micropower (TSV734) operational amplifiers for mobile applications. It is intentionally implemented as a singleton because only one XNucleoIKA01A1 at a time might be deployed in a HW component stack.
In order to get the singleton instance you have to call class method `Instance()`, e.g.:
// Inertial & Environmental expansion board singleton instance static XNucleoIKA01A1 *<TODO>_expansion_board = XNucleoIKA01A1::instance();
Definition at line 87 of file XNucleoIKA01A1.h.
Constructor & Destructor Documentation
| ~XNucleoIKA01A1 | ( | void | ) |
Destructor.
Definition at line 110 of file XNucleoIKA01A1.h.
| XNucleoIKA01A1 | ( | PinName | instrumentAmpPin, |
| PinName | currentSensorPin, | ||
| PinName | photoSensorPin, | ||
| PinName | windCmpSignalPin_1, | ||
| PinName | windCmpSignalPin_2, | ||
| PinName | ledDriverPin, | ||
| double | ledDriverPeriod_us | ||
| ) | [protected] |
Constructor.
Definition at line 65 of file XNucleoIKA01A1.cpp.
Member Function Documentation
| bool init | ( | void | ) |
Initialize the singleton's operational amplifiers to default settings.
Initializing the X_NUCLEO_IKA01A1 board.
- Return values:
-
true if initialization is successful false otherwise.
Definition at line 116 of file XNucleoIKA01A1.cpp.
| bool init_TSU104 | ( | void | ) | [protected] |
Initialize the TSU104 component.
- Return values:
-
true if initialization is successful false otherwise
Definition at line 169 of file XNucleoIKA01A1.cpp.
| bool init_TSV734 | ( | void | ) | [protected] |
Initialize the TSV734 component.
- Return values:
-
true if initialization is successful false otherwise
Definition at line 203 of file XNucleoIKA01A1.cpp.
| bool init_TSZ124 | ( | void | ) | [protected] |
Initialize the TSZ124 component.
- Return values:
-
true if initialization is successful false otherwise
Definition at line 135 of file XNucleoIKA01A1.cpp.
| XNucleoIKA01A1 * instance | ( | PinName | instrumentAmpPin, |
| PinName | currentSensorPin, | ||
| PinName | photoSensorPin, | ||
| PinName | windCmpSignalPin_1, | ||
| PinName | windCmpSignalPin_2, | ||
| PinName | ledDriverPin, | ||
| double | ledDriverPeriod_us | ||
| ) | [static] |
Getting a singleton instance of XNucleoIKA01A1 class.
- Return values:
-
a singleton instance of XNucleoIKA01A1 class.
Definition at line 90 of file XNucleoIKA01A1.cpp.
Generated on Tue Jul 12 2022 17:01:49 by
1.7.2
X-NUCLEO-IKA01A1 Multifunctional board based on operational amplifiers.