Compare commits
No commits in common. "main" and "gh-pages" have entirely different histories.
46
.github/ISSUE_TEMPLATE.md
vendored
|
|
@ -1,46 +0,0 @@
|
|||
Thank you for opening an issue on an Adafruit Arduino library repository. To
|
||||
improve the speed of resolution please review the following guidelines and
|
||||
common troubleshooting steps below before creating the issue:
|
||||
|
||||
- **Do not use GitHub issues for troubleshooting projects and issues.** Instead use
|
||||
the forums at http://forums.adafruit.com to ask questions and troubleshoot why
|
||||
something isn't working as expected. In many cases the problem is a common issue
|
||||
that you will more quickly receive help from the forum community. GitHub issues
|
||||
are meant for known defects in the code. If you don't know if there is a defect
|
||||
in the code then start with troubleshooting on the forum first.
|
||||
|
||||
- **If following a tutorial or guide be sure you didn't miss a step.** Carefully
|
||||
check all of the steps and commands to run have been followed. Consult the
|
||||
forum if you're unsure or have questions about steps in a guide/tutorial.
|
||||
|
||||
- **For Arduino projects check these very common issues to ensure they don't apply**:
|
||||
|
||||
- For uploading sketches or communicating with the board make sure you're using
|
||||
a **USB data cable** and **not** a **USB charge-only cable**. It is sometimes
|
||||
very hard to tell the difference between a data and charge cable! Try using the
|
||||
cable with other devices or swapping to another cable to confirm it is not
|
||||
the problem.
|
||||
|
||||
- **Be sure you are supplying adequate power to the board.** Check the specs of
|
||||
your board and plug in an external power supply. In many cases just
|
||||
plugging a board into your computer is not enough to power it and other
|
||||
peripherals.
|
||||
|
||||
- **Double check all soldering joints and connections.** Flakey connections
|
||||
cause many mysterious problems. See the [guide to excellent soldering](https://learn.adafruit.com/adafruit-guide-excellent-soldering/tools) for examples of good solder joints.
|
||||
|
||||
- **Ensure you are using an official Arduino or Adafruit board.** We can't
|
||||
guarantee a clone board will have the same functionality and work as expected
|
||||
with this code and don't support them.
|
||||
|
||||
If you're sure this issue is a defect in the code and checked the steps above
|
||||
please fill in the following fields to provide enough troubleshooting information.
|
||||
You may delete the guideline and text above to just leave the following details:
|
||||
|
||||
- Arduino board: **INSERT ARDUINO BOARD NAME/TYPE HERE**
|
||||
|
||||
- Arduino IDE version (found in Arduino -> About Arduino menu): **INSERT ARDUINO
|
||||
VERSION HERE**
|
||||
|
||||
- List the steps to reproduce the problem below (if possible attach a sketch or
|
||||
copy the sketch code in too): **LIST REPRO STEPS BELOW**
|
||||
26
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
|
@ -1,26 +0,0 @@
|
|||
Thank you for creating a pull request to contribute to Adafruit's GitHub code!
|
||||
Before you open the request please review the following guidelines and tips to
|
||||
help it be more easily integrated:
|
||||
|
||||
- **Describe the scope of your change--i.e. what the change does and what parts
|
||||
of the code were modified.** This will help us understand any risks of integrating
|
||||
the code.
|
||||
|
||||
- **Describe any known limitations with your change.** For example if the change
|
||||
doesn't apply to a supported platform of the library please mention it.
|
||||
|
||||
- **Please run any tests or examples that can exercise your modified code.** We
|
||||
strive to not break users of the code and running tests/examples helps with this
|
||||
process.
|
||||
|
||||
Thank you again for contributing! We will try to test and integrate the change
|
||||
as soon as we can, but be aware we have many GitHub repositories to manage and
|
||||
can't immediately respond to every request. There is no need to bump or check in
|
||||
on a pull request (it will clutter the discussion of the request).
|
||||
|
||||
Also don't be worried if the request is closed or not integrated--sometimes the
|
||||
priorities of Adafruit's GitHub code (education, ease of use) might not match the
|
||||
priorities of the pull request. Don't fret, the open source community thrives on
|
||||
forks and GitHub makes it easy to keep your changes in a forked repo.
|
||||
|
||||
After reviewing the guidelines above you can delete this text from the pull request.
|
||||
32
.github/workflows/githubci.yml
vendored
|
|
@ -1,32 +0,0 @@
|
|||
name: Arduino Library CI
|
||||
|
||||
on: [pull_request, push, repository_dispatch]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/setup-python@v1
|
||||
with:
|
||||
python-version: '3.x'
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/checkout@v2
|
||||
with:
|
||||
repository: adafruit/ci-arduino
|
||||
path: ci
|
||||
|
||||
- name: pre-install
|
||||
run: bash ci/actions_install.sh
|
||||
|
||||
- name: clang
|
||||
run: python3 ci/run-clang-format.py -e "ci/*" -e "bin/*" -r .
|
||||
|
||||
- name: test platforms
|
||||
run: python3 ci/build_platform.py main_platforms
|
||||
|
||||
- name: doxygen
|
||||
env:
|
||||
GH_REPO_TOKEN: ${{ secrets.GH_REPO_TOKEN }}
|
||||
PRETTYNAME : "Adafruit INA237 and INA238 Arduino Library"
|
||||
run: bash ci/doxy_gen_and_deploy.sh
|
||||
8
.gitignore
vendored
|
|
@ -1,8 +0,0 @@
|
|||
html/
|
||||
Doxyfile
|
||||
.vscode/
|
||||
.pio/
|
||||
**/.claude/settings.local.json
|
||||
*.bak
|
||||
*.txt
|
||||
*.pdf
|
||||
1
.nojekyll
Normal file
|
|
@ -0,0 +1 @@
|
|||
|
||||
|
|
@ -1,210 +0,0 @@
|
|||
/*!
|
||||
* @file Adafruit_INA237.cpp
|
||||
*
|
||||
* @section ina237_intro Introduction
|
||||
*
|
||||
* I2C Driver for the INA237/INA238 I2C Current and Power sensor
|
||||
*
|
||||
* Note: INA237 and INA238 are functionally identical devices with different
|
||||
* part numbers. This class implements all functionality for both chips.
|
||||
*
|
||||
* This is a library for the Adafruit INA237/INA238 breakouts:
|
||||
* http://www.adafruit.com/products/xxxx
|
||||
*
|
||||
* Adafruit invests time and resources providing this open source code,
|
||||
* please support Adafruit and open-source hardware by purchasing products from
|
||||
* Adafruit!
|
||||
*
|
||||
* @section ina237_dependencies Dependencies
|
||||
*
|
||||
* This library depends on the Adafruit BusIO library
|
||||
*
|
||||
* @section ina237_author Author
|
||||
*
|
||||
* Limor "Ladyada" Fried for Adafruit Industries
|
||||
*
|
||||
* @section ina237_license License
|
||||
*
|
||||
* MIT (see license.txt)
|
||||
*
|
||||
* @section ina237_history HISTORY
|
||||
*
|
||||
* v1.0 - First release
|
||||
*/
|
||||
|
||||
#include "Adafruit_INA237.h"
|
||||
|
||||
#include <Wire.h>
|
||||
|
||||
#include "Arduino.h"
|
||||
|
||||
/*!
|
||||
* @brief Instantiates a new INA237 class
|
||||
*/
|
||||
Adafruit_INA237::Adafruit_INA237(void) {}
|
||||
|
||||
/*!
|
||||
* @brief Sets up the HW
|
||||
* @param i2c_address
|
||||
* The I2C address to be used.
|
||||
* @param theWire
|
||||
* The Wire object to be used for I2C connections.
|
||||
* @param skipReset
|
||||
* When set to true, will omit resetting all INA237 registers to
|
||||
* their default values. Default: false.
|
||||
* @return True if initialization was successful, otherwise false.
|
||||
*/
|
||||
bool Adafruit_INA237::begin(uint8_t i2c_address, TwoWire* theWire,
|
||||
bool skipReset) {
|
||||
if (!Adafruit_INA2xx::begin(i2c_address, theWire, skipReset)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// make sure we're talking to the right chip
|
||||
if (_device_id != INA237_DEVICE_ID) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**************************************************************************/
|
||||
/*!
|
||||
@brief Updates the shunt calibration value to the INA237 register.
|
||||
The INA237 uses a different calculation than the INA228.
|
||||
*/
|
||||
/**************************************************************************/
|
||||
void Adafruit_INA237::_updateShuntCalRegister() {
|
||||
// Formula from INA237 datasheet (SBOSA20A)
|
||||
// SHUNT_CAL = 819.2 x 10^6 x CURRENT_LSB x RSHUNT
|
||||
|
||||
float scale = 1;
|
||||
if (getADCRange()) {
|
||||
scale = 4; // For lower range (+/-40.96mV)
|
||||
}
|
||||
|
||||
// Correct calculation for INA237
|
||||
float shunt_cal = 819.2e6 * _current_lsb * _shunt_res * scale;
|
||||
|
||||
Adafruit_I2CRegister shunt =
|
||||
Adafruit_I2CRegister(i2c_dev, INA2XX_REG_SHUNTCAL, 2, MSBFIRST);
|
||||
shunt.write(shunt_cal);
|
||||
}
|
||||
|
||||
/**************************************************************************/
|
||||
/*!
|
||||
@brief Returns the current alert type
|
||||
@return The current alert type
|
||||
*/
|
||||
/**************************************************************************/
|
||||
INA237_AlertType Adafruit_INA237::getAlertType(void) {
|
||||
// The alert bits are in different positions in the INA237
|
||||
Adafruit_I2CRegisterBits alert_type =
|
||||
Adafruit_I2CRegisterBits(Diag_Alert, 7, 5);
|
||||
return (INA237_AlertType)alert_type.read();
|
||||
}
|
||||
|
||||
/**************************************************************************/
|
||||
/*!
|
||||
@brief Sets a new alert type
|
||||
@param alert
|
||||
The new alert type to be set
|
||||
*/
|
||||
/**************************************************************************/
|
||||
void Adafruit_INA237::setAlertType(INA237_AlertType alert) {
|
||||
// The alert bits are in different positions in the INA237
|
||||
Adafruit_I2CRegisterBits alert_type =
|
||||
Adafruit_I2CRegisterBits(Diag_Alert, 7, 5);
|
||||
alert_type.write(alert);
|
||||
}
|
||||
|
||||
/**************************************************************************/
|
||||
/*!
|
||||
@brief Reads the die temperature with the INA237-specific conversion factor
|
||||
@return The current die temp in deg C
|
||||
*/
|
||||
/**************************************************************************/
|
||||
float Adafruit_INA237::readDieTemp(void) {
|
||||
Adafruit_I2CRegister temp =
|
||||
Adafruit_I2CRegister(i2c_dev, INA2XX_REG_DIETEMP, 2, MSBFIRST);
|
||||
int16_t t = temp.read();
|
||||
// INA237 uses 12 bits for temperature (bits 15:4) with 125 m°C/LSB
|
||||
// Shift by 4 to get the actual value from register bits 15:4
|
||||
return (float)(t >> 4) * 125.0 / 1000.0;
|
||||
}
|
||||
|
||||
/**************************************************************************/
|
||||
/*!
|
||||
@brief Reads and scales the current value of the Bus Voltage register
|
||||
using INA237-specific conversion factor.
|
||||
@return The current bus voltage measurement in V
|
||||
*/
|
||||
/**************************************************************************/
|
||||
float Adafruit_INA237::readBusVoltage(void) {
|
||||
Adafruit_I2CRegister bus_voltage =
|
||||
Adafruit_I2CRegister(i2c_dev, INA2XX_REG_VBUS, 2, MSBFIRST);
|
||||
// INA237 uses 3.125 mV/LSB for bus voltage
|
||||
// Bus voltage is a 16-bit value in the INA237 (unlike INA228 which is 24-bit)
|
||||
return (float)((uint16_t)bus_voltage.read()) * 3.125 / 1000.0;
|
||||
}
|
||||
|
||||
/**************************************************************************/
|
||||
/*!
|
||||
@brief Reads and scales the current value of the Shunt Voltage register
|
||||
using INA237-specific conversion factor.
|
||||
@return The current shunt voltage measurement in V
|
||||
*/
|
||||
/**************************************************************************/
|
||||
float Adafruit_INA237::readShuntVoltage(void) {
|
||||
float scale = 5.0; // 5 µV/LSB in normal mode
|
||||
if (getADCRange()) {
|
||||
scale = 1.25; // 1.25 µV/LSB in low range mode
|
||||
}
|
||||
|
||||
Adafruit_I2CRegister shunt_voltage =
|
||||
Adafruit_I2CRegister(i2c_dev, INA2XX_REG_VSHUNT, 2, MSBFIRST);
|
||||
int16_t v = shunt_voltage.read();
|
||||
return (float)v * scale / 1000000.0; // Convert µV to V
|
||||
}
|
||||
|
||||
/**************************************************************************/
|
||||
/*!
|
||||
@brief Reads and scales the current value of the Current register
|
||||
using INA237-specific handling.
|
||||
@return The current measurement in mA
|
||||
*/
|
||||
/**************************************************************************/
|
||||
float Adafruit_INA237::readCurrent(void) {
|
||||
Adafruit_I2CRegister current =
|
||||
Adafruit_I2CRegister(i2c_dev, INA2XX_REG_CURRENT, 2, MSBFIRST);
|
||||
int16_t i = current.read();
|
||||
return (float)i * _current_lsb * 1000.0; // Convert A to mA
|
||||
}
|
||||
|
||||
/**************************************************************************/
|
||||
/*!
|
||||
@brief Reads and scales the current value of the Power register
|
||||
using INA237-specific handling.
|
||||
@return The current Power calculation in mW
|
||||
*/
|
||||
/**************************************************************************/
|
||||
float Adafruit_INA237::readPower(void) {
|
||||
Adafruit_I2CRegister power =
|
||||
Adafruit_I2CRegister(i2c_dev, INA2XX_REG_POWER, 2, MSBFIRST);
|
||||
// INA237 power LSB = 20 * current_lsb
|
||||
return (float)power.read() * 20.0 * _current_lsb * 1000.0; // Convert W to mW
|
||||
}
|
||||
|
||||
/**************************************************************************/
|
||||
/*!
|
||||
@brief Sets the shunt calibration by resistor for INA237.
|
||||
@param shunt_res Resistance of the shunt in ohms (floating point)
|
||||
@param max_current Maximum expected current in A (floating point)
|
||||
*/
|
||||
/**************************************************************************/
|
||||
void Adafruit_INA237::setShunt(float shunt_res, float max_current) {
|
||||
_shunt_res = shunt_res;
|
||||
// INA237 uses 2^15 as the divisor
|
||||
_current_lsb = max_current / (float)(1UL << 15);
|
||||
_updateShuntCalRegister();
|
||||
}
|
||||
|
|
@ -1,69 +0,0 @@
|
|||
/*!
|
||||
* @file Adafruit_INA237.h
|
||||
*
|
||||
* I2C Driver for INA237/INA238 Current and Power sensors
|
||||
*
|
||||
* Note: INA237 and INA238 are functionally identical devices with different
|
||||
* part numbers. This class implements all functionality for both chips.
|
||||
*
|
||||
* This is a library for the Adafruit INA237/INA238 breakouts:
|
||||
* http://www.adafruit.com/products/xxxx
|
||||
*
|
||||
* Adafruit invests time and resources providing this open source code,
|
||||
* please support Adafruit and open-source hardware by purchasing products from
|
||||
* Adafruit!
|
||||
*
|
||||
*
|
||||
* MIT license (see license.txt)
|
||||
*/
|
||||
|
||||
#ifndef _ADAFRUIT_INA237_H
|
||||
#define _ADAFRUIT_INA237_H
|
||||
|
||||
#include <Adafruit_INA2xx.h>
|
||||
|
||||
#define INA237_I2CADDR_DEFAULT 0x40 ///< INA237/INA238 default i2c address
|
||||
#define INA237_DEVICE_ID 0x238 ///< INA237 device ID
|
||||
#define INA238_DEVICE_ID 0x238 ///< INA238 device ID (identical to INA237)
|
||||
|
||||
/**
|
||||
* @brief Alert trigger options specific to INA237/INA238.
|
||||
*
|
||||
* Allowed values for setAlertType.
|
||||
*/
|
||||
typedef enum _ina237_alert_type {
|
||||
INA237_ALERT_CONVERSION_READY = 0x1, ///< Trigger on conversion ready
|
||||
INA237_ALERT_OVERTEMPERATURE = 0x2, ///< Trigger on overtemperature
|
||||
INA237_ALERT_OVERPOWER = 0x4, ///< Trigger on power over limit
|
||||
INA237_ALERT_UNDERVOLTAGE = 0x8, ///< Trigger on bus voltage under limit
|
||||
INA237_ALERT_OVERVOLTAGE = 0x10, ///< Trigger on bus voltage over limit
|
||||
INA237_ALERT_UNDERSHUNT = 0x20, ///< Trigger on shunt voltage under limit
|
||||
INA237_ALERT_OVERSHUNT = 0x40, ///< Trigger on shunt voltage over limit
|
||||
INA237_ALERT_NONE = 0x0, ///< Do not trigger alert pin (Default)
|
||||
} INA237_AlertType;
|
||||
|
||||
/*!
|
||||
* @brief Class that stores state and functions for interacting with
|
||||
* INA237/INA238 Current and Power Sensors
|
||||
*/
|
||||
class Adafruit_INA237 : public Adafruit_INA2xx {
|
||||
public:
|
||||
Adafruit_INA237();
|
||||
bool begin(uint8_t i2c_addr = INA237_I2CADDR_DEFAULT,
|
||||
TwoWire* theWire = &Wire, bool skipReset = false);
|
||||
|
||||
// INA237/INA238 specific functions
|
||||
INA237_AlertType getAlertType(void);
|
||||
void setAlertType(INA237_AlertType alert);
|
||||
float readDieTemp(void) override;
|
||||
float readBusVoltage(void) override;
|
||||
float readShuntVoltage(void) override;
|
||||
float readCurrent(void) override;
|
||||
float readPower(void) override;
|
||||
void setShunt(float shunt_res = 0.1, float max_current = 3.2) override;
|
||||
|
||||
protected:
|
||||
void _updateShuntCalRegister(void) override;
|
||||
};
|
||||
|
||||
#endif
|
||||
|
|
@ -1,62 +0,0 @@
|
|||
/*!
|
||||
* @file Adafruit_INA238.cpp
|
||||
*
|
||||
* @section ina238_intro Introduction
|
||||
*
|
||||
* I2C Driver for the INA238 I2C Current and Power sensor
|
||||
*
|
||||
* This is a library for the Adafruit INA238 breakout:
|
||||
* http://www.adafruit.com/products/xxxx
|
||||
*
|
||||
* Adafruit invests time and resources providing this open source code,
|
||||
* please support Adafruit and open-source hardware by purchasing products from
|
||||
* Adafruit!
|
||||
*
|
||||
* @section ina238_dependencies Dependencies
|
||||
*
|
||||
* This library depends on the Adafruit BusIO library
|
||||
*
|
||||
* @section ina238_author Author
|
||||
*
|
||||
* Limor "Ladyada" Fried for Adafruit Industries
|
||||
*
|
||||
* @section ina238_license License
|
||||
*
|
||||
* MIT (see license.txt)
|
||||
*
|
||||
* @section ina238_history HISTORY
|
||||
*
|
||||
* v1.0 - First release
|
||||
*/
|
||||
|
||||
#include "Adafruit_INA238.h"
|
||||
|
||||
/*!
|
||||
* @brief Instantiates a new INA238 class
|
||||
*/
|
||||
Adafruit_INA238::Adafruit_INA238(void) {}
|
||||
|
||||
/*!
|
||||
* @brief Sets up the HW
|
||||
* @param i2c_address
|
||||
* The I2C address to be used.
|
||||
* @param theWire
|
||||
* The Wire object to be used for I2C connections.
|
||||
* @param skipReset
|
||||
* When set to true, will omit resetting all registers to
|
||||
* their default values. Default: false.
|
||||
* @return True if initialization was successful, otherwise false.
|
||||
*/
|
||||
bool Adafruit_INA238::begin(uint8_t i2c_address, TwoWire* theWire,
|
||||
bool skipReset) {
|
||||
if (!Adafruit_INA2xx::begin(i2c_address, theWire, skipReset)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// make sure we're talking to the right chip (must be INA238)
|
||||
if (_device_id != INA238_DEVICE_ID) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
|
@ -1,36 +0,0 @@
|
|||
/*!
|
||||
* @file Adafruit_INA238.h
|
||||
*
|
||||
* I2C Driver for INA238 Current and Power sensor
|
||||
*
|
||||
* This is a library for the Adafruit INA238 breakout:
|
||||
* http://www.adafruit.com/products/xxxx
|
||||
*
|
||||
* Adafruit invests time and resources providing this open source code,
|
||||
* please support Adafruit and open-source hardware by purchasing products from
|
||||
* Adafruit!
|
||||
*
|
||||
*
|
||||
* MIT license (see license.txt)
|
||||
*/
|
||||
|
||||
#ifndef _ADAFRUIT_INA238_H
|
||||
#define _ADAFRUIT_INA238_H
|
||||
|
||||
#include "Adafruit_INA237.h"
|
||||
|
||||
#define INA238_I2CADDR_DEFAULT 0x40 ///< INA238 default i2c address
|
||||
#define INA238_DEVICE_ID 0x238 ///< INA238 device ID
|
||||
|
||||
/*!
|
||||
* @brief Class that stores state and functions for interacting with
|
||||
* INA238 Current and Power Sensor (identical to INA237)
|
||||
*/
|
||||
class Adafruit_INA238 : public Adafruit_INA237 {
|
||||
public:
|
||||
Adafruit_INA238();
|
||||
bool begin(uint8_t i2c_addr = INA238_I2CADDR_DEFAULT,
|
||||
TwoWire* theWire = &Wire, bool skipReset = false);
|
||||
};
|
||||
|
||||
#endif
|
||||
37
README.md
|
|
@ -1,37 +0,0 @@
|
|||
# Adafruit_INA237_INA238
|
||||
Arduino library for the INA237 and INA238 power monitors
|
||||
|
||||
[](https://github.com/adafruit/Adafruit_INA237_INA238/actions)
|
||||
[](https://adafruit.github.io/Adafruit_INA237_INA238/html/index.html)
|
||||
|
||||
This is the Adafruit INA237 and INA238 Current and Power sensor library.
|
||||
|
||||
## Device Information
|
||||
|
||||
The INA237 and INA238 are functionally identical devices with different part numbers. They share:
|
||||
- Same register map
|
||||
- Same device ID (0x238)
|
||||
- Same measurement capabilities and accuracy
|
||||
- Same configuration options
|
||||
|
||||
This library provides separate classes for each part number for clarity:
|
||||
- `Adafruit_INA237` - For INA237 devices
|
||||
- `Adafruit_INA238` - For INA238 devices (a thin wrapper around the INA237 implementation)
|
||||
|
||||
Tested and works great with the Adafruit INA237 and INA238 Breakout Boards.
|
||||
|
||||
These chips use I2C to communicate, 2 pins are required to interface.
|
||||
|
||||
## Installation
|
||||
|
||||
To install, use the Arduino Library Manager and search for "Adafruit INA237" and install the library.
|
||||
|
||||
## License Information
|
||||
|
||||
Adafruit invests time and resources providing this open source code,
|
||||
please support Adafruit and open-source hardware by purchasing
|
||||
products from Adafruit!
|
||||
|
||||
Written by Limor "Ladyada" Fried for Adafruit Industries.
|
||||
MIT license, check license.txt for more information
|
||||
All text above must be included in any redistribution
|
||||
|
|
@ -1,127 +0,0 @@
|
|||
# Adafruit Community Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as
|
||||
contributors and leaders pledge to making participation in our project and
|
||||
our community a harassment-free experience for everyone, regardless of age, body
|
||||
size, disability, ethnicity, gender identity and expression, level or type of
|
||||
experience, education, socio-economic status, nationality, personal appearance,
|
||||
race, religion, or sexual identity and orientation.
|
||||
|
||||
## Our Standards
|
||||
|
||||
We are committed to providing a friendly, safe and welcoming environment for
|
||||
all.
|
||||
|
||||
Examples of behavior that contributes to creating a positive environment
|
||||
include:
|
||||
|
||||
* Be kind and courteous to others
|
||||
* Using welcoming and inclusive language
|
||||
* Being respectful of differing viewpoints and experiences
|
||||
* Collaborating with other community members
|
||||
* Gracefully accepting constructive criticism
|
||||
* Focusing on what is best for the community
|
||||
* Showing empathy towards other community members
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
* The use of sexualized language or imagery and sexual attention or advances
|
||||
* The use of inappropriate images, including in a community member's avatar
|
||||
* The use of inappropriate language, including in a community member's nickname
|
||||
* Any spamming, flaming, baiting or other attention-stealing behavior
|
||||
* Excessive or unwelcome helping; answering outside the scope of the question
|
||||
asked
|
||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or electronic
|
||||
address, without explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate
|
||||
|
||||
The goal of the standards and moderation guidelines outlined here is to build
|
||||
and maintain a respectful community. We ask that you don’t just aim to be
|
||||
"technically unimpeachable", but rather try to be your best self.
|
||||
|
||||
We value many things beyond technical expertise, including collaboration and
|
||||
supporting others within our community. Providing a positive experience for
|
||||
other community members can have a much more significant impact than simply
|
||||
providing the correct answer.
|
||||
|
||||
## Our Responsibilities
|
||||
|
||||
Project leaders are responsible for clarifying the standards of acceptable
|
||||
behavior and are expected to take appropriate and fair corrective action in
|
||||
response to any instances of unacceptable behavior.
|
||||
|
||||
Project leaders have the right and responsibility to remove, edit, or
|
||||
reject messages, comments, commits, code, issues, and other contributions
|
||||
that are not aligned to this Code of Conduct, or to ban temporarily or
|
||||
permanently any community member for other behaviors that they deem
|
||||
inappropriate, threatening, offensive, or harmful.
|
||||
|
||||
## Moderation
|
||||
|
||||
Instances of behaviors that violate the Adafruit Community Code of Conduct
|
||||
may be reported by any member of the community. Community members are
|
||||
encouraged to report these situations, including situations they witness
|
||||
involving other community members.
|
||||
|
||||
You may report in the following ways:
|
||||
|
||||
In any situation, you may send an email to <support@adafruit.com>.
|
||||
|
||||
On the Adafruit Discord, you may send an open message from any channel
|
||||
to all Community Helpers by tagging @community helpers. You may also send an
|
||||
open message from any channel, or a direct message to @kattni#1507,
|
||||
@tannewt#4653, @Dan Halbert#1614, @cater#2442, @sommersoft#0222, or
|
||||
@Andon#8175.
|
||||
|
||||
Email and direct message reports will be kept confidential.
|
||||
|
||||
In situations on Discord where the issue is particularly egregious, possibly
|
||||
illegal, requires immediate action, or violates the Discord terms of service,
|
||||
you should also report the message directly to Discord.
|
||||
|
||||
These are the steps for upholding our community’s standards of conduct.
|
||||
|
||||
1. Any member of the community may report any situation that violates the
|
||||
Adafruit Community Code of Conduct. All reports will be reviewed and
|
||||
investigated.
|
||||
2. If the behavior is an egregious violation, the community member who
|
||||
committed the violation may be banned immediately, without warning.
|
||||
3. Otherwise, moderators will first respond to such behavior with a warning.
|
||||
4. Moderators follow a soft "three strikes" policy - the community member may
|
||||
be given another chance, if they are receptive to the warning and change their
|
||||
behavior.
|
||||
5. If the community member is unreceptive or unreasonable when warned by a
|
||||
moderator, or the warning goes unheeded, they may be banned for a first or
|
||||
second offense. Repeated offenses will result in the community member being
|
||||
banned.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct and the enforcement policies listed above apply to all
|
||||
Adafruit Community venues. This includes but is not limited to any community
|
||||
spaces (both public and private), the entire Adafruit Discord server, and
|
||||
Adafruit GitHub repositories. Examples of Adafruit Community spaces include
|
||||
but are not limited to meet-ups, audio chats on the Adafruit Discord, or
|
||||
interaction at a conference.
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces
|
||||
when an individual is representing the project or its community. As a community
|
||||
member, you are representing our community, and are expected to behave
|
||||
accordingly.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||
version 1.4, available at
|
||||
<https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>,
|
||||
and the [Rust Code of Conduct](https://www.rust-lang.org/en-US/conduct.html).
|
||||
|
||||
For other projects adopting the Adafruit Community Code of
|
||||
Conduct, please contact the maintainers of those projects for enforcement.
|
||||
If you wish to use this code of conduct for your own project, consider
|
||||
explicitly mentioning your moderation policy or making a copy with your
|
||||
own moderation policy so as to avoid confusion.
|
||||
|
|
@ -1,126 +0,0 @@
|
|||
#include <Adafruit_INA237.h>
|
||||
|
||||
Adafruit_INA237 ina237 = Adafruit_INA237();
|
||||
|
||||
void setup() {
|
||||
Serial.begin(115200);
|
||||
// Wait until serial port is opened
|
||||
while (!Serial) {
|
||||
delay(10);
|
||||
}
|
||||
|
||||
Serial.println("Adafruit INA237 Test");
|
||||
|
||||
if (!ina237.begin()) {
|
||||
Serial.println("Couldn't find INA237 chip");
|
||||
while (1)
|
||||
;
|
||||
}
|
||||
Serial.println("Found INA237 chip");
|
||||
// set shunt resistance and max current
|
||||
ina237.setShunt(0.015, 10.0);
|
||||
|
||||
ina237.setAveragingCount(INA2XX_COUNT_16);
|
||||
uint16_t counts[] = {1, 4, 16, 64, 128, 256, 512, 1024};
|
||||
Serial.print("Averaging counts: ");
|
||||
Serial.println(counts[ina237.getAveragingCount()]);
|
||||
|
||||
// set the time over which to measure the current and bus voltage
|
||||
ina237.setVoltageConversionTime(INA2XX_TIME_150_us);
|
||||
Serial.print("Voltage conversion time: ");
|
||||
switch (ina237.getVoltageConversionTime()) {
|
||||
case INA2XX_TIME_50_us:
|
||||
Serial.print("50");
|
||||
break;
|
||||
case INA2XX_TIME_84_us:
|
||||
Serial.print("84");
|
||||
break;
|
||||
case INA2XX_TIME_150_us:
|
||||
Serial.print("150");
|
||||
break;
|
||||
case INA2XX_TIME_280_us:
|
||||
Serial.print("280");
|
||||
break;
|
||||
case INA2XX_TIME_540_us:
|
||||
Serial.print("540");
|
||||
break;
|
||||
case INA2XX_TIME_1052_us:
|
||||
Serial.print("1052");
|
||||
break;
|
||||
case INA2XX_TIME_2074_us:
|
||||
Serial.print("2074");
|
||||
break;
|
||||
case INA2XX_TIME_4120_us:
|
||||
Serial.print("4120");
|
||||
break;
|
||||
}
|
||||
Serial.println(" uS");
|
||||
|
||||
ina237.setCurrentConversionTime(INA2XX_TIME_280_us);
|
||||
Serial.print("Current conversion time: ");
|
||||
switch (ina237.getCurrentConversionTime()) {
|
||||
case INA2XX_TIME_50_us:
|
||||
Serial.print("50");
|
||||
break;
|
||||
case INA2XX_TIME_84_us:
|
||||
Serial.print("84");
|
||||
break;
|
||||
case INA2XX_TIME_150_us:
|
||||
Serial.print("150");
|
||||
break;
|
||||
case INA2XX_TIME_280_us:
|
||||
Serial.print("280");
|
||||
break;
|
||||
case INA2XX_TIME_540_us:
|
||||
Serial.print("540");
|
||||
break;
|
||||
case INA2XX_TIME_1052_us:
|
||||
Serial.print("1052");
|
||||
break;
|
||||
case INA2XX_TIME_2074_us:
|
||||
Serial.print("2074");
|
||||
break;
|
||||
case INA2XX_TIME_4120_us:
|
||||
Serial.print("4120");
|
||||
break;
|
||||
}
|
||||
Serial.println(" uS");
|
||||
|
||||
// default polarity for the alert is low on ready, but
|
||||
// it can be inverted!
|
||||
// ina237.setAlertPolarity(1);
|
||||
}
|
||||
|
||||
void loop() {
|
||||
|
||||
// by default the sensor does continuous reading, but
|
||||
// we can set to triggered mode. to do that, we have to set
|
||||
// the mode to trigger a new reading, then wait for a conversion
|
||||
// either by checking the ALERT pin or reading the ready register
|
||||
// ina237.setMode(INA2XX_MODE_TRIGGERED);
|
||||
// while (!ina237.conversionReady())
|
||||
// delay(1);
|
||||
|
||||
Serial.print("Current: ");
|
||||
Serial.print(ina237.getCurrent_mA());
|
||||
Serial.println(" mA");
|
||||
|
||||
Serial.print("Bus Voltage: ");
|
||||
Serial.print(ina237.getBusVoltage_V());
|
||||
Serial.println(" V");
|
||||
|
||||
Serial.print("Shunt Voltage: ");
|
||||
Serial.print(ina237.getShuntVoltage_mV() * 1000.0); // Convert from mV to μV
|
||||
Serial.println(" uV");
|
||||
|
||||
Serial.print("Power: ");
|
||||
Serial.print(ina237.getPower_mW());
|
||||
Serial.println(" mW");
|
||||
|
||||
Serial.print("Temperature: ");
|
||||
Serial.print(ina237.readDieTemp());
|
||||
Serial.println(" *C");
|
||||
|
||||
Serial.println();
|
||||
delay(1000);
|
||||
}
|
||||
|
|
@ -1,129 +0,0 @@
|
|||
#include <Adafruit_INA238.h>
|
||||
|
||||
// Note: The INA238 is functionally identical to the INA237.
|
||||
// This example demonstrates the INA238-specific class, but
|
||||
// all functionality is identical to the INA237 example.
|
||||
Adafruit_INA238 ina238 = Adafruit_INA238();
|
||||
|
||||
void setup() {
|
||||
Serial.begin(115200);
|
||||
// Wait until serial port is opened
|
||||
while (!Serial) {
|
||||
delay(10);
|
||||
}
|
||||
|
||||
Serial.println("Adafruit INA238 Test");
|
||||
|
||||
if (!ina238.begin()) {
|
||||
Serial.println("Couldn't find INA238 chip");
|
||||
while (1)
|
||||
;
|
||||
}
|
||||
Serial.println("Found INA238 chip");
|
||||
// set shunt resistance and max current
|
||||
ina238.setShunt(0.015, 10.0);
|
||||
|
||||
ina238.setAveragingCount(INA2XX_COUNT_16);
|
||||
uint16_t counts[] = {1, 4, 16, 64, 128, 256, 512, 1024};
|
||||
Serial.print("Averaging counts: ");
|
||||
Serial.println(counts[ina238.getAveragingCount()]);
|
||||
|
||||
// set the time over which to measure the current and bus voltage
|
||||
ina238.setVoltageConversionTime(INA2XX_TIME_150_us);
|
||||
Serial.print("Voltage conversion time: ");
|
||||
switch (ina238.getVoltageConversionTime()) {
|
||||
case INA2XX_TIME_50_us:
|
||||
Serial.print("50");
|
||||
break;
|
||||
case INA2XX_TIME_84_us:
|
||||
Serial.print("84");
|
||||
break;
|
||||
case INA2XX_TIME_150_us:
|
||||
Serial.print("150");
|
||||
break;
|
||||
case INA2XX_TIME_280_us:
|
||||
Serial.print("280");
|
||||
break;
|
||||
case INA2XX_TIME_540_us:
|
||||
Serial.print("540");
|
||||
break;
|
||||
case INA2XX_TIME_1052_us:
|
||||
Serial.print("1052");
|
||||
break;
|
||||
case INA2XX_TIME_2074_us:
|
||||
Serial.print("2074");
|
||||
break;
|
||||
case INA2XX_TIME_4120_us:
|
||||
Serial.print("4120");
|
||||
break;
|
||||
}
|
||||
Serial.println(" uS");
|
||||
|
||||
ina238.setCurrentConversionTime(INA2XX_TIME_280_us);
|
||||
Serial.print("Current conversion time: ");
|
||||
switch (ina238.getCurrentConversionTime()) {
|
||||
case INA2XX_TIME_50_us:
|
||||
Serial.print("50");
|
||||
break;
|
||||
case INA2XX_TIME_84_us:
|
||||
Serial.print("84");
|
||||
break;
|
||||
case INA2XX_TIME_150_us:
|
||||
Serial.print("150");
|
||||
break;
|
||||
case INA2XX_TIME_280_us:
|
||||
Serial.print("280");
|
||||
break;
|
||||
case INA2XX_TIME_540_us:
|
||||
Serial.print("540");
|
||||
break;
|
||||
case INA2XX_TIME_1052_us:
|
||||
Serial.print("1052");
|
||||
break;
|
||||
case INA2XX_TIME_2074_us:
|
||||
Serial.print("2074");
|
||||
break;
|
||||
case INA2XX_TIME_4120_us:
|
||||
Serial.print("4120");
|
||||
break;
|
||||
}
|
||||
Serial.println(" uS");
|
||||
|
||||
// default polarity for the alert is low on ready, but
|
||||
// it can be inverted!
|
||||
// ina238.setAlertPolarity(1);
|
||||
}
|
||||
|
||||
void loop() {
|
||||
|
||||
// by default the sensor does continuous reading, but
|
||||
// we can set to triggered mode. to do that, we have to set
|
||||
// the mode to trigger a new reading, then wait for a conversion
|
||||
// either by checking the ALERT pin or reading the ready register
|
||||
// ina238.setMode(INA2XX_MODE_TRIGGERED);
|
||||
// while (!ina238.conversionReady())
|
||||
// delay(1);
|
||||
|
||||
Serial.print("Current: ");
|
||||
Serial.print(ina238.getCurrent_mA());
|
||||
Serial.println(" mA");
|
||||
|
||||
Serial.print("Bus Voltage: ");
|
||||
Serial.print(ina238.getBusVoltage_V());
|
||||
Serial.println(" V");
|
||||
|
||||
Serial.print("Shunt Voltage: ");
|
||||
Serial.print(ina238.getShuntVoltage_mV() * 1000.0); // Convert from mV to μV
|
||||
Serial.println(" uV");
|
||||
|
||||
Serial.print("Power: ");
|
||||
Serial.print(ina238.getPower_mW());
|
||||
Serial.println(" mW");
|
||||
|
||||
Serial.print("Temperature: ");
|
||||
Serial.print(ina238.readDieTemp());
|
||||
Serial.println(" *C");
|
||||
|
||||
Serial.println();
|
||||
delay(1000);
|
||||
}
|
||||
95
html/_adafruit___i_n_a237_8cpp.html
Normal file
|
|
@ -0,0 +1,95 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>Adafruit INA237 and INA238 Arduino Library: Adafruit_INA237.cpp File Reference</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||
<script type="text/javascript" src="search/search.js"></script>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">Adafruit INA237 and INA238 Arduino Library
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.13 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search');
|
||||
$(document).ready(function() { init_search(); });
|
||||
});
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
</div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<iframe src="javascript:void(0)" frameborder="0"
|
||||
name="MSearchResults" id="MSearchResults">
|
||||
</iframe>
|
||||
</div>
|
||||
|
||||
</div><!-- top -->
|
||||
<div class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">Adafruit_INA237.cpp File Reference</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<div class="textblock"><code>#include "<a class="el" href="_adafruit___i_n_a237_8h_source.html">Adafruit_INA237.h</a>"</code><br />
|
||||
<code>#include <Wire.h></code><br />
|
||||
<code>#include "Arduino.h"</code><br />
|
||||
</div><a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><h1><a class="anchor" id="ina237_intro"></a>
|
||||
Introduction</h1>
|
||||
<p>I2C Driver for the INA237/INA238 I2C Current and Power sensor</p>
|
||||
<p>Note: INA237 and INA238 are functionally identical devices with different part numbers. This class implements all functionality for both chips.</p>
|
||||
<p>This is a library for the Adafruit INA237/INA238 breakouts: <a href="http://www.adafruit.com/products/xxxx">http://www.adafruit.com/products/xxxx</a></p>
|
||||
<p>Adafruit invests time and resources providing this open source code, please support Adafruit and open-source hardware by purchasing products from Adafruit!</p>
|
||||
<h1><a class="anchor" id="ina237_dependencies"></a>
|
||||
Dependencies</h1>
|
||||
<p>This library depends on the Adafruit BusIO library</p>
|
||||
<h1><a class="anchor" id="ina237_author"></a>
|
||||
Author</h1>
|
||||
<p>Limor "Ladyada" Fried for Adafruit Industries</p>
|
||||
<h1><a class="anchor" id="ina237_license"></a>
|
||||
License</h1>
|
||||
<p>MIT (see license.txt)</p>
|
||||
<h1><a class="anchor" id="ina237_history"></a>
|
||||
HISTORY</h1>
|
||||
<p>v1.0 - First release </p>
|
||||
</div></div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.13
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
186
html/_adafruit___i_n_a237_8h.html
Normal file
|
|
@ -0,0 +1,186 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>Adafruit INA237 and INA238 Arduino Library: Adafruit_INA237.h File Reference</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||
<script type="text/javascript" src="search/search.js"></script>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">Adafruit INA237 and INA238 Arduino Library
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.13 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search');
|
||||
$(document).ready(function() { init_search(); });
|
||||
});
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
</div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<iframe src="javascript:void(0)" frameborder="0"
|
||||
name="MSearchResults" id="MSearchResults">
|
||||
</iframe>
|
||||
</div>
|
||||
|
||||
</div><!-- top -->
|
||||
<div class="header">
|
||||
<div class="summary">
|
||||
<a href="#nested-classes">Classes</a> |
|
||||
<a href="#define-members">Macros</a> |
|
||||
<a href="#typedef-members">Typedefs</a> |
|
||||
<a href="#enum-members">Enumerations</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">Adafruit_INA237.h File Reference</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<div class="textblock"><code>#include <Adafruit_INA2xx.h></code><br />
|
||||
</div>
|
||||
<p><a href="_adafruit___i_n_a237_8h_source.html">Go to the source code of this file.</a></p>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
||||
Classes</h2></td></tr>
|
||||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___i_n_a237.html">Adafruit_INA237</a></td></tr>
|
||||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class that stores state and functions for interacting with INA237/INA238 Current and Power Sensors. <a href="class_adafruit___i_n_a237.html#details">More...</a><br /></td></tr>
|
||||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
|
||||
Macros</h2></td></tr>
|
||||
<tr class="memitem:a9177aab49a4aa471df9745486905a18b"><td class="memItemLeft" align="right" valign="top"><a id="a9177aab49a4aa471df9745486905a18b"></a>
|
||||
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_adafruit___i_n_a237_8h.html#a9177aab49a4aa471df9745486905a18b">INA237_I2CADDR_DEFAULT</a>   0x40</td></tr>
|
||||
<tr class="memdesc:a9177aab49a4aa471df9745486905a18b"><td class="mdescLeft"> </td><td class="mdescRight">INA237/INA238 default i2c address. <br /></td></tr>
|
||||
<tr class="separator:a9177aab49a4aa471df9745486905a18b"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ae0504710b4239c77874e0757b11a200f"><td class="memItemLeft" align="right" valign="top"><a id="ae0504710b4239c77874e0757b11a200f"></a>
|
||||
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_adafruit___i_n_a237_8h.html#ae0504710b4239c77874e0757b11a200f">INA237_DEVICE_ID</a>   0x238</td></tr>
|
||||
<tr class="memdesc:ae0504710b4239c77874e0757b11a200f"><td class="mdescLeft"> </td><td class="mdescRight">INA237 device ID. <br /></td></tr>
|
||||
<tr class="separator:ae0504710b4239c77874e0757b11a200f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ac12c78da9272fb94981fa6ec77f5f22a"><td class="memItemLeft" align="right" valign="top"><a id="ac12c78da9272fb94981fa6ec77f5f22a"></a>
|
||||
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_adafruit___i_n_a237_8h.html#ac12c78da9272fb94981fa6ec77f5f22a">INA238_DEVICE_ID</a>   0x238</td></tr>
|
||||
<tr class="memdesc:ac12c78da9272fb94981fa6ec77f5f22a"><td class="mdescLeft"> </td><td class="mdescRight">INA238 device ID (identical to INA237) <br /></td></tr>
|
||||
<tr class="separator:ac12c78da9272fb94981fa6ec77f5f22a"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
|
||||
Typedefs</h2></td></tr>
|
||||
<tr class="memitem:a1c988ddedc2786e59aca503b313b0724"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6">_ina237_alert_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="_adafruit___i_n_a237_8h.html#a1c988ddedc2786e59aca503b313b0724">INA237_AlertType</a></td></tr>
|
||||
<tr class="memdesc:a1c988ddedc2786e59aca503b313b0724"><td class="mdescLeft"> </td><td class="mdescRight">Alert trigger options specific to INA237/INA238. <a href="#a1c988ddedc2786e59aca503b313b0724">More...</a><br /></td></tr>
|
||||
<tr class="separator:a1c988ddedc2786e59aca503b313b0724"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
|
||||
Enumerations</h2></td></tr>
|
||||
<tr class="memitem:aa7613d25bd97136a2b9be3859c22d1c6"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6">_ina237_alert_type</a> { <br />
|
||||
  <a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6a12357c3d7f9932f9feede12f9038858d">INA237_ALERT_CONVERSION_READY</a> = 0x1,
|
||||
<a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6a083d640626067b99cea2ae239b8056d7">INA237_ALERT_OVERTEMPERATURE</a> = 0x2,
|
||||
<a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6aa9d3979bf691b9b09e07a298c71a7434">INA237_ALERT_OVERPOWER</a> = 0x4,
|
||||
<a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6ab4f7d16e99928e74e199f22ff40fba0c">INA237_ALERT_UNDERVOLTAGE</a> = 0x8,
|
||||
<br />
|
||||
  <a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6acca068883a24e45cc0229ce3d88863f0">INA237_ALERT_OVERVOLTAGE</a> = 0x10,
|
||||
<a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6a442a01c1321b6e2f7948667fa8c3d141">INA237_ALERT_UNDERSHUNT</a> = 0x20,
|
||||
<a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6a611c3fd1209b94a4cc500077ec132250">INA237_ALERT_OVERSHUNT</a> = 0x40,
|
||||
<a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6a6c5adeed8029f07c9b5eee29dd4ef591">INA237_ALERT_NONE</a> = 0x0
|
||||
<br />
|
||||
}<tr class="memdesc:aa7613d25bd97136a2b9be3859c22d1c6"><td class="mdescLeft"> </td><td class="mdescRight">Alert trigger options specific to INA237/INA238. <a href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6">More...</a><br /></td></tr>
|
||||
</td></tr>
|
||||
<tr class="separator:aa7613d25bd97136a2b9be3859c22d1c6"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>I2C Driver for INA237/INA238 Current and Power sensors</p>
|
||||
<p>Note: INA237 and INA238 are functionally identical devices with different part numbers. This class implements all functionality for both chips.</p>
|
||||
<p>This is a library for the Adafruit INA237/INA238 breakouts: <a href="http://www.adafruit.com/products/xxxx">http://www.adafruit.com/products/xxxx</a></p>
|
||||
<p>Adafruit invests time and resources providing this open source code, please support Adafruit and open-source hardware by purchasing products from Adafruit!</p>
|
||||
<p>MIT license (see license.txt) </p>
|
||||
</div><h2 class="groupheader">Typedef Documentation</h2>
|
||||
<a id="a1c988ddedc2786e59aca503b313b0724"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a1c988ddedc2786e59aca503b313b0724">◆ </a></span>INA237_AlertType</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">typedef enum <a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6">_ina237_alert_type</a> <a class="el" href="_adafruit___i_n_a237_8h.html#a1c988ddedc2786e59aca503b313b0724">INA237_AlertType</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Alert trigger options specific to INA237/INA238. </p>
|
||||
<p>Allowed values for setAlertType. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
||||
<a id="aa7613d25bd97136a2b9be3859c22d1c6"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#aa7613d25bd97136a2b9be3859c22d1c6">◆ </a></span>_ina237_alert_type</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">enum <a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6">_ina237_alert_type</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Alert trigger options specific to INA237/INA238. </p>
|
||||
<p>Allowed values for setAlertType. </p>
|
||||
<table class="fieldtable">
|
||||
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aa7613d25bd97136a2b9be3859c22d1c6a12357c3d7f9932f9feede12f9038858d"></a>INA237_ALERT_CONVERSION_READY </td><td class="fielddoc"><p>Trigger on conversion ready. </p>
|
||||
</td></tr>
|
||||
<tr><td class="fieldname"><a id="aa7613d25bd97136a2b9be3859c22d1c6a083d640626067b99cea2ae239b8056d7"></a>INA237_ALERT_OVERTEMPERATURE </td><td class="fielddoc"><p>Trigger on overtemperature. </p>
|
||||
</td></tr>
|
||||
<tr><td class="fieldname"><a id="aa7613d25bd97136a2b9be3859c22d1c6aa9d3979bf691b9b09e07a298c71a7434"></a>INA237_ALERT_OVERPOWER </td><td class="fielddoc"><p>Trigger on power over limit. </p>
|
||||
</td></tr>
|
||||
<tr><td class="fieldname"><a id="aa7613d25bd97136a2b9be3859c22d1c6ab4f7d16e99928e74e199f22ff40fba0c"></a>INA237_ALERT_UNDERVOLTAGE </td><td class="fielddoc"><p>Trigger on bus voltage under limit. </p>
|
||||
</td></tr>
|
||||
<tr><td class="fieldname"><a id="aa7613d25bd97136a2b9be3859c22d1c6acca068883a24e45cc0229ce3d88863f0"></a>INA237_ALERT_OVERVOLTAGE </td><td class="fielddoc"><p>Trigger on bus voltage over limit. </p>
|
||||
</td></tr>
|
||||
<tr><td class="fieldname"><a id="aa7613d25bd97136a2b9be3859c22d1c6a442a01c1321b6e2f7948667fa8c3d141"></a>INA237_ALERT_UNDERSHUNT </td><td class="fielddoc"><p>Trigger on shunt voltage under limit. </p>
|
||||
</td></tr>
|
||||
<tr><td class="fieldname"><a id="aa7613d25bd97136a2b9be3859c22d1c6a611c3fd1209b94a4cc500077ec132250"></a>INA237_ALERT_OVERSHUNT </td><td class="fielddoc"><p>Trigger on shunt voltage over limit. </p>
|
||||
</td></tr>
|
||||
<tr><td class="fieldname"><a id="aa7613d25bd97136a2b9be3859c22d1c6a6c5adeed8029f07c9b5eee29dd4ef591"></a>INA237_ALERT_NONE </td><td class="fielddoc"><p>Do not trigger alert pin (Default) </p>
|
||||
</td></tr>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.13
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
96
html/_adafruit___i_n_a237_8h_source.html
Normal file
92
html/_adafruit___i_n_a238_8cpp.html
Normal file
|
|
@ -0,0 +1,92 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>Adafruit INA237 and INA238 Arduino Library: Adafruit_INA238.cpp File Reference</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||
<script type="text/javascript" src="search/search.js"></script>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">Adafruit INA237 and INA238 Arduino Library
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.13 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search');
|
||||
$(document).ready(function() { init_search(); });
|
||||
});
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
</div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<iframe src="javascript:void(0)" frameborder="0"
|
||||
name="MSearchResults" id="MSearchResults">
|
||||
</iframe>
|
||||
</div>
|
||||
|
||||
</div><!-- top -->
|
||||
<div class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">Adafruit_INA238.cpp File Reference</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<div class="textblock"><code>#include "<a class="el" href="_adafruit___i_n_a238_8h_source.html">Adafruit_INA238.h</a>"</code><br />
|
||||
</div><a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><h1><a class="anchor" id="ina238_intro"></a>
|
||||
Introduction</h1>
|
||||
<p>I2C Driver for the INA238 I2C Current and Power sensor</p>
|
||||
<p>This is a library for the Adafruit INA238 breakout: <a href="http://www.adafruit.com/products/xxxx">http://www.adafruit.com/products/xxxx</a></p>
|
||||
<p>Adafruit invests time and resources providing this open source code, please support Adafruit and open-source hardware by purchasing products from Adafruit!</p>
|
||||
<h1><a class="anchor" id="ina238_dependencies"></a>
|
||||
Dependencies</h1>
|
||||
<p>This library depends on the Adafruit BusIO library</p>
|
||||
<h1><a class="anchor" id="ina238_author"></a>
|
||||
Author</h1>
|
||||
<p>Limor "Ladyada" Fried for Adafruit Industries</p>
|
||||
<h1><a class="anchor" id="ina238_license"></a>
|
||||
License</h1>
|
||||
<p>MIT (see license.txt)</p>
|
||||
<h1><a class="anchor" id="ina238_history"></a>
|
||||
HISTORY</h1>
|
||||
<p>v1.0 - First release </p>
|
||||
</div></div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.13
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
102
html/_adafruit___i_n_a238_8h.html
Normal file
|
|
@ -0,0 +1,102 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>Adafruit INA237 and INA238 Arduino Library: Adafruit_INA238.h File Reference</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||
<script type="text/javascript" src="search/search.js"></script>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">Adafruit INA237 and INA238 Arduino Library
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.13 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search');
|
||||
$(document).ready(function() { init_search(); });
|
||||
});
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
</div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<iframe src="javascript:void(0)" frameborder="0"
|
||||
name="MSearchResults" id="MSearchResults">
|
||||
</iframe>
|
||||
</div>
|
||||
|
||||
</div><!-- top -->
|
||||
<div class="header">
|
||||
<div class="summary">
|
||||
<a href="#nested-classes">Classes</a> |
|
||||
<a href="#define-members">Macros</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">Adafruit_INA238.h File Reference</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<div class="textblock"><code>#include "<a class="el" href="_adafruit___i_n_a237_8h_source.html">Adafruit_INA237.h</a>"</code><br />
|
||||
</div>
|
||||
<p><a href="_adafruit___i_n_a238_8h_source.html">Go to the source code of this file.</a></p>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
||||
Classes</h2></td></tr>
|
||||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___i_n_a238.html">Adafruit_INA238</a></td></tr>
|
||||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class that stores state and functions for interacting with INA238 Current and Power Sensor (identical to INA237) <a href="class_adafruit___i_n_a238.html#details">More...</a><br /></td></tr>
|
||||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
|
||||
Macros</h2></td></tr>
|
||||
<tr class="memitem:aff39b25047564f1595d512422c428a60"><td class="memItemLeft" align="right" valign="top"><a id="aff39b25047564f1595d512422c428a60"></a>
|
||||
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_adafruit___i_n_a238_8h.html#aff39b25047564f1595d512422c428a60">INA238_I2CADDR_DEFAULT</a>   0x40</td></tr>
|
||||
<tr class="memdesc:aff39b25047564f1595d512422c428a60"><td class="mdescLeft"> </td><td class="mdescRight">INA238 default i2c address. <br /></td></tr>
|
||||
<tr class="separator:aff39b25047564f1595d512422c428a60"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ac12c78da9272fb94981fa6ec77f5f22a"><td class="memItemLeft" align="right" valign="top"><a id="ac12c78da9272fb94981fa6ec77f5f22a"></a>
|
||||
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_adafruit___i_n_a238_8h.html#ac12c78da9272fb94981fa6ec77f5f22a">INA238_DEVICE_ID</a>   0x238</td></tr>
|
||||
<tr class="memdesc:ac12c78da9272fb94981fa6ec77f5f22a"><td class="mdescLeft"> </td><td class="mdescRight">INA238 device ID. <br /></td></tr>
|
||||
<tr class="separator:ac12c78da9272fb94981fa6ec77f5f22a"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>I2C Driver for INA238 Current and Power sensor</p>
|
||||
<p>This is a library for the Adafruit INA238 breakout: <a href="http://www.adafruit.com/products/xxxx">http://www.adafruit.com/products/xxxx</a></p>
|
||||
<p>Adafruit invests time and resources providing this open source code, please support Adafruit and open-source hardware by purchasing products from Adafruit!</p>
|
||||
<p>MIT license (see license.txt) </p>
|
||||
</div></div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.13
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
79
html/_adafruit___i_n_a238_8h_source.html
Normal file
|
|
@ -0,0 +1,79 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>Adafruit INA237 and INA238 Arduino Library: Adafruit_INA238.h Source File</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||
<script type="text/javascript" src="search/search.js"></script>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">Adafruit INA237 and INA238 Arduino Library
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.13 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search');
|
||||
$(document).ready(function() { init_search(); });
|
||||
});
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
</div><!-- top -->
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
</div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<iframe src="javascript:void(0)" frameborder="0"
|
||||
name="MSearchResults" id="MSearchResults">
|
||||
</iframe>
|
||||
</div>
|
||||
|
||||
<div class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">Adafruit_INA238.h</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<a href="_adafruit___i_n_a238_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef _ADAFRUIT_INA238_H</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define _ADAFRUIT_INA238_H</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "<a class="code" href="_adafruit___i_n_a237_8h.html">Adafruit_INA237.h</a>"</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="_adafruit___i_n_a238_8h.html#aff39b25047564f1595d512422c428a60"> 22</a></span> <span class="preprocessor">#define INA238_I2CADDR_DEFAULT 0x40 </span></div><div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="_adafruit___i_n_a238_8h.html#ac12c78da9272fb94981fa6ec77f5f22a"> 23</a></span> <span class="preprocessor">#define INA238_DEVICE_ID 0x238 </span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="class_adafruit___i_n_a238.html"> 29</a></span> <span class="keyword">class </span><a class="code" href="class_adafruit___i_n_a238.html">Adafruit_INA238</a> : <span class="keyword">public</span> <a class="code" href="class_adafruit___i_n_a237.html">Adafruit_INA237</a> {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <a class="code" href="class_adafruit___i_n_a238.html#a94012bdb08cb6868eb01496c4824e3c0">Adafruit_INA238</a>();</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordtype">bool</span> <a class="code" href="class_adafruit___i_n_a238.html#a419f14f55eb3aff12f7f9e63f5eaf9a1">begin</a>(uint8_t i2c_addr = <a class="code" href="_adafruit___i_n_a238_8h.html#aff39b25047564f1595d512422c428a60">INA238_I2CADDR_DEFAULT</a>,</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  TwoWire* theWire = &Wire, <span class="keywordtype">bool</span> skipReset = <span class="keyword">false</span>);</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> };</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="class_adafruit___i_n_a238_html_a94012bdb08cb6868eb01496c4824e3c0"><div class="ttname"><a href="class_adafruit___i_n_a238.html#a94012bdb08cb6868eb01496c4824e3c0">Adafruit_INA238::Adafruit_INA238</a></div><div class="ttdeci">Adafruit_INA238()</div><div class="ttdoc">Instantiates a new INA238 class. </div><div class="ttdef"><b>Definition:</b> Adafruit_INA238.cpp:37</div></div>
|
||||
<div class="ttc" id="class_adafruit___i_n_a238_html"><div class="ttname"><a href="class_adafruit___i_n_a238.html">Adafruit_INA238</a></div><div class="ttdoc">Class that stores state and functions for interacting with INA238 Current and Power Sensor (identical...</div><div class="ttdef"><b>Definition:</b> Adafruit_INA238.h:29</div></div>
|
||||
<div class="ttc" id="_adafruit___i_n_a237_8h_html"><div class="ttname"><a href="_adafruit___i_n_a237_8h.html">Adafruit_INA237.h</a></div></div>
|
||||
<div class="ttc" id="class_adafruit___i_n_a238_html_a419f14f55eb3aff12f7f9e63f5eaf9a1"><div class="ttname"><a href="class_adafruit___i_n_a238.html#a419f14f55eb3aff12f7f9e63f5eaf9a1">Adafruit_INA238::begin</a></div><div class="ttdeci">bool begin(uint8_t i2c_addr=INA238_I2CADDR_DEFAULT, TwoWire *theWire=&Wire, bool skipReset=false)</div><div class="ttdoc">Sets up the HW. </div><div class="ttdef"><b>Definition:</b> Adafruit_INA238.cpp:50</div></div>
|
||||
<div class="ttc" id="_adafruit___i_n_a238_8h_html_aff39b25047564f1595d512422c428a60"><div class="ttname"><a href="_adafruit___i_n_a238_8h.html#aff39b25047564f1595d512422c428a60">INA238_I2CADDR_DEFAULT</a></div><div class="ttdeci">#define INA238_I2CADDR_DEFAULT</div><div class="ttdoc">INA238 default i2c address. </div><div class="ttdef"><b>Definition:</b> Adafruit_INA238.h:22</div></div>
|
||||
<div class="ttc" id="class_adafruit___i_n_a237_html"><div class="ttname"><a href="class_adafruit___i_n_a237.html">Adafruit_INA237</a></div><div class="ttdoc">Class that stores state and functions for interacting with INA237/INA238 Current and Power Sensors...</div><div class="ttdef"><b>Definition:</b> Adafruit_INA237.h:49</div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.13
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
79
html/annotated.html
Normal file
|
|
@ -0,0 +1,79 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>Adafruit INA237 and INA238 Arduino Library: Class List</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||
<script type="text/javascript" src="search/search.js"></script>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">Adafruit INA237 and INA238 Arduino Library
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.13 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search');
|
||||
$(document).ready(function() { init_search(); });
|
||||
});
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
</div><!-- top -->
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
</div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<iframe src="javascript:void(0)" frameborder="0"
|
||||
name="MSearchResults" id="MSearchResults">
|
||||
</iframe>
|
||||
</div>
|
||||
|
||||
<div class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">Class List</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
|
||||
<table class="directory">
|
||||
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_adafruit___i_n_a237.html" target="_self">Adafruit_INA237</a></td><td class="desc">Class that stores state and functions for interacting with INA237/INA238 Current and Power Sensors </td></tr>
|
||||
<tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_adafruit___i_n_a238.html" target="_self">Adafruit_INA238</a></td><td class="desc">Class that stores state and functions for interacting with INA238 Current and Power Sensor (identical to INA237) </td></tr>
|
||||
</table>
|
||||
</div><!-- directory -->
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.13
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
BIN
html/bc_s.png
Normal file
|
After Width: | Height: | Size: 676 B |
BIN
html/bdwn.png
Normal file
|
After Width: | Height: | Size: 147 B |
87
html/class_adafruit___i_n_a237-members.html
Normal file
|
|
@ -0,0 +1,87 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>Adafruit INA237 and INA238 Arduino Library: Member List</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||
<script type="text/javascript" src="search/search.js"></script>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">Adafruit INA237 and INA238 Arduino Library
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.13 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search');
|
||||
$(document).ready(function() { init_search(); });
|
||||
});
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
</div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<iframe src="javascript:void(0)" frameborder="0"
|
||||
name="MSearchResults" id="MSearchResults">
|
||||
</iframe>
|
||||
</div>
|
||||
|
||||
</div><!-- top -->
|
||||
<div class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">Adafruit_INA237 Member List</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>This is the complete list of members for <a class="el" href="class_adafruit___i_n_a237.html">Adafruit_INA237</a>, including all inherited members.</p>
|
||||
<table class="directory">
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html#af4e10e12e0d94a5c725aa26aa984dd09">_updateShuntCalRegister</a>(void) override</td><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html">Adafruit_INA237</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html#a00a593696b8d55749537bc6af8b69c48">Adafruit_INA237</a>()</td><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html">Adafruit_INA237</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html#a5b57c715d573272a487186edd4469e71">begin</a>(uint8_t i2c_addr=INA237_I2CADDR_DEFAULT, TwoWire *theWire=&Wire, bool skipReset=false)</td><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html">Adafruit_INA237</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html#a838055b7f33554847d78d6bcc1d8f96f">getAlertType</a>(void)</td><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html">Adafruit_INA237</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html#a64e9ad6f47c561fe08352f7ed4b924b1">readBusVoltage</a>(void) override</td><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html">Adafruit_INA237</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html#abc259e72a96b712f12058a500e53b064">readCurrent</a>(void) override</td><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html">Adafruit_INA237</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html#ab1e34a67d118bca72df89749bad07ee4">readDieTemp</a>(void) override</td><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html">Adafruit_INA237</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html#a78c43dfbbd2257050ea35fcdb7ebfabb">readPower</a>(void) override</td><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html">Adafruit_INA237</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html#a7a6e4eb322f25f8d390e4f4a7af62bca">readShuntVoltage</a>(void) override</td><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html">Adafruit_INA237</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html#a11d973a1c34188e0651566ea0bf15018">setAlertType</a>(INA237_AlertType alert)</td><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html">Adafruit_INA237</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html#a6c17e64857065843706a46ccc80797a8">setShunt</a>(float shunt_res=0.1, float max_current=3.2) override</td><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html">Adafruit_INA237</a></td><td class="entry"></td></tr>
|
||||
</table></div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.13
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
422
html/class_adafruit___i_n_a237.html
Normal file
|
|
@ -0,0 +1,422 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>Adafruit INA237 and INA238 Arduino Library: Adafruit_INA237 Class Reference</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||
<script type="text/javascript" src="search/search.js"></script>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">Adafruit INA237 and INA238 Arduino Library
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.13 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search');
|
||||
$(document).ready(function() { init_search(); });
|
||||
});
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
</div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<iframe src="javascript:void(0)" frameborder="0"
|
||||
name="MSearchResults" id="MSearchResults">
|
||||
</iframe>
|
||||
</div>
|
||||
|
||||
</div><!-- top -->
|
||||
<div class="header">
|
||||
<div class="summary">
|
||||
<a href="#pub-methods">Public Member Functions</a> |
|
||||
<a href="#pro-methods">Protected Member Functions</a> |
|
||||
<a href="class_adafruit___i_n_a237-members.html">List of all members</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">Adafruit_INA237 Class Reference</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Class that stores state and functions for interacting with INA237/INA238 Current and Power Sensors.
|
||||
<a href="class_adafruit___i_n_a237.html#details">More...</a></p>
|
||||
|
||||
<p><code>#include <<a class="el" href="_adafruit___i_n_a237_8h_source.html">Adafruit_INA237.h</a>></code></p>
|
||||
<div class="dynheader">
|
||||
Inheritance diagram for Adafruit_INA237:</div>
|
||||
<div class="dyncontent">
|
||||
<div class="center">
|
||||
<img src="class_adafruit___i_n_a237.png" usemap="#Adafruit_5FINA237_map" alt=""/>
|
||||
<map id="Adafruit_5FINA237_map" name="Adafruit_5FINA237_map">
|
||||
<area href="class_adafruit___i_n_a238.html" title="Class that stores state and functions for interacting with INA238 Current and Power Sensor (identical..." alt="Adafruit_INA238" shape="rect" coords="0,112,106,136"/>
|
||||
</map>
|
||||
</div></div>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||||
Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:a00a593696b8d55749537bc6af8b69c48"><td class="memItemLeft" align="right" valign="top"><a id="a00a593696b8d55749537bc6af8b69c48"></a>
|
||||
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___i_n_a237.html#a00a593696b8d55749537bc6af8b69c48">Adafruit_INA237</a> ()</td></tr>
|
||||
<tr class="memdesc:a00a593696b8d55749537bc6af8b69c48"><td class="mdescLeft"> </td><td class="mdescRight">Instantiates a new INA237 class. <br /></td></tr>
|
||||
<tr class="separator:a00a593696b8d55749537bc6af8b69c48"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a5b57c715d573272a487186edd4469e71"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___i_n_a237.html#a5b57c715d573272a487186edd4469e71">begin</a> (uint8_t i2c_addr=<a class="el" href="_adafruit___i_n_a237_8h.html#a9177aab49a4aa471df9745486905a18b">INA237_I2CADDR_DEFAULT</a>, TwoWire *theWire=&Wire, bool skipReset=false)</td></tr>
|
||||
<tr class="memdesc:a5b57c715d573272a487186edd4469e71"><td class="mdescLeft"> </td><td class="mdescRight">Sets up the HW. <a href="#a5b57c715d573272a487186edd4469e71">More...</a><br /></td></tr>
|
||||
<tr class="separator:a5b57c715d573272a487186edd4469e71"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a838055b7f33554847d78d6bcc1d8f96f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_adafruit___i_n_a237_8h.html#a1c988ddedc2786e59aca503b313b0724">INA237_AlertType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___i_n_a237.html#a838055b7f33554847d78d6bcc1d8f96f">getAlertType</a> (void)</td></tr>
|
||||
<tr class="memdesc:a838055b7f33554847d78d6bcc1d8f96f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current alert type. <a href="#a838055b7f33554847d78d6bcc1d8f96f">More...</a><br /></td></tr>
|
||||
<tr class="separator:a838055b7f33554847d78d6bcc1d8f96f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a11d973a1c34188e0651566ea0bf15018"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___i_n_a237.html#a11d973a1c34188e0651566ea0bf15018">setAlertType</a> (<a class="el" href="_adafruit___i_n_a237_8h.html#a1c988ddedc2786e59aca503b313b0724">INA237_AlertType</a> alert)</td></tr>
|
||||
<tr class="memdesc:a11d973a1c34188e0651566ea0bf15018"><td class="mdescLeft"> </td><td class="mdescRight">Sets a new alert type. <a href="#a11d973a1c34188e0651566ea0bf15018">More...</a><br /></td></tr>
|
||||
<tr class="separator:a11d973a1c34188e0651566ea0bf15018"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ab1e34a67d118bca72df89749bad07ee4"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___i_n_a237.html#ab1e34a67d118bca72df89749bad07ee4">readDieTemp</a> (void) override</td></tr>
|
||||
<tr class="memdesc:ab1e34a67d118bca72df89749bad07ee4"><td class="mdescLeft"> </td><td class="mdescRight">Reads the die temperature with the INA237-specific conversion factor. <a href="#ab1e34a67d118bca72df89749bad07ee4">More...</a><br /></td></tr>
|
||||
<tr class="separator:ab1e34a67d118bca72df89749bad07ee4"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a64e9ad6f47c561fe08352f7ed4b924b1"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___i_n_a237.html#a64e9ad6f47c561fe08352f7ed4b924b1">readBusVoltage</a> (void) override</td></tr>
|
||||
<tr class="memdesc:a64e9ad6f47c561fe08352f7ed4b924b1"><td class="mdescLeft"> </td><td class="mdescRight">Reads and scales the current value of the Bus Voltage register using INA237-specific conversion factor. <a href="#a64e9ad6f47c561fe08352f7ed4b924b1">More...</a><br /></td></tr>
|
||||
<tr class="separator:a64e9ad6f47c561fe08352f7ed4b924b1"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a7a6e4eb322f25f8d390e4f4a7af62bca"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___i_n_a237.html#a7a6e4eb322f25f8d390e4f4a7af62bca">readShuntVoltage</a> (void) override</td></tr>
|
||||
<tr class="memdesc:a7a6e4eb322f25f8d390e4f4a7af62bca"><td class="mdescLeft"> </td><td class="mdescRight">Reads and scales the current value of the Shunt Voltage register using INA237-specific conversion factor. <a href="#a7a6e4eb322f25f8d390e4f4a7af62bca">More...</a><br /></td></tr>
|
||||
<tr class="separator:a7a6e4eb322f25f8d390e4f4a7af62bca"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:abc259e72a96b712f12058a500e53b064"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___i_n_a237.html#abc259e72a96b712f12058a500e53b064">readCurrent</a> (void) override</td></tr>
|
||||
<tr class="memdesc:abc259e72a96b712f12058a500e53b064"><td class="mdescLeft"> </td><td class="mdescRight">Reads and scales the current value of the Current register using INA237-specific handling. <a href="#abc259e72a96b712f12058a500e53b064">More...</a><br /></td></tr>
|
||||
<tr class="separator:abc259e72a96b712f12058a500e53b064"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a78c43dfbbd2257050ea35fcdb7ebfabb"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___i_n_a237.html#a78c43dfbbd2257050ea35fcdb7ebfabb">readPower</a> (void) override</td></tr>
|
||||
<tr class="memdesc:a78c43dfbbd2257050ea35fcdb7ebfabb"><td class="mdescLeft"> </td><td class="mdescRight">Reads and scales the current value of the Power register using INA237-specific handling. <a href="#a78c43dfbbd2257050ea35fcdb7ebfabb">More...</a><br /></td></tr>
|
||||
<tr class="separator:a78c43dfbbd2257050ea35fcdb7ebfabb"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a6c17e64857065843706a46ccc80797a8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___i_n_a237.html#a6c17e64857065843706a46ccc80797a8">setShunt</a> (float shunt_res=0.1, float max_current=3.2) override</td></tr>
|
||||
<tr class="memdesc:a6c17e64857065843706a46ccc80797a8"><td class="mdescLeft"> </td><td class="mdescRight">Sets the shunt calibration by resistor for INA237. <a href="#a6c17e64857065843706a46ccc80797a8">More...</a><br /></td></tr>
|
||||
<tr class="separator:a6c17e64857065843706a46ccc80797a8"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
||||
Protected Member Functions</h2></td></tr>
|
||||
<tr class="memitem:af4e10e12e0d94a5c725aa26aa984dd09"><td class="memItemLeft" align="right" valign="top"><a id="af4e10e12e0d94a5c725aa26aa984dd09"></a>
|
||||
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___i_n_a237.html#af4e10e12e0d94a5c725aa26aa984dd09">_updateShuntCalRegister</a> (void) override</td></tr>
|
||||
<tr class="memdesc:af4e10e12e0d94a5c725aa26aa984dd09"><td class="mdescLeft"> </td><td class="mdescRight">Updates the shunt calibration value to the INA237 register. The INA237 uses a different calculation than the INA228. <br /></td></tr>
|
||||
<tr class="separator:af4e10e12e0d94a5c725aa26aa984dd09"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>Class that stores state and functions for interacting with INA237/INA238 Current and Power Sensors. </p>
|
||||
</div><h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a id="a5b57c715d573272a487186edd4469e71"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a5b57c715d573272a487186edd4469e71">◆ </a></span>begin()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">bool Adafruit_INA237::begin </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint8_t </td>
|
||||
<td class="paramname"><em>i2c_address</em> = <code><a class="el" href="_adafruit___i_n_a237_8h.html#a9177aab49a4aa471df9745486905a18b">INA237_I2CADDR_DEFAULT</a></code>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">TwoWire * </td>
|
||||
<td class="paramname"><em>theWire</em> = <code>&Wire</code>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">bool </td>
|
||||
<td class="paramname"><em>skipReset</em> = <code>false</code> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Sets up the HW. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">i2c_address</td><td>The I2C address to be used. </td></tr>
|
||||
<tr><td class="paramname">theWire</td><td>The Wire object to be used for I2C connections. </td></tr>
|
||||
<tr><td class="paramname">skipReset</td><td>When set to true, will omit resetting all INA237 registers to their default values. Default: false. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd>True if initialization was successful, otherwise false. </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a838055b7f33554847d78d6bcc1d8f96f"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a838055b7f33554847d78d6bcc1d8f96f">◆ </a></span>getAlertType()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname"><a class="el" href="_adafruit___i_n_a237_8h.html#a1c988ddedc2786e59aca503b313b0724">INA237_AlertType</a> Adafruit_INA237::getAlertType </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void </td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Returns the current alert type. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>The current alert type </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a11d973a1c34188e0651566ea0bf15018"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a11d973a1c34188e0651566ea0bf15018">◆ </a></span>setAlertType()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void Adafruit_INA237::setAlertType </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="_adafruit___i_n_a237_8h.html#a1c988ddedc2786e59aca503b313b0724">INA237_AlertType</a> </td>
|
||||
<td class="paramname"><em>alert</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Sets a new alert type. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">alert</td><td>The new alert type to be set </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ab1e34a67d118bca72df89749bad07ee4"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ab1e34a67d118bca72df89749bad07ee4">◆ </a></span>readDieTemp()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">float Adafruit_INA237::readDieTemp </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void </td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">override</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Reads the die temperature with the INA237-specific conversion factor. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>The current die temp in deg C </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a64e9ad6f47c561fe08352f7ed4b924b1"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a64e9ad6f47c561fe08352f7ed4b924b1">◆ </a></span>readBusVoltage()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">float Adafruit_INA237::readBusVoltage </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void </td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">override</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Reads and scales the current value of the Bus Voltage register using INA237-specific conversion factor. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>The current bus voltage measurement in V </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a7a6e4eb322f25f8d390e4f4a7af62bca"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a7a6e4eb322f25f8d390e4f4a7af62bca">◆ </a></span>readShuntVoltage()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">float Adafruit_INA237::readShuntVoltage </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void </td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">override</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Reads and scales the current value of the Shunt Voltage register using INA237-specific conversion factor. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>The current shunt voltage measurement in V </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="abc259e72a96b712f12058a500e53b064"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#abc259e72a96b712f12058a500e53b064">◆ </a></span>readCurrent()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">float Adafruit_INA237::readCurrent </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void </td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">override</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Reads and scales the current value of the Current register using INA237-specific handling. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>The current measurement in mA </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a78c43dfbbd2257050ea35fcdb7ebfabb"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a78c43dfbbd2257050ea35fcdb7ebfabb">◆ </a></span>readPower()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">float Adafruit_INA237::readPower </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void </td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">override</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Reads and scales the current value of the Power register using INA237-specific handling. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>The current Power calculation in mW </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a6c17e64857065843706a46ccc80797a8"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a6c17e64857065843706a46ccc80797a8">◆ </a></span>setShunt()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void Adafruit_INA237::setShunt </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">float </td>
|
||||
<td class="paramname"><em>shunt_res</em> = <code>0.1</code>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">float </td>
|
||||
<td class="paramname"><em>max_current</em> = <code>3.2</code> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">override</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Sets the shunt calibration by resistor for INA237. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">shunt_res</td><td>Resistance of the shunt in ohms (floating point) </td></tr>
|
||||
<tr><td class="paramname">max_current</td><td>Maximum expected current in A (floating point) </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<hr/>The documentation for this class was generated from the following files:<ul>
|
||||
<li><a class="el" href="_adafruit___i_n_a237_8h_source.html">Adafruit_INA237.h</a></li>
|
||||
<li><a class="el" href="_adafruit___i_n_a237_8cpp.html">Adafruit_INA237.cpp</a></li>
|
||||
</ul>
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.13
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
BIN
html/class_adafruit___i_n_a237.png
Normal file
|
After Width: | Height: | Size: 817 B |
88
html/class_adafruit___i_n_a238-members.html
Normal file
|
|
@ -0,0 +1,88 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>Adafruit INA237 and INA238 Arduino Library: Member List</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||
<script type="text/javascript" src="search/search.js"></script>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">Adafruit INA237 and INA238 Arduino Library
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.13 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search');
|
||||
$(document).ready(function() { init_search(); });
|
||||
});
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
</div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<iframe src="javascript:void(0)" frameborder="0"
|
||||
name="MSearchResults" id="MSearchResults">
|
||||
</iframe>
|
||||
</div>
|
||||
|
||||
</div><!-- top -->
|
||||
<div class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">Adafruit_INA238 Member List</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>This is the complete list of members for <a class="el" href="class_adafruit___i_n_a238.html">Adafruit_INA238</a>, including all inherited members.</p>
|
||||
<table class="directory">
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html#af4e10e12e0d94a5c725aa26aa984dd09">_updateShuntCalRegister</a>(void) override</td><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html">Adafruit_INA237</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html#a00a593696b8d55749537bc6af8b69c48">Adafruit_INA237</a>()</td><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html">Adafruit_INA237</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_adafruit___i_n_a238.html#a94012bdb08cb6868eb01496c4824e3c0">Adafruit_INA238</a>()</td><td class="entry"><a class="el" href="class_adafruit___i_n_a238.html">Adafruit_INA238</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_adafruit___i_n_a238.html#a419f14f55eb3aff12f7f9e63f5eaf9a1">begin</a>(uint8_t i2c_addr=INA238_I2CADDR_DEFAULT, TwoWire *theWire=&Wire, bool skipReset=false)</td><td class="entry"><a class="el" href="class_adafruit___i_n_a238.html">Adafruit_INA238</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html#a838055b7f33554847d78d6bcc1d8f96f">getAlertType</a>(void)</td><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html">Adafruit_INA237</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html#a64e9ad6f47c561fe08352f7ed4b924b1">readBusVoltage</a>(void) override</td><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html">Adafruit_INA237</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html#abc259e72a96b712f12058a500e53b064">readCurrent</a>(void) override</td><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html">Adafruit_INA237</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html#ab1e34a67d118bca72df89749bad07ee4">readDieTemp</a>(void) override</td><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html">Adafruit_INA237</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html#a78c43dfbbd2257050ea35fcdb7ebfabb">readPower</a>(void) override</td><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html">Adafruit_INA237</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html#a7a6e4eb322f25f8d390e4f4a7af62bca">readShuntVoltage</a>(void) override</td><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html">Adafruit_INA237</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html#a11d973a1c34188e0651566ea0bf15018">setAlertType</a>(INA237_AlertType alert)</td><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html">Adafruit_INA237</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html#a6c17e64857065843706a46ccc80797a8">setShunt</a>(float shunt_res=0.1, float max_current=3.2) override</td><td class="entry"><a class="el" href="class_adafruit___i_n_a237.html">Adafruit_INA237</a></td><td class="entry"></td></tr>
|
||||
</table></div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.13
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
193
html/class_adafruit___i_n_a238.html
Normal file
|
|
@ -0,0 +1,193 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>Adafruit INA237 and INA238 Arduino Library: Adafruit_INA238 Class Reference</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||
<script type="text/javascript" src="search/search.js"></script>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">Adafruit INA237 and INA238 Arduino Library
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.13 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search');
|
||||
$(document).ready(function() { init_search(); });
|
||||
});
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
</div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<iframe src="javascript:void(0)" frameborder="0"
|
||||
name="MSearchResults" id="MSearchResults">
|
||||
</iframe>
|
||||
</div>
|
||||
|
||||
</div><!-- top -->
|
||||
<div class="header">
|
||||
<div class="summary">
|
||||
<a href="#pub-methods">Public Member Functions</a> |
|
||||
<a href="class_adafruit___i_n_a238-members.html">List of all members</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">Adafruit_INA238 Class Reference</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Class that stores state and functions for interacting with INA238 Current and Power Sensor (identical to INA237)
|
||||
<a href="class_adafruit___i_n_a238.html#details">More...</a></p>
|
||||
|
||||
<p><code>#include <<a class="el" href="_adafruit___i_n_a238_8h_source.html">Adafruit_INA238.h</a>></code></p>
|
||||
<div class="dynheader">
|
||||
Inheritance diagram for Adafruit_INA238:</div>
|
||||
<div class="dyncontent">
|
||||
<div class="center">
|
||||
<img src="class_adafruit___i_n_a238.png" usemap="#Adafruit_5FINA238_map" alt=""/>
|
||||
<map id="Adafruit_5FINA238_map" name="Adafruit_5FINA238_map">
|
||||
<area href="class_adafruit___i_n_a237.html" title="Class that stores state and functions for interacting with INA237/INA238 Current and Power Sensors..." alt="Adafruit_INA237" shape="rect" coords="0,56,106,80"/>
|
||||
</map>
|
||||
</div></div>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||||
Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:a94012bdb08cb6868eb01496c4824e3c0"><td class="memItemLeft" align="right" valign="top"><a id="a94012bdb08cb6868eb01496c4824e3c0"></a>
|
||||
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___i_n_a238.html#a94012bdb08cb6868eb01496c4824e3c0">Adafruit_INA238</a> ()</td></tr>
|
||||
<tr class="memdesc:a94012bdb08cb6868eb01496c4824e3c0"><td class="mdescLeft"> </td><td class="mdescRight">Instantiates a new INA238 class. <br /></td></tr>
|
||||
<tr class="separator:a94012bdb08cb6868eb01496c4824e3c0"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a419f14f55eb3aff12f7f9e63f5eaf9a1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___i_n_a238.html#a419f14f55eb3aff12f7f9e63f5eaf9a1">begin</a> (uint8_t i2c_addr=<a class="el" href="_adafruit___i_n_a238_8h.html#aff39b25047564f1595d512422c428a60">INA238_I2CADDR_DEFAULT</a>, TwoWire *theWire=&Wire, bool skipReset=false)</td></tr>
|
||||
<tr class="memdesc:a419f14f55eb3aff12f7f9e63f5eaf9a1"><td class="mdescLeft"> </td><td class="mdescRight">Sets up the HW. <a href="#a419f14f55eb3aff12f7f9e63f5eaf9a1">More...</a><br /></td></tr>
|
||||
<tr class="separator:a419f14f55eb3aff12f7f9e63f5eaf9a1"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="inherit_header pub_methods_class_adafruit___i_n_a237"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_adafruit___i_n_a237')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_adafruit___i_n_a237.html">Adafruit_INA237</a></td></tr>
|
||||
<tr class="memitem:a00a593696b8d55749537bc6af8b69c48 inherit pub_methods_class_adafruit___i_n_a237"><td class="memItemLeft" align="right" valign="top"><a id="a00a593696b8d55749537bc6af8b69c48"></a>
|
||||
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___i_n_a237.html#a00a593696b8d55749537bc6af8b69c48">Adafruit_INA237</a> ()</td></tr>
|
||||
<tr class="memdesc:a00a593696b8d55749537bc6af8b69c48 inherit pub_methods_class_adafruit___i_n_a237"><td class="mdescLeft"> </td><td class="mdescRight">Instantiates a new INA237 class. <br /></td></tr>
|
||||
<tr class="separator:a00a593696b8d55749537bc6af8b69c48 inherit pub_methods_class_adafruit___i_n_a237"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a5b57c715d573272a487186edd4469e71 inherit pub_methods_class_adafruit___i_n_a237"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___i_n_a237.html#a5b57c715d573272a487186edd4469e71">begin</a> (uint8_t i2c_addr=<a class="el" href="_adafruit___i_n_a237_8h.html#a9177aab49a4aa471df9745486905a18b">INA237_I2CADDR_DEFAULT</a>, TwoWire *theWire=&Wire, bool skipReset=false)</td></tr>
|
||||
<tr class="memdesc:a5b57c715d573272a487186edd4469e71 inherit pub_methods_class_adafruit___i_n_a237"><td class="mdescLeft"> </td><td class="mdescRight">Sets up the HW. <a href="class_adafruit___i_n_a237.html#a5b57c715d573272a487186edd4469e71">More...</a><br /></td></tr>
|
||||
<tr class="separator:a5b57c715d573272a487186edd4469e71 inherit pub_methods_class_adafruit___i_n_a237"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a838055b7f33554847d78d6bcc1d8f96f inherit pub_methods_class_adafruit___i_n_a237"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_adafruit___i_n_a237_8h.html#a1c988ddedc2786e59aca503b313b0724">INA237_AlertType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___i_n_a237.html#a838055b7f33554847d78d6bcc1d8f96f">getAlertType</a> (void)</td></tr>
|
||||
<tr class="memdesc:a838055b7f33554847d78d6bcc1d8f96f inherit pub_methods_class_adafruit___i_n_a237"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current alert type. <a href="class_adafruit___i_n_a237.html#a838055b7f33554847d78d6bcc1d8f96f">More...</a><br /></td></tr>
|
||||
<tr class="separator:a838055b7f33554847d78d6bcc1d8f96f inherit pub_methods_class_adafruit___i_n_a237"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a11d973a1c34188e0651566ea0bf15018 inherit pub_methods_class_adafruit___i_n_a237"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___i_n_a237.html#a11d973a1c34188e0651566ea0bf15018">setAlertType</a> (<a class="el" href="_adafruit___i_n_a237_8h.html#a1c988ddedc2786e59aca503b313b0724">INA237_AlertType</a> alert)</td></tr>
|
||||
<tr class="memdesc:a11d973a1c34188e0651566ea0bf15018 inherit pub_methods_class_adafruit___i_n_a237"><td class="mdescLeft"> </td><td class="mdescRight">Sets a new alert type. <a href="class_adafruit___i_n_a237.html#a11d973a1c34188e0651566ea0bf15018">More...</a><br /></td></tr>
|
||||
<tr class="separator:a11d973a1c34188e0651566ea0bf15018 inherit pub_methods_class_adafruit___i_n_a237"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ab1e34a67d118bca72df89749bad07ee4 inherit pub_methods_class_adafruit___i_n_a237"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___i_n_a237.html#ab1e34a67d118bca72df89749bad07ee4">readDieTemp</a> (void) override</td></tr>
|
||||
<tr class="memdesc:ab1e34a67d118bca72df89749bad07ee4 inherit pub_methods_class_adafruit___i_n_a237"><td class="mdescLeft"> </td><td class="mdescRight">Reads the die temperature with the INA237-specific conversion factor. <a href="class_adafruit___i_n_a237.html#ab1e34a67d118bca72df89749bad07ee4">More...</a><br /></td></tr>
|
||||
<tr class="separator:ab1e34a67d118bca72df89749bad07ee4 inherit pub_methods_class_adafruit___i_n_a237"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a64e9ad6f47c561fe08352f7ed4b924b1 inherit pub_methods_class_adafruit___i_n_a237"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___i_n_a237.html#a64e9ad6f47c561fe08352f7ed4b924b1">readBusVoltage</a> (void) override</td></tr>
|
||||
<tr class="memdesc:a64e9ad6f47c561fe08352f7ed4b924b1 inherit pub_methods_class_adafruit___i_n_a237"><td class="mdescLeft"> </td><td class="mdescRight">Reads and scales the current value of the Bus Voltage register using INA237-specific conversion factor. <a href="class_adafruit___i_n_a237.html#a64e9ad6f47c561fe08352f7ed4b924b1">More...</a><br /></td></tr>
|
||||
<tr class="separator:a64e9ad6f47c561fe08352f7ed4b924b1 inherit pub_methods_class_adafruit___i_n_a237"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a7a6e4eb322f25f8d390e4f4a7af62bca inherit pub_methods_class_adafruit___i_n_a237"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___i_n_a237.html#a7a6e4eb322f25f8d390e4f4a7af62bca">readShuntVoltage</a> (void) override</td></tr>
|
||||
<tr class="memdesc:a7a6e4eb322f25f8d390e4f4a7af62bca inherit pub_methods_class_adafruit___i_n_a237"><td class="mdescLeft"> </td><td class="mdescRight">Reads and scales the current value of the Shunt Voltage register using INA237-specific conversion factor. <a href="class_adafruit___i_n_a237.html#a7a6e4eb322f25f8d390e4f4a7af62bca">More...</a><br /></td></tr>
|
||||
<tr class="separator:a7a6e4eb322f25f8d390e4f4a7af62bca inherit pub_methods_class_adafruit___i_n_a237"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:abc259e72a96b712f12058a500e53b064 inherit pub_methods_class_adafruit___i_n_a237"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___i_n_a237.html#abc259e72a96b712f12058a500e53b064">readCurrent</a> (void) override</td></tr>
|
||||
<tr class="memdesc:abc259e72a96b712f12058a500e53b064 inherit pub_methods_class_adafruit___i_n_a237"><td class="mdescLeft"> </td><td class="mdescRight">Reads and scales the current value of the Current register using INA237-specific handling. <a href="class_adafruit___i_n_a237.html#abc259e72a96b712f12058a500e53b064">More...</a><br /></td></tr>
|
||||
<tr class="separator:abc259e72a96b712f12058a500e53b064 inherit pub_methods_class_adafruit___i_n_a237"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a78c43dfbbd2257050ea35fcdb7ebfabb inherit pub_methods_class_adafruit___i_n_a237"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___i_n_a237.html#a78c43dfbbd2257050ea35fcdb7ebfabb">readPower</a> (void) override</td></tr>
|
||||
<tr class="memdesc:a78c43dfbbd2257050ea35fcdb7ebfabb inherit pub_methods_class_adafruit___i_n_a237"><td class="mdescLeft"> </td><td class="mdescRight">Reads and scales the current value of the Power register using INA237-specific handling. <a href="class_adafruit___i_n_a237.html#a78c43dfbbd2257050ea35fcdb7ebfabb">More...</a><br /></td></tr>
|
||||
<tr class="separator:a78c43dfbbd2257050ea35fcdb7ebfabb inherit pub_methods_class_adafruit___i_n_a237"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a6c17e64857065843706a46ccc80797a8 inherit pub_methods_class_adafruit___i_n_a237"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___i_n_a237.html#a6c17e64857065843706a46ccc80797a8">setShunt</a> (float shunt_res=0.1, float max_current=3.2) override</td></tr>
|
||||
<tr class="memdesc:a6c17e64857065843706a46ccc80797a8 inherit pub_methods_class_adafruit___i_n_a237"><td class="mdescLeft"> </td><td class="mdescRight">Sets the shunt calibration by resistor for INA237. <a href="class_adafruit___i_n_a237.html#a6c17e64857065843706a46ccc80797a8">More...</a><br /></td></tr>
|
||||
<tr class="separator:a6c17e64857065843706a46ccc80797a8 inherit pub_methods_class_adafruit___i_n_a237"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
|
||||
Additional Inherited Members</h2></td></tr>
|
||||
<tr class="inherit_header pro_methods_class_adafruit___i_n_a237"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_adafruit___i_n_a237')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="class_adafruit___i_n_a237.html">Adafruit_INA237</a></td></tr>
|
||||
<tr class="memitem:af4e10e12e0d94a5c725aa26aa984dd09 inherit pro_methods_class_adafruit___i_n_a237"><td class="memItemLeft" align="right" valign="top"><a id="af4e10e12e0d94a5c725aa26aa984dd09"></a>
|
||||
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___i_n_a237.html#af4e10e12e0d94a5c725aa26aa984dd09">_updateShuntCalRegister</a> (void) override</td></tr>
|
||||
<tr class="memdesc:af4e10e12e0d94a5c725aa26aa984dd09 inherit pro_methods_class_adafruit___i_n_a237"><td class="mdescLeft"> </td><td class="mdescRight">Updates the shunt calibration value to the INA237 register. The INA237 uses a different calculation than the INA228. <br /></td></tr>
|
||||
<tr class="separator:af4e10e12e0d94a5c725aa26aa984dd09 inherit pro_methods_class_adafruit___i_n_a237"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>Class that stores state and functions for interacting with INA238 Current and Power Sensor (identical to INA237) </p>
|
||||
</div><h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a id="a419f14f55eb3aff12f7f9e63f5eaf9a1"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a419f14f55eb3aff12f7f9e63f5eaf9a1">◆ </a></span>begin()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">bool Adafruit_INA238::begin </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint8_t </td>
|
||||
<td class="paramname"><em>i2c_address</em> = <code><a class="el" href="_adafruit___i_n_a238_8h.html#aff39b25047564f1595d512422c428a60">INA238_I2CADDR_DEFAULT</a></code>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">TwoWire * </td>
|
||||
<td class="paramname"><em>theWire</em> = <code>&Wire</code>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">bool </td>
|
||||
<td class="paramname"><em>skipReset</em> = <code>false</code> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Sets up the HW. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">i2c_address</td><td>The I2C address to be used. </td></tr>
|
||||
<tr><td class="paramname">theWire</td><td>The Wire object to be used for I2C connections. </td></tr>
|
||||
<tr><td class="paramname">skipReset</td><td>When set to true, will omit resetting all registers to their default values. Default: false. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd>True if initialization was successful, otherwise false. </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<hr/>The documentation for this class was generated from the following files:<ul>
|
||||
<li><a class="el" href="_adafruit___i_n_a238_8h_source.html">Adafruit_INA238.h</a></li>
|
||||
<li><a class="el" href="_adafruit___i_n_a238_8cpp.html">Adafruit_INA238.cpp</a></li>
|
||||
</ul>
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.13
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
BIN
html/class_adafruit___i_n_a238.png
Normal file
|
After Width: | Height: | Size: 811 B |
82
html/classes.html
Normal file
|
|
@ -0,0 +1,82 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>Adafruit INA237 and INA238 Arduino Library: Class Index</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||
<script type="text/javascript" src="search/search.js"></script>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">Adafruit INA237 and INA238 Arduino Library
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.13 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search');
|
||||
$(document).ready(function() { init_search(); });
|
||||
});
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
</div><!-- top -->
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
</div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<iframe src="javascript:void(0)" frameborder="0"
|
||||
name="MSearchResults" id="MSearchResults">
|
||||
</iframe>
|
||||
</div>
|
||||
|
||||
<div class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">Class Index</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<div class="qindex"><a class="qindex" href="#letter_a">a</a></div>
|
||||
<table class="classindex">
|
||||
<tr><td rowspan="2" valign="bottom"><a name="letter_a"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">  a  </div></td></tr></table>
|
||||
</td><td valign="top"><a class="el" href="class_adafruit___i_n_a238.html">Adafruit_INA238</a>   </td><td></td></tr>
|
||||
<tr><td></td><td></td></tr>
|
||||
<tr><td valign="top"><a class="el" href="class_adafruit___i_n_a237.html">Adafruit_INA237</a>   </td><td></td><td></td></tr>
|
||||
<tr><td></td><td></td><td></td></tr>
|
||||
</table>
|
||||
<div class="qindex"><a class="qindex" href="#letter_a">a</a></div>
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.13
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
BIN
html/closed.png
Normal file
|
After Width: | Height: | Size: 132 B |
BIN
html/doc.png
Normal file
|
After Width: | Height: | Size: 746 B |
1596
html/doxygen.css
Normal file
BIN
html/doxygen.png
Normal file
|
After Width: | Height: | Size: 3.7 KiB |
97
html/dynsections.js
Normal file
|
|
@ -0,0 +1,97 @@
|
|||
function toggleVisibility(linkObj)
|
||||
{
|
||||
var base = $(linkObj).attr('id');
|
||||
var summary = $('#'+base+'-summary');
|
||||
var content = $('#'+base+'-content');
|
||||
var trigger = $('#'+base+'-trigger');
|
||||
var src=$(trigger).attr('src');
|
||||
if (content.is(':visible')===true) {
|
||||
content.hide();
|
||||
summary.show();
|
||||
$(linkObj).addClass('closed').removeClass('opened');
|
||||
$(trigger).attr('src',src.substring(0,src.length-8)+'closed.png');
|
||||
} else {
|
||||
content.show();
|
||||
summary.hide();
|
||||
$(linkObj).removeClass('closed').addClass('opened');
|
||||
$(trigger).attr('src',src.substring(0,src.length-10)+'open.png');
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
function updateStripes()
|
||||
{
|
||||
$('table.directory tr').
|
||||
removeClass('even').filter(':visible:even').addClass('even');
|
||||
}
|
||||
|
||||
function toggleLevel(level)
|
||||
{
|
||||
$('table.directory tr').each(function() {
|
||||
var l = this.id.split('_').length-1;
|
||||
var i = $('#img'+this.id.substring(3));
|
||||
var a = $('#arr'+this.id.substring(3));
|
||||
if (l<level+1) {
|
||||
i.removeClass('iconfopen iconfclosed').addClass('iconfopen');
|
||||
a.html('▼');
|
||||
$(this).show();
|
||||
} else if (l==level+1) {
|
||||
i.removeClass('iconfclosed iconfopen').addClass('iconfclosed');
|
||||
a.html('►');
|
||||
$(this).show();
|
||||
} else {
|
||||
$(this).hide();
|
||||
}
|
||||
});
|
||||
updateStripes();
|
||||
}
|
||||
|
||||
function toggleFolder(id)
|
||||
{
|
||||
// the clicked row
|
||||
var currentRow = $('#row_'+id);
|
||||
|
||||
// all rows after the clicked row
|
||||
var rows = currentRow.nextAll("tr");
|
||||
|
||||
var re = new RegExp('^row_'+id+'\\d+_$', "i"); //only one sub
|
||||
|
||||
// only match elements AFTER this one (can't hide elements before)
|
||||
var childRows = rows.filter(function() { return this.id.match(re); });
|
||||
|
||||
// first row is visible we are HIDING
|
||||
if (childRows.filter(':first').is(':visible')===true) {
|
||||
// replace down arrow by right arrow for current row
|
||||
var currentRowSpans = currentRow.find("span");
|
||||
currentRowSpans.filter(".iconfopen").removeClass("iconfopen").addClass("iconfclosed");
|
||||
currentRowSpans.filter(".arrow").html('►');
|
||||
rows.filter("[id^=row_"+id+"]").hide(); // hide all children
|
||||
} else { // we are SHOWING
|
||||
// replace right arrow by down arrow for current row
|
||||
var currentRowSpans = currentRow.find("span");
|
||||
currentRowSpans.filter(".iconfclosed").removeClass("iconfclosed").addClass("iconfopen");
|
||||
currentRowSpans.filter(".arrow").html('▼');
|
||||
// replace down arrows by right arrows for child rows
|
||||
var childRowsSpans = childRows.find("span");
|
||||
childRowsSpans.filter(".iconfopen").removeClass("iconfopen").addClass("iconfclosed");
|
||||
childRowsSpans.filter(".arrow").html('►');
|
||||
childRows.show(); //show all children
|
||||
}
|
||||
updateStripes();
|
||||
}
|
||||
|
||||
|
||||
function toggleInherit(id)
|
||||
{
|
||||
var rows = $('tr.inherit.'+id);
|
||||
var img = $('tr.inherit_header.'+id+' img');
|
||||
var src = $(img).attr('src');
|
||||
if (rows.filter(':first').is(':visible')===true) {
|
||||
rows.css('display','none');
|
||||
$(img).attr('src',src.substring(0,src.length-8)+'closed.png');
|
||||
} else {
|
||||
rows.css('display','table-row'); // using show() causes jump in firefox
|
||||
$(img).attr('src',src.substring(0,src.length-10)+'open.png');
|
||||
}
|
||||
}
|
||||
|
||||
81
html/files.html
Normal file
|
|
@ -0,0 +1,81 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>Adafruit INA237 and INA238 Arduino Library: File List</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||
<script type="text/javascript" src="search/search.js"></script>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">Adafruit INA237 and INA238 Arduino Library
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.13 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search');
|
||||
$(document).ready(function() { init_search(); });
|
||||
});
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
</div><!-- top -->
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
</div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<iframe src="javascript:void(0)" frameborder="0"
|
||||
name="MSearchResults" id="MSearchResults">
|
||||
</iframe>
|
||||
</div>
|
||||
|
||||
<div class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">File List</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<div class="textblock">Here is a list of all documented files with brief descriptions:</div><div class="directory">
|
||||
<table class="directory">
|
||||
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icondoc"></span><a class="el" href="_adafruit___i_n_a237_8cpp.html" target="_self">Adafruit_INA237.cpp</a></td><td class="desc"></td></tr>
|
||||
<tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a href="_adafruit___i_n_a237_8h_source.html"><span class="icondoc"></span></a><a class="el" href="_adafruit___i_n_a237_8h.html" target="_self">Adafruit_INA237.h</a></td><td class="desc"></td></tr>
|
||||
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icondoc"></span><a class="el" href="_adafruit___i_n_a238_8cpp.html" target="_self">Adafruit_INA238.cpp</a></td><td class="desc"></td></tr>
|
||||
<tr id="row_3_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a href="_adafruit___i_n_a238_8h_source.html"><span class="icondoc"></span></a><a class="el" href="_adafruit___i_n_a238_8h.html" target="_self">Adafruit_INA238.h</a></td><td class="desc"></td></tr>
|
||||
</table>
|
||||
</div><!-- directory -->
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.13
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
BIN
html/folderclosed.png
Normal file
|
After Width: | Height: | Size: 616 B |
BIN
html/folderopen.png
Normal file
|
After Width: | Height: | Size: 597 B |
108
html/functions.html
Normal file
|
|
@ -0,0 +1,108 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>Adafruit INA237 and INA238 Arduino Library: Class Members</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||
<script type="text/javascript" src="search/search.js"></script>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">Adafruit INA237 and INA238 Arduino Library
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.13 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search');
|
||||
$(document).ready(function() { init_search(); });
|
||||
});
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
</div><!-- top -->
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
</div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<iframe src="javascript:void(0)" frameborder="0"
|
||||
name="MSearchResults" id="MSearchResults">
|
||||
</iframe>
|
||||
</div>
|
||||
|
||||
<div class="contents">
|
||||
<div class="textblock">Here is a list of all documented class members with links to the class documentation for each member:</div><ul>
|
||||
<li>_updateShuntCalRegister()
|
||||
: <a class="el" href="class_adafruit___i_n_a237.html#af4e10e12e0d94a5c725aa26aa984dd09">Adafruit_INA237</a>
|
||||
</li>
|
||||
<li>Adafruit_INA237()
|
||||
: <a class="el" href="class_adafruit___i_n_a237.html#a00a593696b8d55749537bc6af8b69c48">Adafruit_INA237</a>
|
||||
</li>
|
||||
<li>Adafruit_INA238()
|
||||
: <a class="el" href="class_adafruit___i_n_a238.html#a94012bdb08cb6868eb01496c4824e3c0">Adafruit_INA238</a>
|
||||
</li>
|
||||
<li>begin()
|
||||
: <a class="el" href="class_adafruit___i_n_a237.html#a5b57c715d573272a487186edd4469e71">Adafruit_INA237</a>
|
||||
, <a class="el" href="class_adafruit___i_n_a238.html#a419f14f55eb3aff12f7f9e63f5eaf9a1">Adafruit_INA238</a>
|
||||
</li>
|
||||
<li>getAlertType()
|
||||
: <a class="el" href="class_adafruit___i_n_a237.html#a838055b7f33554847d78d6bcc1d8f96f">Adafruit_INA237</a>
|
||||
</li>
|
||||
<li>readBusVoltage()
|
||||
: <a class="el" href="class_adafruit___i_n_a237.html#a64e9ad6f47c561fe08352f7ed4b924b1">Adafruit_INA237</a>
|
||||
</li>
|
||||
<li>readCurrent()
|
||||
: <a class="el" href="class_adafruit___i_n_a237.html#abc259e72a96b712f12058a500e53b064">Adafruit_INA237</a>
|
||||
</li>
|
||||
<li>readDieTemp()
|
||||
: <a class="el" href="class_adafruit___i_n_a237.html#ab1e34a67d118bca72df89749bad07ee4">Adafruit_INA237</a>
|
||||
</li>
|
||||
<li>readPower()
|
||||
: <a class="el" href="class_adafruit___i_n_a237.html#a78c43dfbbd2257050ea35fcdb7ebfabb">Adafruit_INA237</a>
|
||||
</li>
|
||||
<li>readShuntVoltage()
|
||||
: <a class="el" href="class_adafruit___i_n_a237.html#a7a6e4eb322f25f8d390e4f4a7af62bca">Adafruit_INA237</a>
|
||||
</li>
|
||||
<li>setAlertType()
|
||||
: <a class="el" href="class_adafruit___i_n_a237.html#a11d973a1c34188e0651566ea0bf15018">Adafruit_INA237</a>
|
||||
</li>
|
||||
<li>setShunt()
|
||||
: <a class="el" href="class_adafruit___i_n_a237.html#a6c17e64857065843706a46ccc80797a8">Adafruit_INA237</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.13
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
108
html/functions_func.html
Normal file
|
|
@ -0,0 +1,108 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>Adafruit INA237 and INA238 Arduino Library: Class Members - Functions</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||
<script type="text/javascript" src="search/search.js"></script>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">Adafruit INA237 and INA238 Arduino Library
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.13 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search');
|
||||
$(document).ready(function() { init_search(); });
|
||||
});
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
</div><!-- top -->
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
</div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<iframe src="javascript:void(0)" frameborder="0"
|
||||
name="MSearchResults" id="MSearchResults">
|
||||
</iframe>
|
||||
</div>
|
||||
|
||||
<div class="contents">
|
||||
 <ul>
|
||||
<li>_updateShuntCalRegister()
|
||||
: <a class="el" href="class_adafruit___i_n_a237.html#af4e10e12e0d94a5c725aa26aa984dd09">Adafruit_INA237</a>
|
||||
</li>
|
||||
<li>Adafruit_INA237()
|
||||
: <a class="el" href="class_adafruit___i_n_a237.html#a00a593696b8d55749537bc6af8b69c48">Adafruit_INA237</a>
|
||||
</li>
|
||||
<li>Adafruit_INA238()
|
||||
: <a class="el" href="class_adafruit___i_n_a238.html#a94012bdb08cb6868eb01496c4824e3c0">Adafruit_INA238</a>
|
||||
</li>
|
||||
<li>begin()
|
||||
: <a class="el" href="class_adafruit___i_n_a237.html#a5b57c715d573272a487186edd4469e71">Adafruit_INA237</a>
|
||||
, <a class="el" href="class_adafruit___i_n_a238.html#a419f14f55eb3aff12f7f9e63f5eaf9a1">Adafruit_INA238</a>
|
||||
</li>
|
||||
<li>getAlertType()
|
||||
: <a class="el" href="class_adafruit___i_n_a237.html#a838055b7f33554847d78d6bcc1d8f96f">Adafruit_INA237</a>
|
||||
</li>
|
||||
<li>readBusVoltage()
|
||||
: <a class="el" href="class_adafruit___i_n_a237.html#a64e9ad6f47c561fe08352f7ed4b924b1">Adafruit_INA237</a>
|
||||
</li>
|
||||
<li>readCurrent()
|
||||
: <a class="el" href="class_adafruit___i_n_a237.html#abc259e72a96b712f12058a500e53b064">Adafruit_INA237</a>
|
||||
</li>
|
||||
<li>readDieTemp()
|
||||
: <a class="el" href="class_adafruit___i_n_a237.html#ab1e34a67d118bca72df89749bad07ee4">Adafruit_INA237</a>
|
||||
</li>
|
||||
<li>readPower()
|
||||
: <a class="el" href="class_adafruit___i_n_a237.html#a78c43dfbbd2257050ea35fcdb7ebfabb">Adafruit_INA237</a>
|
||||
</li>
|
||||
<li>readShuntVoltage()
|
||||
: <a class="el" href="class_adafruit___i_n_a237.html#a7a6e4eb322f25f8d390e4f4a7af62bca">Adafruit_INA237</a>
|
||||
</li>
|
||||
<li>setAlertType()
|
||||
: <a class="el" href="class_adafruit___i_n_a237.html#a11d973a1c34188e0651566ea0bf15018">Adafruit_INA237</a>
|
||||
</li>
|
||||
<li>setShunt()
|
||||
: <a class="el" href="class_adafruit___i_n_a237.html#a6c17e64857065843706a46ccc80797a8">Adafruit_INA237</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.13
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
114
html/globals.html
Normal file
|
|
@ -0,0 +1,114 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>Adafruit INA237 and INA238 Arduino Library: File Members</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||
<script type="text/javascript" src="search/search.js"></script>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">Adafruit INA237 and INA238 Arduino Library
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.13 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search');
|
||||
$(document).ready(function() { init_search(); });
|
||||
});
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
</div><!-- top -->
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
</div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<iframe src="javascript:void(0)" frameborder="0"
|
||||
name="MSearchResults" id="MSearchResults">
|
||||
</iframe>
|
||||
</div>
|
||||
|
||||
<div class="contents">
|
||||
<div class="textblock">Here is a list of all documented file members with links to the documentation:</div><ul>
|
||||
<li>_ina237_alert_type
|
||||
: <a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6">Adafruit_INA237.h</a>
|
||||
</li>
|
||||
<li>INA237_ALERT_CONVERSION_READY
|
||||
: <a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6a12357c3d7f9932f9feede12f9038858d">Adafruit_INA237.h</a>
|
||||
</li>
|
||||
<li>INA237_ALERT_NONE
|
||||
: <a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6a6c5adeed8029f07c9b5eee29dd4ef591">Adafruit_INA237.h</a>
|
||||
</li>
|
||||
<li>INA237_ALERT_OVERPOWER
|
||||
: <a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6aa9d3979bf691b9b09e07a298c71a7434">Adafruit_INA237.h</a>
|
||||
</li>
|
||||
<li>INA237_ALERT_OVERSHUNT
|
||||
: <a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6a611c3fd1209b94a4cc500077ec132250">Adafruit_INA237.h</a>
|
||||
</li>
|
||||
<li>INA237_ALERT_OVERTEMPERATURE
|
||||
: <a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6a083d640626067b99cea2ae239b8056d7">Adafruit_INA237.h</a>
|
||||
</li>
|
||||
<li>INA237_ALERT_OVERVOLTAGE
|
||||
: <a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6acca068883a24e45cc0229ce3d88863f0">Adafruit_INA237.h</a>
|
||||
</li>
|
||||
<li>INA237_ALERT_UNDERSHUNT
|
||||
: <a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6a442a01c1321b6e2f7948667fa8c3d141">Adafruit_INA237.h</a>
|
||||
</li>
|
||||
<li>INA237_ALERT_UNDERVOLTAGE
|
||||
: <a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6ab4f7d16e99928e74e199f22ff40fba0c">Adafruit_INA237.h</a>
|
||||
</li>
|
||||
<li>INA237_AlertType
|
||||
: <a class="el" href="_adafruit___i_n_a237_8h.html#a1c988ddedc2786e59aca503b313b0724">Adafruit_INA237.h</a>
|
||||
</li>
|
||||
<li>INA237_DEVICE_ID
|
||||
: <a class="el" href="_adafruit___i_n_a237_8h.html#ae0504710b4239c77874e0757b11a200f">Adafruit_INA237.h</a>
|
||||
</li>
|
||||
<li>INA237_I2CADDR_DEFAULT
|
||||
: <a class="el" href="_adafruit___i_n_a237_8h.html#a9177aab49a4aa471df9745486905a18b">Adafruit_INA237.h</a>
|
||||
</li>
|
||||
<li>INA238_DEVICE_ID
|
||||
: <a class="el" href="_adafruit___i_n_a237_8h.html#ac12c78da9272fb94981fa6ec77f5f22a">Adafruit_INA237.h</a>
|
||||
, <a class="el" href="_adafruit___i_n_a238_8h.html#ac12c78da9272fb94981fa6ec77f5f22a">Adafruit_INA238.h</a>
|
||||
</li>
|
||||
<li>INA238_I2CADDR_DEFAULT
|
||||
: <a class="el" href="_adafruit___i_n_a238_8h.html#aff39b25047564f1595d512422c428a60">Adafruit_INA238.h</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.13
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
84
html/globals_defs.html
Normal file
|
|
@ -0,0 +1,84 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>Adafruit INA237 and INA238 Arduino Library: File Members</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||
<script type="text/javascript" src="search/search.js"></script>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">Adafruit INA237 and INA238 Arduino Library
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.13 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search');
|
||||
$(document).ready(function() { init_search(); });
|
||||
});
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
</div><!-- top -->
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
</div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<iframe src="javascript:void(0)" frameborder="0"
|
||||
name="MSearchResults" id="MSearchResults">
|
||||
</iframe>
|
||||
</div>
|
||||
|
||||
<div class="contents">
|
||||
 <ul>
|
||||
<li>INA237_DEVICE_ID
|
||||
: <a class="el" href="_adafruit___i_n_a237_8h.html#ae0504710b4239c77874e0757b11a200f">Adafruit_INA237.h</a>
|
||||
</li>
|
||||
<li>INA237_I2CADDR_DEFAULT
|
||||
: <a class="el" href="_adafruit___i_n_a237_8h.html#a9177aab49a4aa471df9745486905a18b">Adafruit_INA237.h</a>
|
||||
</li>
|
||||
<li>INA238_DEVICE_ID
|
||||
: <a class="el" href="_adafruit___i_n_a238_8h.html#ac12c78da9272fb94981fa6ec77f5f22a">Adafruit_INA238.h</a>
|
||||
, <a class="el" href="_adafruit___i_n_a237_8h.html#ac12c78da9272fb94981fa6ec77f5f22a">Adafruit_INA237.h</a>
|
||||
</li>
|
||||
<li>INA238_I2CADDR_DEFAULT
|
||||
: <a class="el" href="_adafruit___i_n_a238_8h.html#aff39b25047564f1595d512422c428a60">Adafruit_INA238.h</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.13
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
74
html/globals_enum.html
Normal file
|
|
@ -0,0 +1,74 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>Adafruit INA237 and INA238 Arduino Library: File Members</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||
<script type="text/javascript" src="search/search.js"></script>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">Adafruit INA237 and INA238 Arduino Library
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.13 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search');
|
||||
$(document).ready(function() { init_search(); });
|
||||
});
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
</div><!-- top -->
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
</div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<iframe src="javascript:void(0)" frameborder="0"
|
||||
name="MSearchResults" id="MSearchResults">
|
||||
</iframe>
|
||||
</div>
|
||||
|
||||
<div class="contents">
|
||||
 <ul>
|
||||
<li>_ina237_alert_type
|
||||
: <a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6">Adafruit_INA237.h</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.13
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
95
html/globals_eval.html
Normal file
|
|
@ -0,0 +1,95 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>Adafruit INA237 and INA238 Arduino Library: File Members</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||
<script type="text/javascript" src="search/search.js"></script>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">Adafruit INA237 and INA238 Arduino Library
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.13 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search');
|
||||
$(document).ready(function() { init_search(); });
|
||||
});
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
</div><!-- top -->
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
</div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<iframe src="javascript:void(0)" frameborder="0"
|
||||
name="MSearchResults" id="MSearchResults">
|
||||
</iframe>
|
||||
</div>
|
||||
|
||||
<div class="contents">
|
||||
 <ul>
|
||||
<li>INA237_ALERT_CONVERSION_READY
|
||||
: <a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6a12357c3d7f9932f9feede12f9038858d">Adafruit_INA237.h</a>
|
||||
</li>
|
||||
<li>INA237_ALERT_NONE
|
||||
: <a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6a6c5adeed8029f07c9b5eee29dd4ef591">Adafruit_INA237.h</a>
|
||||
</li>
|
||||
<li>INA237_ALERT_OVERPOWER
|
||||
: <a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6aa9d3979bf691b9b09e07a298c71a7434">Adafruit_INA237.h</a>
|
||||
</li>
|
||||
<li>INA237_ALERT_OVERSHUNT
|
||||
: <a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6a611c3fd1209b94a4cc500077ec132250">Adafruit_INA237.h</a>
|
||||
</li>
|
||||
<li>INA237_ALERT_OVERTEMPERATURE
|
||||
: <a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6a083d640626067b99cea2ae239b8056d7">Adafruit_INA237.h</a>
|
||||
</li>
|
||||
<li>INA237_ALERT_OVERVOLTAGE
|
||||
: <a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6acca068883a24e45cc0229ce3d88863f0">Adafruit_INA237.h</a>
|
||||
</li>
|
||||
<li>INA237_ALERT_UNDERSHUNT
|
||||
: <a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6a442a01c1321b6e2f7948667fa8c3d141">Adafruit_INA237.h</a>
|
||||
</li>
|
||||
<li>INA237_ALERT_UNDERVOLTAGE
|
||||
: <a class="el" href="_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6ab4f7d16e99928e74e199f22ff40fba0c">Adafruit_INA237.h</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.13
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
74
html/globals_type.html
Normal file
|
|
@ -0,0 +1,74 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>Adafruit INA237 and INA238 Arduino Library: File Members</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||
<script type="text/javascript" src="search/search.js"></script>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">Adafruit INA237 and INA238 Arduino Library
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.13 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search');
|
||||
$(document).ready(function() { init_search(); });
|
||||
});
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
</div><!-- top -->
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
</div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<iframe src="javascript:void(0)" frameborder="0"
|
||||
name="MSearchResults" id="MSearchResults">
|
||||
</iframe>
|
||||
</div>
|
||||
|
||||
<div class="contents">
|
||||
 <ul>
|
||||
<li>INA237_AlertType
|
||||
: <a class="el" href="_adafruit___i_n_a237_8h.html#a1c988ddedc2786e59aca503b313b0724">Adafruit_INA237.h</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.13
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
80
html/hierarchy.html
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>Adafruit INA237 and INA238 Arduino Library: Class Hierarchy</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||
<script type="text/javascript" src="search/search.js"></script>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">Adafruit INA237 and INA238 Arduino Library
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.13 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search');
|
||||
$(document).ready(function() { init_search(); });
|
||||
});
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
</div><!-- top -->
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
</div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<iframe src="javascript:void(0)" frameborder="0"
|
||||
name="MSearchResults" id="MSearchResults">
|
||||
</iframe>
|
||||
</div>
|
||||
|
||||
<div class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">Class Hierarchy</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<div class="textblock">This inheritance list is sorted roughly, but not completely, alphabetically:</div><div class="directory">
|
||||
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span>]</div><table class="directory">
|
||||
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">▼</span><span class="icona"><span class="icon">C</span></span><b>Adafruit_INA2xx</b></td><td class="desc"></td></tr>
|
||||
<tr id="row_0_0_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span id="arr_0_0_" class="arrow" onclick="toggleFolder('0_0_')">▼</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_adafruit___i_n_a237.html" target="_self">Adafruit_INA237</a></td><td class="desc">Class that stores state and functions for interacting with INA237/INA238 Current and Power Sensors </td></tr>
|
||||
<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_adafruit___i_n_a238.html" target="_self">Adafruit_INA238</a></td><td class="desc">Class that stores state and functions for interacting with INA238 Current and Power Sensor (identical to INA237) </td></tr>
|
||||
</table>
|
||||
</div><!-- directory -->
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.13
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
73
html/index.html
Normal file
|
|
@ -0,0 +1,73 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>Adafruit INA237 and INA238 Arduino Library: Main Page</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||
<script type="text/javascript" src="search/search.js"></script>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">Adafruit INA237 and INA238 Arduino Library
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.13 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search');
|
||||
$(document).ready(function() { init_search(); });
|
||||
});
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
</div><!-- top -->
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
</div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<iframe src="javascript:void(0)" frameborder="0"
|
||||
name="MSearchResults" id="MSearchResults">
|
||||
</iframe>
|
||||
</div>
|
||||
|
||||
<div class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">Adafruit INA237 and INA238 Arduino Library Documentation</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.13
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
87
html/jquery.js
vendored
Normal file
26
html/menu.js
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
function initMenu(relPath,searchEnabled,serverSide,searchPage,search) {
|
||||
function makeTree(data,relPath) {
|
||||
var result='';
|
||||
if ('children' in data) {
|
||||
result+='<ul>';
|
||||
for (var i in data.children) {
|
||||
result+='<li><a href="'+relPath+data.children[i].url+'">'+
|
||||
data.children[i].text+'</a>'+
|
||||
makeTree(data.children[i],relPath)+'</li>';
|
||||
}
|
||||
result+='</ul>';
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
$('#main-nav').append(makeTree(menudata,relPath));
|
||||
$('#main-nav').children(':first').addClass('sm sm-dox').attr('id','main-menu');
|
||||
if (searchEnabled) {
|
||||
if (serverSide) {
|
||||
$('#main-menu').append('<li style="float:right"><div id="MSearchBox" class="MSearchBoxInactive"><div class="left"><form id="FSearchBox" action="'+searchPage+'" method="get"><img id="MSearchSelect" src="'+relPath+'search/mag.png" alt=""/><input type="text" id="MSearchField" name="query" value="'+search+'" size="20" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)"></form></div><div class="right"></div></div></li>');
|
||||
} else {
|
||||
$('#main-menu').append('<li style="float:right"><div id="MSearchBox" class="MSearchBoxInactive"><span class="left"><img id="MSearchSelect" src="'+relPath+'search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/><input type="text" id="MSearchField" value="'+search+'" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/></span><span class="right"><a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="'+relPath+'search/close.png" alt=""/></a></span></div></li>');
|
||||
}
|
||||
}
|
||||
$('#main-menu').smartmenus();
|
||||
}
|
||||
17
html/menudata.js
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
var menudata={children:[
|
||||
{text:"Main Page",url:"index.html"},
|
||||
{text:"Classes",url:"annotated.html",children:[
|
||||
{text:"Class List",url:"annotated.html"},
|
||||
{text:"Class Index",url:"classes.html"},
|
||||
{text:"Class Hierarchy",url:"hierarchy.html"},
|
||||
{text:"Class Members",url:"functions.html",children:[
|
||||
{text:"All",url:"functions.html"},
|
||||
{text:"Functions",url:"functions_func.html"}]}]},
|
||||
{text:"Files",url:"files.html",children:[
|
||||
{text:"File List",url:"files.html"},
|
||||
{text:"File Members",url:"globals.html",children:[
|
||||
{text:"All",url:"globals.html"},
|
||||
{text:"Typedefs",url:"globals_type.html"},
|
||||
{text:"Enumerations",url:"globals_enum.html"},
|
||||
{text:"Enumerator",url:"globals_eval.html"},
|
||||
{text:"Macros",url:"globals_defs.html"}]}]}]}
|
||||
BIN
html/nav_f.png
Normal file
|
After Width: | Height: | Size: 153 B |
BIN
html/nav_g.png
Normal file
|
After Width: | Height: | Size: 95 B |
BIN
html/nav_h.png
Normal file
|
After Width: | Height: | Size: 98 B |
BIN
html/open.png
Normal file
|
After Width: | Height: | Size: 123 B |
26
html/search/all_0.html
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html><head><title></title>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<link rel="stylesheet" type="text/css" href="search.css"/>
|
||||
<script type="text/javascript" src="all_0.js"></script>
|
||||
<script type="text/javascript" src="search.js"></script>
|
||||
</head>
|
||||
<body class="SRPage">
|
||||
<div id="SRIndex">
|
||||
<div class="SRStatus" id="Loading">Loading...</div>
|
||||
<div id="SRResults"></div>
|
||||
<script type="text/javascript"><!--
|
||||
createResults();
|
||||
--></script>
|
||||
<div class="SRStatus" id="Searching">Searching...</div>
|
||||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||||
<script type="text/javascript"><!--
|
||||
document.getElementById("Loading").style.display="none";
|
||||
document.getElementById("NoMatches").style.display="none";
|
||||
var searchResults = new SearchResults("searchResults");
|
||||
searchResults.Search();
|
||||
--></script>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
5
html/search/all_0.js
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
var searchData=
|
||||
[
|
||||
['_5fina237_5falert_5ftype',['_ina237_alert_type',['../_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6',1,'Adafruit_INA237.h']]],
|
||||
['_5fupdateshuntcalregister',['_updateShuntCalRegister',['../class_adafruit___i_n_a237.html#af4e10e12e0d94a5c725aa26aa984dd09',1,'Adafruit_INA237']]]
|
||||
];
|
||||
26
html/search/all_1.html
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html><head><title></title>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<link rel="stylesheet" type="text/css" href="search.css"/>
|
||||
<script type="text/javascript" src="all_1.js"></script>
|
||||
<script type="text/javascript" src="search.js"></script>
|
||||
</head>
|
||||
<body class="SRPage">
|
||||
<div id="SRIndex">
|
||||
<div class="SRStatus" id="Loading">Loading...</div>
|
||||
<div id="SRResults"></div>
|
||||
<script type="text/javascript"><!--
|
||||
createResults();
|
||||
--></script>
|
||||
<div class="SRStatus" id="Searching">Searching...</div>
|
||||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||||
<script type="text/javascript"><!--
|
||||
document.getElementById("Loading").style.display="none";
|
||||
document.getElementById("NoMatches").style.display="none";
|
||||
var searchResults = new SearchResults("searchResults");
|
||||
searchResults.Search();
|
||||
--></script>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
9
html/search/all_1.js
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
var searchData=
|
||||
[
|
||||
['adafruit_5fina237',['Adafruit_INA237',['../class_adafruit___i_n_a237.html',1,'Adafruit_INA237'],['../class_adafruit___i_n_a237.html#a00a593696b8d55749537bc6af8b69c48',1,'Adafruit_INA237::Adafruit_INA237()']]],
|
||||
['adafruit_5fina237_2ecpp',['Adafruit_INA237.cpp',['../_adafruit___i_n_a237_8cpp.html',1,'']]],
|
||||
['adafruit_5fina237_2eh',['Adafruit_INA237.h',['../_adafruit___i_n_a237_8h.html',1,'']]],
|
||||
['adafruit_5fina238',['Adafruit_INA238',['../class_adafruit___i_n_a238.html',1,'Adafruit_INA238'],['../class_adafruit___i_n_a238.html#a94012bdb08cb6868eb01496c4824e3c0',1,'Adafruit_INA238::Adafruit_INA238()']]],
|
||||
['adafruit_5fina238_2ecpp',['Adafruit_INA238.cpp',['../_adafruit___i_n_a238_8cpp.html',1,'']]],
|
||||
['adafruit_5fina238_2eh',['Adafruit_INA238.h',['../_adafruit___i_n_a238_8h.html',1,'']]]
|
||||
];
|
||||
26
html/search/all_2.html
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html><head><title></title>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<link rel="stylesheet" type="text/css" href="search.css"/>
|
||||
<script type="text/javascript" src="all_2.js"></script>
|
||||
<script type="text/javascript" src="search.js"></script>
|
||||
</head>
|
||||
<body class="SRPage">
|
||||
<div id="SRIndex">
|
||||
<div class="SRStatus" id="Loading">Loading...</div>
|
||||
<div id="SRResults"></div>
|
||||
<script type="text/javascript"><!--
|
||||
createResults();
|
||||
--></script>
|
||||
<div class="SRStatus" id="Searching">Searching...</div>
|
||||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||||
<script type="text/javascript"><!--
|
||||
document.getElementById("Loading").style.display="none";
|
||||
document.getElementById("NoMatches").style.display="none";
|
||||
var searchResults = new SearchResults("searchResults");
|
||||
searchResults.Search();
|
||||
--></script>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
4
html/search/all_2.js
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
var searchData=
|
||||
[
|
||||
['begin',['begin',['../class_adafruit___i_n_a237.html#a5b57c715d573272a487186edd4469e71',1,'Adafruit_INA237::begin()'],['../class_adafruit___i_n_a238.html#a419f14f55eb3aff12f7f9e63f5eaf9a1',1,'Adafruit_INA238::begin()']]]
|
||||
];
|
||||
26
html/search/all_3.html
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html><head><title></title>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<link rel="stylesheet" type="text/css" href="search.css"/>
|
||||
<script type="text/javascript" src="all_3.js"></script>
|
||||
<script type="text/javascript" src="search.js"></script>
|
||||
</head>
|
||||
<body class="SRPage">
|
||||
<div id="SRIndex">
|
||||
<div class="SRStatus" id="Loading">Loading...</div>
|
||||
<div id="SRResults"></div>
|
||||
<script type="text/javascript"><!--
|
||||
createResults();
|
||||
--></script>
|
||||
<div class="SRStatus" id="Searching">Searching...</div>
|
||||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||||
<script type="text/javascript"><!--
|
||||
document.getElementById("Loading").style.display="none";
|
||||
document.getElementById("NoMatches").style.display="none";
|
||||
var searchResults = new SearchResults("searchResults");
|
||||
searchResults.Search();
|
||||
--></script>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
4
html/search/all_3.js
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
var searchData=
|
||||
[
|
||||
['getalerttype',['getAlertType',['../class_adafruit___i_n_a237.html#a838055b7f33554847d78d6bcc1d8f96f',1,'Adafruit_INA237']]]
|
||||
];
|
||||
26
html/search/all_4.html
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html><head><title></title>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<link rel="stylesheet" type="text/css" href="search.css"/>
|
||||
<script type="text/javascript" src="all_4.js"></script>
|
||||
<script type="text/javascript" src="search.js"></script>
|
||||
</head>
|
||||
<body class="SRPage">
|
||||
<div id="SRIndex">
|
||||
<div class="SRStatus" id="Loading">Loading...</div>
|
||||
<div id="SRResults"></div>
|
||||
<script type="text/javascript"><!--
|
||||
createResults();
|
||||
--></script>
|
||||
<div class="SRStatus" id="Searching">Searching...</div>
|
||||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||||
<script type="text/javascript"><!--
|
||||
document.getElementById("Loading").style.display="none";
|
||||
document.getElementById("NoMatches").style.display="none";
|
||||
var searchResults = new SearchResults("searchResults");
|
||||
searchResults.Search();
|
||||
--></script>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
16
html/search/all_4.js
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
var searchData=
|
||||
[
|
||||
['ina237_5falert_5fconversion_5fready',['INA237_ALERT_CONVERSION_READY',['../_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6a12357c3d7f9932f9feede12f9038858d',1,'Adafruit_INA237.h']]],
|
||||
['ina237_5falert_5fnone',['INA237_ALERT_NONE',['../_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6a6c5adeed8029f07c9b5eee29dd4ef591',1,'Adafruit_INA237.h']]],
|
||||
['ina237_5falert_5foverpower',['INA237_ALERT_OVERPOWER',['../_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6aa9d3979bf691b9b09e07a298c71a7434',1,'Adafruit_INA237.h']]],
|
||||
['ina237_5falert_5fovershunt',['INA237_ALERT_OVERSHUNT',['../_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6a611c3fd1209b94a4cc500077ec132250',1,'Adafruit_INA237.h']]],
|
||||
['ina237_5falert_5fovertemperature',['INA237_ALERT_OVERTEMPERATURE',['../_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6a083d640626067b99cea2ae239b8056d7',1,'Adafruit_INA237.h']]],
|
||||
['ina237_5falert_5fovervoltage',['INA237_ALERT_OVERVOLTAGE',['../_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6acca068883a24e45cc0229ce3d88863f0',1,'Adafruit_INA237.h']]],
|
||||
['ina237_5falert_5fundershunt',['INA237_ALERT_UNDERSHUNT',['../_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6a442a01c1321b6e2f7948667fa8c3d141',1,'Adafruit_INA237.h']]],
|
||||
['ina237_5falert_5fundervoltage',['INA237_ALERT_UNDERVOLTAGE',['../_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6ab4f7d16e99928e74e199f22ff40fba0c',1,'Adafruit_INA237.h']]],
|
||||
['ina237_5falerttype',['INA237_AlertType',['../_adafruit___i_n_a237_8h.html#a1c988ddedc2786e59aca503b313b0724',1,'Adafruit_INA237.h']]],
|
||||
['ina237_5fdevice_5fid',['INA237_DEVICE_ID',['../_adafruit___i_n_a237_8h.html#ae0504710b4239c77874e0757b11a200f',1,'Adafruit_INA237.h']]],
|
||||
['ina237_5fi2caddr_5fdefault',['INA237_I2CADDR_DEFAULT',['../_adafruit___i_n_a237_8h.html#a9177aab49a4aa471df9745486905a18b',1,'Adafruit_INA237.h']]],
|
||||
['ina238_5fdevice_5fid',['INA238_DEVICE_ID',['../_adafruit___i_n_a237_8h.html#ac12c78da9272fb94981fa6ec77f5f22a',1,'INA238_DEVICE_ID(): Adafruit_INA237.h'],['../_adafruit___i_n_a238_8h.html#ac12c78da9272fb94981fa6ec77f5f22a',1,'INA238_DEVICE_ID(): Adafruit_INA238.h']]],
|
||||
['ina238_5fi2caddr_5fdefault',['INA238_I2CADDR_DEFAULT',['../_adafruit___i_n_a238_8h.html#aff39b25047564f1595d512422c428a60',1,'Adafruit_INA238.h']]]
|
||||
];
|
||||
26
html/search/all_5.html
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html><head><title></title>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<link rel="stylesheet" type="text/css" href="search.css"/>
|
||||
<script type="text/javascript" src="all_5.js"></script>
|
||||
<script type="text/javascript" src="search.js"></script>
|
||||
</head>
|
||||
<body class="SRPage">
|
||||
<div id="SRIndex">
|
||||
<div class="SRStatus" id="Loading">Loading...</div>
|
||||
<div id="SRResults"></div>
|
||||
<script type="text/javascript"><!--
|
||||
createResults();
|
||||
--></script>
|
||||
<div class="SRStatus" id="Searching">Searching...</div>
|
||||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||||
<script type="text/javascript"><!--
|
||||
document.getElementById("Loading").style.display="none";
|
||||
document.getElementById("NoMatches").style.display="none";
|
||||
var searchResults = new SearchResults("searchResults");
|
||||
searchResults.Search();
|
||||
--></script>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
8
html/search/all_5.js
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
var searchData=
|
||||
[
|
||||
['readbusvoltage',['readBusVoltage',['../class_adafruit___i_n_a237.html#a64e9ad6f47c561fe08352f7ed4b924b1',1,'Adafruit_INA237']]],
|
||||
['readcurrent',['readCurrent',['../class_adafruit___i_n_a237.html#abc259e72a96b712f12058a500e53b064',1,'Adafruit_INA237']]],
|
||||
['readdietemp',['readDieTemp',['../class_adafruit___i_n_a237.html#ab1e34a67d118bca72df89749bad07ee4',1,'Adafruit_INA237']]],
|
||||
['readpower',['readPower',['../class_adafruit___i_n_a237.html#a78c43dfbbd2257050ea35fcdb7ebfabb',1,'Adafruit_INA237']]],
|
||||
['readshuntvoltage',['readShuntVoltage',['../class_adafruit___i_n_a237.html#a7a6e4eb322f25f8d390e4f4a7af62bca',1,'Adafruit_INA237']]]
|
||||
];
|
||||
26
html/search/all_6.html
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html><head><title></title>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<link rel="stylesheet" type="text/css" href="search.css"/>
|
||||
<script type="text/javascript" src="all_6.js"></script>
|
||||
<script type="text/javascript" src="search.js"></script>
|
||||
</head>
|
||||
<body class="SRPage">
|
||||
<div id="SRIndex">
|
||||
<div class="SRStatus" id="Loading">Loading...</div>
|
||||
<div id="SRResults"></div>
|
||||
<script type="text/javascript"><!--
|
||||
createResults();
|
||||
--></script>
|
||||
<div class="SRStatus" id="Searching">Searching...</div>
|
||||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||||
<script type="text/javascript"><!--
|
||||
document.getElementById("Loading").style.display="none";
|
||||
document.getElementById("NoMatches").style.display="none";
|
||||
var searchResults = new SearchResults("searchResults");
|
||||
searchResults.Search();
|
||||
--></script>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
5
html/search/all_6.js
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
var searchData=
|
||||
[
|
||||
['setalerttype',['setAlertType',['../class_adafruit___i_n_a237.html#a11d973a1c34188e0651566ea0bf15018',1,'Adafruit_INA237']]],
|
||||
['setshunt',['setShunt',['../class_adafruit___i_n_a237.html#a6c17e64857065843706a46ccc80797a8',1,'Adafruit_INA237']]]
|
||||
];
|
||||
26
html/search/classes_0.html
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html><head><title></title>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<link rel="stylesheet" type="text/css" href="search.css"/>
|
||||
<script type="text/javascript" src="classes_0.js"></script>
|
||||
<script type="text/javascript" src="search.js"></script>
|
||||
</head>
|
||||
<body class="SRPage">
|
||||
<div id="SRIndex">
|
||||
<div class="SRStatus" id="Loading">Loading...</div>
|
||||
<div id="SRResults"></div>
|
||||
<script type="text/javascript"><!--
|
||||
createResults();
|
||||
--></script>
|
||||
<div class="SRStatus" id="Searching">Searching...</div>
|
||||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||||
<script type="text/javascript"><!--
|
||||
document.getElementById("Loading").style.display="none";
|
||||
document.getElementById("NoMatches").style.display="none";
|
||||
var searchResults = new SearchResults("searchResults");
|
||||
searchResults.Search();
|
||||
--></script>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
5
html/search/classes_0.js
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
var searchData=
|
||||
[
|
||||
['adafruit_5fina237',['Adafruit_INA237',['../class_adafruit___i_n_a237.html',1,'']]],
|
||||
['adafruit_5fina238',['Adafruit_INA238',['../class_adafruit___i_n_a238.html',1,'']]]
|
||||
];
|
||||
BIN
html/search/close.png
Normal file
|
After Width: | Height: | Size: 273 B |
26
html/search/defines_0.html
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html><head><title></title>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<link rel="stylesheet" type="text/css" href="search.css"/>
|
||||
<script type="text/javascript" src="defines_0.js"></script>
|
||||
<script type="text/javascript" src="search.js"></script>
|
||||
</head>
|
||||
<body class="SRPage">
|
||||
<div id="SRIndex">
|
||||
<div class="SRStatus" id="Loading">Loading...</div>
|
||||
<div id="SRResults"></div>
|
||||
<script type="text/javascript"><!--
|
||||
createResults();
|
||||
--></script>
|
||||
<div class="SRStatus" id="Searching">Searching...</div>
|
||||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||||
<script type="text/javascript"><!--
|
||||
document.getElementById("Loading").style.display="none";
|
||||
document.getElementById("NoMatches").style.display="none";
|
||||
var searchResults = new SearchResults("searchResults");
|
||||
searchResults.Search();
|
||||
--></script>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
7
html/search/defines_0.js
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
var searchData=
|
||||
[
|
||||
['ina237_5fdevice_5fid',['INA237_DEVICE_ID',['../_adafruit___i_n_a237_8h.html#ae0504710b4239c77874e0757b11a200f',1,'Adafruit_INA237.h']]],
|
||||
['ina237_5fi2caddr_5fdefault',['INA237_I2CADDR_DEFAULT',['../_adafruit___i_n_a237_8h.html#a9177aab49a4aa471df9745486905a18b',1,'Adafruit_INA237.h']]],
|
||||
['ina238_5fdevice_5fid',['INA238_DEVICE_ID',['../_adafruit___i_n_a237_8h.html#ac12c78da9272fb94981fa6ec77f5f22a',1,'INA238_DEVICE_ID(): Adafruit_INA237.h'],['../_adafruit___i_n_a238_8h.html#ac12c78da9272fb94981fa6ec77f5f22a',1,'INA238_DEVICE_ID(): Adafruit_INA238.h']]],
|
||||
['ina238_5fi2caddr_5fdefault',['INA238_I2CADDR_DEFAULT',['../_adafruit___i_n_a238_8h.html#aff39b25047564f1595d512422c428a60',1,'Adafruit_INA238.h']]]
|
||||
];
|
||||
26
html/search/enums_0.html
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html><head><title></title>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<link rel="stylesheet" type="text/css" href="search.css"/>
|
||||
<script type="text/javascript" src="enums_0.js"></script>
|
||||
<script type="text/javascript" src="search.js"></script>
|
||||
</head>
|
||||
<body class="SRPage">
|
||||
<div id="SRIndex">
|
||||
<div class="SRStatus" id="Loading">Loading...</div>
|
||||
<div id="SRResults"></div>
|
||||
<script type="text/javascript"><!--
|
||||
createResults();
|
||||
--></script>
|
||||
<div class="SRStatus" id="Searching">Searching...</div>
|
||||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||||
<script type="text/javascript"><!--
|
||||
document.getElementById("Loading").style.display="none";
|
||||
document.getElementById("NoMatches").style.display="none";
|
||||
var searchResults = new SearchResults("searchResults");
|
||||
searchResults.Search();
|
||||
--></script>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
4
html/search/enums_0.js
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
var searchData=
|
||||
[
|
||||
['_5fina237_5falert_5ftype',['_ina237_alert_type',['../_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6',1,'Adafruit_INA237.h']]]
|
||||
];
|
||||
26
html/search/enumvalues_0.html
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html><head><title></title>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<link rel="stylesheet" type="text/css" href="search.css"/>
|
||||
<script type="text/javascript" src="enumvalues_0.js"></script>
|
||||
<script type="text/javascript" src="search.js"></script>
|
||||
</head>
|
||||
<body class="SRPage">
|
||||
<div id="SRIndex">
|
||||
<div class="SRStatus" id="Loading">Loading...</div>
|
||||
<div id="SRResults"></div>
|
||||
<script type="text/javascript"><!--
|
||||
createResults();
|
||||
--></script>
|
||||
<div class="SRStatus" id="Searching">Searching...</div>
|
||||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||||
<script type="text/javascript"><!--
|
||||
document.getElementById("Loading").style.display="none";
|
||||
document.getElementById("NoMatches").style.display="none";
|
||||
var searchResults = new SearchResults("searchResults");
|
||||
searchResults.Search();
|
||||
--></script>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
11
html/search/enumvalues_0.js
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
var searchData=
|
||||
[
|
||||
['ina237_5falert_5fconversion_5fready',['INA237_ALERT_CONVERSION_READY',['../_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6a12357c3d7f9932f9feede12f9038858d',1,'Adafruit_INA237.h']]],
|
||||
['ina237_5falert_5fnone',['INA237_ALERT_NONE',['../_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6a6c5adeed8029f07c9b5eee29dd4ef591',1,'Adafruit_INA237.h']]],
|
||||
['ina237_5falert_5foverpower',['INA237_ALERT_OVERPOWER',['../_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6aa9d3979bf691b9b09e07a298c71a7434',1,'Adafruit_INA237.h']]],
|
||||
['ina237_5falert_5fovershunt',['INA237_ALERT_OVERSHUNT',['../_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6a611c3fd1209b94a4cc500077ec132250',1,'Adafruit_INA237.h']]],
|
||||
['ina237_5falert_5fovertemperature',['INA237_ALERT_OVERTEMPERATURE',['../_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6a083d640626067b99cea2ae239b8056d7',1,'Adafruit_INA237.h']]],
|
||||
['ina237_5falert_5fovervoltage',['INA237_ALERT_OVERVOLTAGE',['../_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6acca068883a24e45cc0229ce3d88863f0',1,'Adafruit_INA237.h']]],
|
||||
['ina237_5falert_5fundershunt',['INA237_ALERT_UNDERSHUNT',['../_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6a442a01c1321b6e2f7948667fa8c3d141',1,'Adafruit_INA237.h']]],
|
||||
['ina237_5falert_5fundervoltage',['INA237_ALERT_UNDERVOLTAGE',['../_adafruit___i_n_a237_8h.html#aa7613d25bd97136a2b9be3859c22d1c6ab4f7d16e99928e74e199f22ff40fba0c',1,'Adafruit_INA237.h']]]
|
||||
];
|
||||
26
html/search/files_0.html
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html><head><title></title>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<link rel="stylesheet" type="text/css" href="search.css"/>
|
||||
<script type="text/javascript" src="files_0.js"></script>
|
||||
<script type="text/javascript" src="search.js"></script>
|
||||
</head>
|
||||
<body class="SRPage">
|
||||
<div id="SRIndex">
|
||||
<div class="SRStatus" id="Loading">Loading...</div>
|
||||
<div id="SRResults"></div>
|
||||
<script type="text/javascript"><!--
|
||||
createResults();
|
||||
--></script>
|
||||
<div class="SRStatus" id="Searching">Searching...</div>
|
||||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||||
<script type="text/javascript"><!--
|
||||
document.getElementById("Loading").style.display="none";
|
||||
document.getElementById("NoMatches").style.display="none";
|
||||
var searchResults = new SearchResults("searchResults");
|
||||
searchResults.Search();
|
||||
--></script>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
7
html/search/files_0.js
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
var searchData=
|
||||
[
|
||||
['adafruit_5fina237_2ecpp',['Adafruit_INA237.cpp',['../_adafruit___i_n_a237_8cpp.html',1,'']]],
|
||||
['adafruit_5fina237_2eh',['Adafruit_INA237.h',['../_adafruit___i_n_a237_8h.html',1,'']]],
|
||||
['adafruit_5fina238_2ecpp',['Adafruit_INA238.cpp',['../_adafruit___i_n_a238_8cpp.html',1,'']]],
|
||||
['adafruit_5fina238_2eh',['Adafruit_INA238.h',['../_adafruit___i_n_a238_8h.html',1,'']]]
|
||||
];
|
||||
26
html/search/functions_0.html
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html><head><title></title>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<link rel="stylesheet" type="text/css" href="search.css"/>
|
||||
<script type="text/javascript" src="functions_0.js"></script>
|
||||
<script type="text/javascript" src="search.js"></script>
|
||||
</head>
|
||||
<body class="SRPage">
|
||||
<div id="SRIndex">
|
||||
<div class="SRStatus" id="Loading">Loading...</div>
|
||||
<div id="SRResults"></div>
|
||||
<script type="text/javascript"><!--
|
||||
createResults();
|
||||
--></script>
|
||||
<div class="SRStatus" id="Searching">Searching...</div>
|
||||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||||
<script type="text/javascript"><!--
|
||||
document.getElementById("Loading").style.display="none";
|
||||
document.getElementById("NoMatches").style.display="none";
|
||||
var searchResults = new SearchResults("searchResults");
|
||||
searchResults.Search();
|
||||
--></script>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
4
html/search/functions_0.js
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
var searchData=
|
||||
[
|
||||
['_5fupdateshuntcalregister',['_updateShuntCalRegister',['../class_adafruit___i_n_a237.html#af4e10e12e0d94a5c725aa26aa984dd09',1,'Adafruit_INA237']]]
|
||||
];
|
||||
26
html/search/functions_1.html
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html><head><title></title>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<link rel="stylesheet" type="text/css" href="search.css"/>
|
||||
<script type="text/javascript" src="functions_1.js"></script>
|
||||
<script type="text/javascript" src="search.js"></script>
|
||||
</head>
|
||||
<body class="SRPage">
|
||||
<div id="SRIndex">
|
||||
<div class="SRStatus" id="Loading">Loading...</div>
|
||||
<div id="SRResults"></div>
|
||||
<script type="text/javascript"><!--
|
||||
createResults();
|
||||
--></script>
|
||||
<div class="SRStatus" id="Searching">Searching...</div>
|
||||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||||
<script type="text/javascript"><!--
|
||||
document.getElementById("Loading").style.display="none";
|
||||
document.getElementById("NoMatches").style.display="none";
|
||||
var searchResults = new SearchResults("searchResults");
|
||||
searchResults.Search();
|
||||
--></script>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
5
html/search/functions_1.js
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
var searchData=
|
||||
[
|
||||
['adafruit_5fina237',['Adafruit_INA237',['../class_adafruit___i_n_a237.html#a00a593696b8d55749537bc6af8b69c48',1,'Adafruit_INA237']]],
|
||||
['adafruit_5fina238',['Adafruit_INA238',['../class_adafruit___i_n_a238.html#a94012bdb08cb6868eb01496c4824e3c0',1,'Adafruit_INA238']]]
|
||||
];
|
||||
26
html/search/functions_2.html
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html><head><title></title>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<link rel="stylesheet" type="text/css" href="search.css"/>
|
||||
<script type="text/javascript" src="functions_2.js"></script>
|
||||
<script type="text/javascript" src="search.js"></script>
|
||||
</head>
|
||||
<body class="SRPage">
|
||||
<div id="SRIndex">
|
||||
<div class="SRStatus" id="Loading">Loading...</div>
|
||||
<div id="SRResults"></div>
|
||||
<script type="text/javascript"><!--
|
||||
createResults();
|
||||
--></script>
|
||||
<div class="SRStatus" id="Searching">Searching...</div>
|
||||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||||
<script type="text/javascript"><!--
|
||||
document.getElementById("Loading").style.display="none";
|
||||
document.getElementById("NoMatches").style.display="none";
|
||||
var searchResults = new SearchResults("searchResults");
|
||||
searchResults.Search();
|
||||
--></script>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
4
html/search/functions_2.js
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
var searchData=
|
||||
[
|
||||
['begin',['begin',['../class_adafruit___i_n_a237.html#a5b57c715d573272a487186edd4469e71',1,'Adafruit_INA237::begin()'],['../class_adafruit___i_n_a238.html#a419f14f55eb3aff12f7f9e63f5eaf9a1',1,'Adafruit_INA238::begin()']]]
|
||||
];
|
||||
26
html/search/functions_3.html
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html><head><title></title>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<link rel="stylesheet" type="text/css" href="search.css"/>
|
||||
<script type="text/javascript" src="functions_3.js"></script>
|
||||
<script type="text/javascript" src="search.js"></script>
|
||||
</head>
|
||||
<body class="SRPage">
|
||||
<div id="SRIndex">
|
||||
<div class="SRStatus" id="Loading">Loading...</div>
|
||||
<div id="SRResults"></div>
|
||||
<script type="text/javascript"><!--
|
||||
createResults();
|
||||
--></script>
|
||||
<div class="SRStatus" id="Searching">Searching...</div>
|
||||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||||
<script type="text/javascript"><!--
|
||||
document.getElementById("Loading").style.display="none";
|
||||
document.getElementById("NoMatches").style.display="none";
|
||||
var searchResults = new SearchResults("searchResults");
|
||||
searchResults.Search();
|
||||
--></script>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
4
html/search/functions_3.js
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
var searchData=
|
||||
[
|
||||
['getalerttype',['getAlertType',['../class_adafruit___i_n_a237.html#a838055b7f33554847d78d6bcc1d8f96f',1,'Adafruit_INA237']]]
|
||||
];
|
||||
26
html/search/functions_4.html
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html><head><title></title>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<link rel="stylesheet" type="text/css" href="search.css"/>
|
||||
<script type="text/javascript" src="functions_4.js"></script>
|
||||
<script type="text/javascript" src="search.js"></script>
|
||||
</head>
|
||||
<body class="SRPage">
|
||||
<div id="SRIndex">
|
||||
<div class="SRStatus" id="Loading">Loading...</div>
|
||||
<div id="SRResults"></div>
|
||||
<script type="text/javascript"><!--
|
||||
createResults();
|
||||
--></script>
|
||||
<div class="SRStatus" id="Searching">Searching...</div>
|
||||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||||
<script type="text/javascript"><!--
|
||||
document.getElementById("Loading").style.display="none";
|
||||
document.getElementById("NoMatches").style.display="none";
|
||||
var searchResults = new SearchResults("searchResults");
|
||||
searchResults.Search();
|
||||
--></script>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
8
html/search/functions_4.js
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
var searchData=
|
||||
[
|
||||
['readbusvoltage',['readBusVoltage',['../class_adafruit___i_n_a237.html#a64e9ad6f47c561fe08352f7ed4b924b1',1,'Adafruit_INA237']]],
|
||||
['readcurrent',['readCurrent',['../class_adafruit___i_n_a237.html#abc259e72a96b712f12058a500e53b064',1,'Adafruit_INA237']]],
|
||||
['readdietemp',['readDieTemp',['../class_adafruit___i_n_a237.html#ab1e34a67d118bca72df89749bad07ee4',1,'Adafruit_INA237']]],
|
||||
['readpower',['readPower',['../class_adafruit___i_n_a237.html#a78c43dfbbd2257050ea35fcdb7ebfabb',1,'Adafruit_INA237']]],
|
||||
['readshuntvoltage',['readShuntVoltage',['../class_adafruit___i_n_a237.html#a7a6e4eb322f25f8d390e4f4a7af62bca',1,'Adafruit_INA237']]]
|
||||
];
|
||||
26
html/search/functions_5.html
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html><head><title></title>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<link rel="stylesheet" type="text/css" href="search.css"/>
|
||||
<script type="text/javascript" src="functions_5.js"></script>
|
||||
<script type="text/javascript" src="search.js"></script>
|
||||
</head>
|
||||
<body class="SRPage">
|
||||
<div id="SRIndex">
|
||||
<div class="SRStatus" id="Loading">Loading...</div>
|
||||
<div id="SRResults"></div>
|
||||
<script type="text/javascript"><!--
|
||||
createResults();
|
||||
--></script>
|
||||
<div class="SRStatus" id="Searching">Searching...</div>
|
||||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||||
<script type="text/javascript"><!--
|
||||
document.getElementById("Loading").style.display="none";
|
||||
document.getElementById("NoMatches").style.display="none";
|
||||
var searchResults = new SearchResults("searchResults");
|
||||
searchResults.Search();
|
||||
--></script>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
5
html/search/functions_5.js
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
var searchData=
|
||||
[
|
||||
['setalerttype',['setAlertType',['../class_adafruit___i_n_a237.html#a11d973a1c34188e0651566ea0bf15018',1,'Adafruit_INA237']]],
|
||||
['setshunt',['setShunt',['../class_adafruit___i_n_a237.html#a6c17e64857065843706a46ccc80797a8',1,'Adafruit_INA237']]]
|
||||
];
|
||||
BIN
html/search/mag_sel.png
Normal file
|
After Width: | Height: | Size: 563 B |
12
html/search/nomatches.html
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html><head><title></title>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<link rel="stylesheet" type="text/css" href="search.css"/>
|
||||
<script type="text/javascript" src="search.js"></script>
|
||||
</head>
|
||||
<body class="SRPage">
|
||||
<div id="SRIndex">
|
||||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
271
html/search/search.css
Normal file
|
|
@ -0,0 +1,271 @@
|
|||
/*---------------- Search Box */
|
||||
|
||||
#FSearchBox {
|
||||
float: left;
|
||||
}
|
||||
|
||||
#MSearchBox {
|
||||
white-space : nowrap;
|
||||
float: none;
|
||||
margin-top: 8px;
|
||||
right: 0px;
|
||||
width: 170px;
|
||||
height: 24px;
|
||||
z-index: 102;
|
||||
}
|
||||
|
||||
#MSearchBox .left
|
||||
{
|
||||
display:block;
|
||||
position:absolute;
|
||||
left:10px;
|
||||
width:20px;
|
||||
height:19px;
|
||||
background:url('search_l.png') no-repeat;
|
||||
background-position:right;
|
||||
}
|
||||
|
||||
#MSearchSelect {
|
||||
display:block;
|
||||
position:absolute;
|
||||
width:20px;
|
||||
height:19px;
|
||||
}
|
||||
|
||||
.left #MSearchSelect {
|
||||
left:4px;
|
||||
}
|
||||
|
||||
.right #MSearchSelect {
|
||||
right:5px;
|
||||
}
|
||||
|
||||
#MSearchField {
|
||||
display:block;
|
||||
position:absolute;
|
||||
height:19px;
|
||||
background:url('search_m.png') repeat-x;
|
||||
border:none;
|
||||
width:115px;
|
||||
margin-left:20px;
|
||||
padding-left:4px;
|
||||
color: #909090;
|
||||
outline: none;
|
||||
font: 9pt Arial, Verdana, sans-serif;
|
||||
-webkit-border-radius: 0px;
|
||||
}
|
||||
|
||||
#FSearchBox #MSearchField {
|
||||
margin-left:15px;
|
||||
}
|
||||
|
||||
#MSearchBox .right {
|
||||
display:block;
|
||||
position:absolute;
|
||||
right:10px;
|
||||
top:8px;
|
||||
width:20px;
|
||||
height:19px;
|
||||
background:url('search_r.png') no-repeat;
|
||||
background-position:left;
|
||||
}
|
||||
|
||||
#MSearchClose {
|
||||
display: none;
|
||||
position: absolute;
|
||||
top: 4px;
|
||||
background : none;
|
||||
border: none;
|
||||
margin: 0px 4px 0px 0px;
|
||||
padding: 0px 0px;
|
||||
outline: none;
|
||||
}
|
||||
|
||||
.left #MSearchClose {
|
||||
left: 6px;
|
||||
}
|
||||
|
||||
.right #MSearchClose {
|
||||
right: 2px;
|
||||
}
|
||||
|
||||
.MSearchBoxActive #MSearchField {
|
||||
color: #000000;
|
||||
}
|
||||
|
||||
/*---------------- Search filter selection */
|
||||
|
||||
#MSearchSelectWindow {
|
||||
display: none;
|
||||
position: absolute;
|
||||
left: 0; top: 0;
|
||||
border: 1px solid #90A5CE;
|
||||
background-color: #F9FAFC;
|
||||
z-index: 10001;
|
||||
padding-top: 4px;
|
||||
padding-bottom: 4px;
|
||||
-moz-border-radius: 4px;
|
||||
-webkit-border-top-left-radius: 4px;
|
||||
-webkit-border-top-right-radius: 4px;
|
||||
-webkit-border-bottom-left-radius: 4px;
|
||||
-webkit-border-bottom-right-radius: 4px;
|
||||
-webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
|
||||
}
|
||||
|
||||
.SelectItem {
|
||||
font: 8pt Arial, Verdana, sans-serif;
|
||||
padding-left: 2px;
|
||||
padding-right: 12px;
|
||||
border: 0px;
|
||||
}
|
||||
|
||||
span.SelectionMark {
|
||||
margin-right: 4px;
|
||||
font-family: monospace;
|
||||
outline-style: none;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a.SelectItem {
|
||||
display: block;
|
||||
outline-style: none;
|
||||
color: #000000;
|
||||
text-decoration: none;
|
||||
padding-left: 6px;
|
||||
padding-right: 12px;
|
||||
}
|
||||
|
||||
a.SelectItem:focus,
|
||||
a.SelectItem:active {
|
||||
color: #000000;
|
||||
outline-style: none;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a.SelectItem:hover {
|
||||
color: #FFFFFF;
|
||||
background-color: #3D578C;
|
||||
outline-style: none;
|
||||
text-decoration: none;
|
||||
cursor: pointer;
|
||||
display: block;
|
||||
}
|
||||
|
||||
/*---------------- Search results window */
|
||||
|
||||
iframe#MSearchResults {
|
||||
width: 60ex;
|
||||
height: 15em;
|
||||
}
|
||||
|
||||
#MSearchResultsWindow {
|
||||
display: none;
|
||||
position: absolute;
|
||||
left: 0; top: 0;
|
||||
border: 1px solid #000;
|
||||
background-color: #EEF1F7;
|
||||
z-index:10000;
|
||||
}
|
||||
|
||||
/* ----------------------------------- */
|
||||
|
||||
|
||||
#SRIndex {
|
||||
clear:both;
|
||||
padding-bottom: 15px;
|
||||
}
|
||||
|
||||
.SREntry {
|
||||
font-size: 10pt;
|
||||
padding-left: 1ex;
|
||||
}
|
||||
|
||||
.SRPage .SREntry {
|
||||
font-size: 8pt;
|
||||
padding: 1px 5px;
|
||||
}
|
||||
|
||||
body.SRPage {
|
||||
margin: 5px 2px;
|
||||
}
|
||||
|
||||
.SRChildren {
|
||||
padding-left: 3ex; padding-bottom: .5em
|
||||
}
|
||||
|
||||
.SRPage .SRChildren {
|
||||
display: none;
|
||||
}
|
||||
|
||||
.SRSymbol {
|
||||
font-weight: bold;
|
||||
color: #425E97;
|
||||
font-family: Arial, Verdana, sans-serif;
|
||||
text-decoration: none;
|
||||
outline: none;
|
||||
}
|
||||
|
||||
a.SRScope {
|
||||
display: block;
|
||||
color: #425E97;
|
||||
font-family: Arial, Verdana, sans-serif;
|
||||
text-decoration: none;
|
||||
outline: none;
|
||||
}
|
||||
|
||||
a.SRSymbol:focus, a.SRSymbol:active,
|
||||
a.SRScope:focus, a.SRScope:active {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
span.SRScope {
|
||||
padding-left: 4px;
|
||||
}
|
||||
|
||||
.SRPage .SRStatus {
|
||||
padding: 2px 5px;
|
||||
font-size: 8pt;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
.SRResult {
|
||||
display: none;
|
||||
}
|
||||
|
||||
DIV.searchresults {
|
||||
margin-left: 10px;
|
||||
margin-right: 10px;
|
||||
}
|
||||
|
||||
/*---------------- External search page results */
|
||||
|
||||
.searchresult {
|
||||
background-color: #F0F3F8;
|
||||
}
|
||||
|
||||
.pages b {
|
||||
color: white;
|
||||
padding: 5px 5px 3px 5px;
|
||||
background-image: url("../tab_a.png");
|
||||
background-repeat: repeat-x;
|
||||
text-shadow: 0 1px 1px #000000;
|
||||
}
|
||||
|
||||
.pages {
|
||||
line-height: 17px;
|
||||
margin-left: 4px;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.hl {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
#searchresults {
|
||||
margin-bottom: 20px;
|
||||
}
|
||||
|
||||
.searchpages {
|
||||
margin-top: 10px;
|
||||
}
|
||||
|
||||
791
html/search/search.js
Normal file
|
|
@ -0,0 +1,791 @@
|
|||
function convertToId(search)
|
||||
{
|
||||
var result = '';
|
||||
for (i=0;i<search.length;i++)
|
||||
{
|
||||
var c = search.charAt(i);
|
||||
var cn = c.charCodeAt(0);
|
||||
if (c.match(/[a-z0-9\u0080-\uFFFF]/))
|
||||
{
|
||||
result+=c;
|
||||
}
|
||||
else if (cn<16)
|
||||
{
|
||||
result+="_0"+cn.toString(16);
|
||||
}
|
||||
else
|
||||
{
|
||||
result+="_"+cn.toString(16);
|
||||
}
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
function getXPos(item)
|
||||
{
|
||||
var x = 0;
|
||||
if (item.offsetWidth)
|
||||
{
|
||||
while (item && item!=document.body)
|
||||
{
|
||||
x += item.offsetLeft;
|
||||
item = item.offsetParent;
|
||||
}
|
||||
}
|
||||
return x;
|
||||
}
|
||||
|
||||
function getYPos(item)
|
||||
{
|
||||
var y = 0;
|
||||
if (item.offsetWidth)
|
||||
{
|
||||
while (item && item!=document.body)
|
||||
{
|
||||
y += item.offsetTop;
|
||||
item = item.offsetParent;
|
||||
}
|
||||
}
|
||||
return y;
|
||||
}
|
||||
|
||||
/* A class handling everything associated with the search panel.
|
||||
|
||||
Parameters:
|
||||
name - The name of the global variable that will be
|
||||
storing this instance. Is needed to be able to set timeouts.
|
||||
resultPath - path to use for external files
|
||||
*/
|
||||
function SearchBox(name, resultsPath, inFrame, label)
|
||||
{
|
||||
if (!name || !resultsPath) { alert("Missing parameters to SearchBox."); }
|
||||
|
||||
// ---------- Instance variables
|
||||
this.name = name;
|
||||
this.resultsPath = resultsPath;
|
||||
this.keyTimeout = 0;
|
||||
this.keyTimeoutLength = 500;
|
||||
this.closeSelectionTimeout = 300;
|
||||
this.lastSearchValue = "";
|
||||
this.lastResultsPage = "";
|
||||
this.hideTimeout = 0;
|
||||
this.searchIndex = 0;
|
||||
this.searchActive = false;
|
||||
this.insideFrame = inFrame;
|
||||
this.searchLabel = label;
|
||||
|
||||
// ----------- DOM Elements
|
||||
|
||||
this.DOMSearchField = function()
|
||||
{ return document.getElementById("MSearchField"); }
|
||||
|
||||
this.DOMSearchSelect = function()
|
||||
{ return document.getElementById("MSearchSelect"); }
|
||||
|
||||
this.DOMSearchSelectWindow = function()
|
||||
{ return document.getElementById("MSearchSelectWindow"); }
|
||||
|
||||
this.DOMPopupSearchResults = function()
|
||||
{ return document.getElementById("MSearchResults"); }
|
||||
|
||||
this.DOMPopupSearchResultsWindow = function()
|
||||
{ return document.getElementById("MSearchResultsWindow"); }
|
||||
|
||||
this.DOMSearchClose = function()
|
||||
{ return document.getElementById("MSearchClose"); }
|
||||
|
||||
this.DOMSearchBox = function()
|
||||
{ return document.getElementById("MSearchBox"); }
|
||||
|
||||
// ------------ Event Handlers
|
||||
|
||||
// Called when focus is added or removed from the search field.
|
||||
this.OnSearchFieldFocus = function(isActive)
|
||||
{
|
||||
this.Activate(isActive);
|
||||
}
|
||||
|
||||
this.OnSearchSelectShow = function()
|
||||
{
|
||||
var searchSelectWindow = this.DOMSearchSelectWindow();
|
||||
var searchField = this.DOMSearchSelect();
|
||||
|
||||
if (this.insideFrame)
|
||||
{
|
||||
var left = getXPos(searchField);
|
||||
var top = getYPos(searchField);
|
||||
left += searchField.offsetWidth + 6;
|
||||
top += searchField.offsetHeight;
|
||||
|
||||
// show search selection popup
|
||||
searchSelectWindow.style.display='block';
|
||||
left -= searchSelectWindow.offsetWidth;
|
||||
searchSelectWindow.style.left = left + 'px';
|
||||
searchSelectWindow.style.top = top + 'px';
|
||||
}
|
||||
else
|
||||
{
|
||||
var left = getXPos(searchField);
|
||||
var top = getYPos(searchField);
|
||||
top += searchField.offsetHeight;
|
||||
|
||||
// show search selection popup
|
||||
searchSelectWindow.style.display='block';
|
||||
searchSelectWindow.style.left = left + 'px';
|
||||
searchSelectWindow.style.top = top + 'px';
|
||||
}
|
||||
|
||||
// stop selection hide timer
|
||||
if (this.hideTimeout)
|
||||
{
|
||||
clearTimeout(this.hideTimeout);
|
||||
this.hideTimeout=0;
|
||||
}
|
||||
return false; // to avoid "image drag" default event
|
||||
}
|
||||
|
||||
this.OnSearchSelectHide = function()
|
||||
{
|
||||
this.hideTimeout = setTimeout(this.name +".CloseSelectionWindow()",
|
||||
this.closeSelectionTimeout);
|
||||
}
|
||||
|
||||
// Called when the content of the search field is changed.
|
||||
this.OnSearchFieldChange = function(evt)
|
||||
{
|
||||
if (this.keyTimeout) // kill running timer
|
||||
{
|
||||
clearTimeout(this.keyTimeout);
|
||||
this.keyTimeout = 0;
|
||||
}
|
||||
|
||||
var e = (evt) ? evt : window.event; // for IE
|
||||
if (e.keyCode==40 || e.keyCode==13)
|
||||
{
|
||||
if (e.shiftKey==1)
|
||||
{
|
||||
this.OnSearchSelectShow();
|
||||
var win=this.DOMSearchSelectWindow();
|
||||
for (i=0;i<win.childNodes.length;i++)
|
||||
{
|
||||
var child = win.childNodes[i]; // get span within a
|
||||
if (child.className=='SelectItem')
|
||||
{
|
||||
child.focus();
|
||||
return;
|
||||
}
|
||||
}
|
||||
return;
|
||||
}
|
||||
else if (window.frames.MSearchResults.searchResults)
|
||||
{
|
||||
var elem = window.frames.MSearchResults.searchResults.NavNext(0);
|
||||
if (elem) elem.focus();
|
||||
}
|
||||
}
|
||||
else if (e.keyCode==27) // Escape out of the search field
|
||||
{
|
||||
this.DOMSearchField().blur();
|
||||
this.DOMPopupSearchResultsWindow().style.display = 'none';
|
||||
this.DOMSearchClose().style.display = 'none';
|
||||
this.lastSearchValue = '';
|
||||
this.Activate(false);
|
||||
return;
|
||||
}
|
||||
|
||||
// strip whitespaces
|
||||
var searchValue = this.DOMSearchField().value.replace(/ +/g, "");
|
||||
|
||||
if (searchValue != this.lastSearchValue) // search value has changed
|
||||
{
|
||||
if (searchValue != "") // non-empty search
|
||||
{
|
||||
// set timer for search update
|
||||
this.keyTimeout = setTimeout(this.name + '.Search()',
|
||||
this.keyTimeoutLength);
|
||||
}
|
||||
else // empty search field
|
||||
{
|
||||
this.DOMPopupSearchResultsWindow().style.display = 'none';
|
||||
this.DOMSearchClose().style.display = 'none';
|
||||
this.lastSearchValue = '';
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
this.SelectItemCount = function(id)
|
||||
{
|
||||
var count=0;
|
||||
var win=this.DOMSearchSelectWindow();
|
||||
for (i=0;i<win.childNodes.length;i++)
|
||||
{
|
||||
var child = win.childNodes[i]; // get span within a
|
||||
if (child.className=='SelectItem')
|
||||
{
|
||||
count++;
|
||||
}
|
||||
}
|
||||
return count;
|
||||
}
|
||||
|
||||
this.SelectItemSet = function(id)
|
||||
{
|
||||
var i,j=0;
|
||||
var win=this.DOMSearchSelectWindow();
|
||||
for (i=0;i<win.childNodes.length;i++)
|
||||
{
|
||||
var child = win.childNodes[i]; // get span within a
|
||||
if (child.className=='SelectItem')
|
||||
{
|
||||
var node = child.firstChild;
|
||||
if (j==id)
|
||||
{
|
||||
node.innerHTML='•';
|
||||
}
|
||||
else
|
||||
{
|
||||
node.innerHTML=' ';
|
||||
}
|
||||
j++;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Called when an search filter selection is made.
|
||||
// set item with index id as the active item
|
||||
this.OnSelectItem = function(id)
|
||||
{
|
||||
this.searchIndex = id;
|
||||
this.SelectItemSet(id);
|
||||
var searchValue = this.DOMSearchField().value.replace(/ +/g, "");
|
||||
if (searchValue!="" && this.searchActive) // something was found -> do a search
|
||||
{
|
||||
this.Search();
|
||||
}
|
||||
}
|
||||
|
||||
this.OnSearchSelectKey = function(evt)
|
||||
{
|
||||
var e = (evt) ? evt : window.event; // for IE
|
||||
if (e.keyCode==40 && this.searchIndex<this.SelectItemCount()) // Down
|
||||
{
|
||||
this.searchIndex++;
|
||||
this.OnSelectItem(this.searchIndex);
|
||||
}
|
||||
else if (e.keyCode==38 && this.searchIndex>0) // Up
|
||||
{
|
||||
this.searchIndex--;
|
||||
this.OnSelectItem(this.searchIndex);
|
||||
}
|
||||
else if (e.keyCode==13 || e.keyCode==27)
|
||||
{
|
||||
this.OnSelectItem(this.searchIndex);
|
||||
this.CloseSelectionWindow();
|
||||
this.DOMSearchField().focus();
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
// --------- Actions
|
||||
|
||||
// Closes the results window.
|
||||
this.CloseResultsWindow = function()
|
||||
{
|
||||
this.DOMPopupSearchResultsWindow().style.display = 'none';
|
||||
this.DOMSearchClose().style.display = 'none';
|
||||
this.Activate(false);
|
||||
}
|
||||
|
||||
this.CloseSelectionWindow = function()
|
||||
{
|
||||
this.DOMSearchSelectWindow().style.display = 'none';
|
||||
}
|
||||
|
||||
// Performs a search.
|
||||
this.Search = function()
|
||||
{
|
||||
this.keyTimeout = 0;
|
||||
|
||||
// strip leading whitespace
|
||||
var searchValue = this.DOMSearchField().value.replace(/^ +/, "");
|
||||
|
||||
var code = searchValue.toLowerCase().charCodeAt(0);
|
||||
var idxChar = searchValue.substr(0, 1).toLowerCase();
|
||||
if ( 0xD800 <= code && code <= 0xDBFF && searchValue > 1) // surrogate pair
|
||||
{
|
||||
idxChar = searchValue.substr(0, 2);
|
||||
}
|
||||
|
||||
var resultsPage;
|
||||
var resultsPageWithSearch;
|
||||
var hasResultsPage;
|
||||
|
||||
var idx = indexSectionsWithContent[this.searchIndex].indexOf(idxChar);
|
||||
if (idx!=-1)
|
||||
{
|
||||
var hexCode=idx.toString(16);
|
||||
resultsPage = this.resultsPath + '/' + indexSectionNames[this.searchIndex] + '_' + hexCode + '.html';
|
||||
resultsPageWithSearch = resultsPage+'?'+escape(searchValue);
|
||||
hasResultsPage = true;
|
||||
}
|
||||
else // nothing available for this search term
|
||||
{
|
||||
resultsPage = this.resultsPath + '/nomatches.html';
|
||||
resultsPageWithSearch = resultsPage;
|
||||
hasResultsPage = false;
|
||||
}
|
||||
|
||||
window.frames.MSearchResults.location = resultsPageWithSearch;
|
||||
var domPopupSearchResultsWindow = this.DOMPopupSearchResultsWindow();
|
||||
|
||||
if (domPopupSearchResultsWindow.style.display!='block')
|
||||
{
|
||||
var domSearchBox = this.DOMSearchBox();
|
||||
this.DOMSearchClose().style.display = 'inline';
|
||||
if (this.insideFrame)
|
||||
{
|
||||
var domPopupSearchResults = this.DOMPopupSearchResults();
|
||||
domPopupSearchResultsWindow.style.position = 'relative';
|
||||
domPopupSearchResultsWindow.style.display = 'block';
|
||||
var width = document.body.clientWidth - 8; // the -8 is for IE :-(
|
||||
domPopupSearchResultsWindow.style.width = width + 'px';
|
||||
domPopupSearchResults.style.width = width + 'px';
|
||||
}
|
||||
else
|
||||
{
|
||||
var domPopupSearchResults = this.DOMPopupSearchResults();
|
||||
var left = getXPos(domSearchBox) + 150; // domSearchBox.offsetWidth;
|
||||
var top = getYPos(domSearchBox) + 20; // domSearchBox.offsetHeight + 1;
|
||||
domPopupSearchResultsWindow.style.display = 'block';
|
||||
left -= domPopupSearchResults.offsetWidth;
|
||||
domPopupSearchResultsWindow.style.top = top + 'px';
|
||||
domPopupSearchResultsWindow.style.left = left + 'px';
|
||||
}
|
||||
}
|
||||
|
||||
this.lastSearchValue = searchValue;
|
||||
this.lastResultsPage = resultsPage;
|
||||
}
|
||||
|
||||
// -------- Activation Functions
|
||||
|
||||
// Activates or deactivates the search panel, resetting things to
|
||||
// their default values if necessary.
|
||||
this.Activate = function(isActive)
|
||||
{
|
||||
if (isActive || // open it
|
||||
this.DOMPopupSearchResultsWindow().style.display == 'block'
|
||||
)
|
||||
{
|
||||
this.DOMSearchBox().className = 'MSearchBoxActive';
|
||||
|
||||
var searchField = this.DOMSearchField();
|
||||
|
||||
if (searchField.value == this.searchLabel) // clear "Search" term upon entry
|
||||
{
|
||||
searchField.value = '';
|
||||
this.searchActive = true;
|
||||
}
|
||||
}
|
||||
else if (!isActive) // directly remove the panel
|
||||
{
|
||||
this.DOMSearchBox().className = 'MSearchBoxInactive';
|
||||
this.DOMSearchField().value = this.searchLabel;
|
||||
this.searchActive = false;
|
||||
this.lastSearchValue = ''
|
||||
this.lastResultsPage = '';
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------
|
||||
|
||||
// The class that handles everything on the search results page.
|
||||
function SearchResults(name)
|
||||
{
|
||||
// The number of matches from the last run of <Search()>.
|
||||
this.lastMatchCount = 0;
|
||||
this.lastKey = 0;
|
||||
this.repeatOn = false;
|
||||
|
||||
// Toggles the visibility of the passed element ID.
|
||||
this.FindChildElement = function(id)
|
||||
{
|
||||
var parentElement = document.getElementById(id);
|
||||
var element = parentElement.firstChild;
|
||||
|
||||
while (element && element!=parentElement)
|
||||
{
|
||||
if (element.nodeName == 'DIV' && element.className == 'SRChildren')
|
||||
{
|
||||
return element;
|
||||
}
|
||||
|
||||
if (element.nodeName == 'DIV' && element.hasChildNodes())
|
||||
{
|
||||
element = element.firstChild;
|
||||
}
|
||||
else if (element.nextSibling)
|
||||
{
|
||||
element = element.nextSibling;
|
||||
}
|
||||
else
|
||||
{
|
||||
do
|
||||
{
|
||||
element = element.parentNode;
|
||||
}
|
||||
while (element && element!=parentElement && !element.nextSibling);
|
||||
|
||||
if (element && element!=parentElement)
|
||||
{
|
||||
element = element.nextSibling;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
this.Toggle = function(id)
|
||||
{
|
||||
var element = this.FindChildElement(id);
|
||||
if (element)
|
||||
{
|
||||
if (element.style.display == 'block')
|
||||
{
|
||||
element.style.display = 'none';
|
||||
}
|
||||
else
|
||||
{
|
||||
element.style.display = 'block';
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Searches for the passed string. If there is no parameter,
|
||||
// it takes it from the URL query.
|
||||
//
|
||||
// Always returns true, since other documents may try to call it
|
||||
// and that may or may not be possible.
|
||||
this.Search = function(search)
|
||||
{
|
||||
if (!search) // get search word from URL
|
||||
{
|
||||
search = window.location.search;
|
||||
search = search.substring(1); // Remove the leading '?'
|
||||
search = unescape(search);
|
||||
}
|
||||
|
||||
search = search.replace(/^ +/, ""); // strip leading spaces
|
||||
search = search.replace(/ +$/, ""); // strip trailing spaces
|
||||
search = search.toLowerCase();
|
||||
search = convertToId(search);
|
||||
|
||||
var resultRows = document.getElementsByTagName("div");
|
||||
var matches = 0;
|
||||
|
||||
var i = 0;
|
||||
while (i < resultRows.length)
|
||||
{
|
||||
var row = resultRows.item(i);
|
||||
if (row.className == "SRResult")
|
||||
{
|
||||
var rowMatchName = row.id.toLowerCase();
|
||||
rowMatchName = rowMatchName.replace(/^sr\d*_/, ''); // strip 'sr123_'
|
||||
|
||||
if (search.length<=rowMatchName.length &&
|
||||
rowMatchName.substr(0, search.length)==search)
|
||||
{
|
||||
row.style.display = 'block';
|
||||
matches++;
|
||||
}
|
||||
else
|
||||
{
|
||||
row.style.display = 'none';
|
||||
}
|
||||
}
|
||||
i++;
|
||||
}
|
||||
document.getElementById("Searching").style.display='none';
|
||||
if (matches == 0) // no results
|
||||
{
|
||||
document.getElementById("NoMatches").style.display='block';
|
||||
}
|
||||
else // at least one result
|
||||
{
|
||||
document.getElementById("NoMatches").style.display='none';
|
||||
}
|
||||
this.lastMatchCount = matches;
|
||||
return true;
|
||||
}
|
||||
|
||||
// return the first item with index index or higher that is visible
|
||||
this.NavNext = function(index)
|
||||
{
|
||||
var focusItem;
|
||||
while (1)
|
||||
{
|
||||
var focusName = 'Item'+index;
|
||||
focusItem = document.getElementById(focusName);
|
||||
if (focusItem && focusItem.parentNode.parentNode.style.display=='block')
|
||||
{
|
||||
break;
|
||||
}
|
||||
else if (!focusItem) // last element
|
||||
{
|
||||
break;
|
||||
}
|
||||
focusItem=null;
|
||||
index++;
|
||||
}
|
||||
return focusItem;
|
||||
}
|
||||
|
||||
this.NavPrev = function(index)
|
||||
{
|
||||
var focusItem;
|
||||
while (1)
|
||||
{
|
||||
var focusName = 'Item'+index;
|
||||
focusItem = document.getElementById(focusName);
|
||||
if (focusItem && focusItem.parentNode.parentNode.style.display=='block')
|
||||
{
|
||||
break;
|
||||
}
|
||||
else if (!focusItem) // last element
|
||||
{
|
||||
break;
|
||||
}
|
||||
focusItem=null;
|
||||
index--;
|
||||
}
|
||||
return focusItem;
|
||||
}
|
||||
|
||||
this.ProcessKeys = function(e)
|
||||
{
|
||||
if (e.type == "keydown")
|
||||
{
|
||||
this.repeatOn = false;
|
||||
this.lastKey = e.keyCode;
|
||||
}
|
||||
else if (e.type == "keypress")
|
||||
{
|
||||
if (!this.repeatOn)
|
||||
{
|
||||
if (this.lastKey) this.repeatOn = true;
|
||||
return false; // ignore first keypress after keydown
|
||||
}
|
||||
}
|
||||
else if (e.type == "keyup")
|
||||
{
|
||||
this.lastKey = 0;
|
||||
this.repeatOn = false;
|
||||
}
|
||||
return this.lastKey!=0;
|
||||
}
|
||||
|
||||
this.Nav = function(evt,itemIndex)
|
||||
{
|
||||
var e = (evt) ? evt : window.event; // for IE
|
||||
if (e.keyCode==13) return true;
|
||||
if (!this.ProcessKeys(e)) return false;
|
||||
|
||||
if (this.lastKey==38) // Up
|
||||
{
|
||||
var newIndex = itemIndex-1;
|
||||
var focusItem = this.NavPrev(newIndex);
|
||||
if (focusItem)
|
||||
{
|
||||
var child = this.FindChildElement(focusItem.parentNode.parentNode.id);
|
||||
if (child && child.style.display == 'block') // children visible
|
||||
{
|
||||
var n=0;
|
||||
var tmpElem;
|
||||
while (1) // search for last child
|
||||
{
|
||||
tmpElem = document.getElementById('Item'+newIndex+'_c'+n);
|
||||
if (tmpElem)
|
||||
{
|
||||
focusItem = tmpElem;
|
||||
}
|
||||
else // found it!
|
||||
{
|
||||
break;
|
||||
}
|
||||
n++;
|
||||
}
|
||||
}
|
||||
}
|
||||
if (focusItem)
|
||||
{
|
||||
focusItem.focus();
|
||||
}
|
||||
else // return focus to search field
|
||||
{
|
||||
parent.document.getElementById("MSearchField").focus();
|
||||
}
|
||||
}
|
||||
else if (this.lastKey==40) // Down
|
||||
{
|
||||
var newIndex = itemIndex+1;
|
||||
var focusItem;
|
||||
var item = document.getElementById('Item'+itemIndex);
|
||||
var elem = this.FindChildElement(item.parentNode.parentNode.id);
|
||||
if (elem && elem.style.display == 'block') // children visible
|
||||
{
|
||||
focusItem = document.getElementById('Item'+itemIndex+'_c0');
|
||||
}
|
||||
if (!focusItem) focusItem = this.NavNext(newIndex);
|
||||
if (focusItem) focusItem.focus();
|
||||
}
|
||||
else if (this.lastKey==39) // Right
|
||||
{
|
||||
var item = document.getElementById('Item'+itemIndex);
|
||||
var elem = this.FindChildElement(item.parentNode.parentNode.id);
|
||||
if (elem) elem.style.display = 'block';
|
||||
}
|
||||
else if (this.lastKey==37) // Left
|
||||
{
|
||||
var item = document.getElementById('Item'+itemIndex);
|
||||
var elem = this.FindChildElement(item.parentNode.parentNode.id);
|
||||
if (elem) elem.style.display = 'none';
|
||||
}
|
||||
else if (this.lastKey==27) // Escape
|
||||
{
|
||||
parent.searchBox.CloseResultsWindow();
|
||||
parent.document.getElementById("MSearchField").focus();
|
||||
}
|
||||
else if (this.lastKey==13) // Enter
|
||||
{
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
this.NavChild = function(evt,itemIndex,childIndex)
|
||||
{
|
||||
var e = (evt) ? evt : window.event; // for IE
|
||||
if (e.keyCode==13) return true;
|
||||
if (!this.ProcessKeys(e)) return false;
|
||||
|
||||
if (this.lastKey==38) // Up
|
||||
{
|
||||
if (childIndex>0)
|
||||
{
|
||||
var newIndex = childIndex-1;
|
||||
document.getElementById('Item'+itemIndex+'_c'+newIndex).focus();
|
||||
}
|
||||
else // already at first child, jump to parent
|
||||
{
|
||||
document.getElementById('Item'+itemIndex).focus();
|
||||
}
|
||||
}
|
||||
else if (this.lastKey==40) // Down
|
||||
{
|
||||
var newIndex = childIndex+1;
|
||||
var elem = document.getElementById('Item'+itemIndex+'_c'+newIndex);
|
||||
if (!elem) // last child, jump to parent next parent
|
||||
{
|
||||
elem = this.NavNext(itemIndex+1);
|
||||
}
|
||||
if (elem)
|
||||
{
|
||||
elem.focus();
|
||||
}
|
||||
}
|
||||
else if (this.lastKey==27) // Escape
|
||||
{
|
||||
parent.searchBox.CloseResultsWindow();
|
||||
parent.document.getElementById("MSearchField").focus();
|
||||
}
|
||||
else if (this.lastKey==13) // Enter
|
||||
{
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
function setKeyActions(elem,action)
|
||||
{
|
||||
elem.setAttribute('onkeydown',action);
|
||||
elem.setAttribute('onkeypress',action);
|
||||
elem.setAttribute('onkeyup',action);
|
||||
}
|
||||
|
||||
function setClassAttr(elem,attr)
|
||||
{
|
||||
elem.setAttribute('class',attr);
|
||||
elem.setAttribute('className',attr);
|
||||
}
|
||||
|
||||
function createResults()
|
||||
{
|
||||
var results = document.getElementById("SRResults");
|
||||
for (var e=0; e<searchData.length; e++)
|
||||
{
|
||||
var id = searchData[e][0];
|
||||
var srResult = document.createElement('div');
|
||||
srResult.setAttribute('id','SR_'+id);
|
||||
setClassAttr(srResult,'SRResult');
|
||||
var srEntry = document.createElement('div');
|
||||
setClassAttr(srEntry,'SREntry');
|
||||
var srLink = document.createElement('a');
|
||||
srLink.setAttribute('id','Item'+e);
|
||||
setKeyActions(srLink,'return searchResults.Nav(event,'+e+')');
|
||||
setClassAttr(srLink,'SRSymbol');
|
||||
srLink.innerHTML = searchData[e][1][0];
|
||||
srEntry.appendChild(srLink);
|
||||
if (searchData[e][1].length==2) // single result
|
||||
{
|
||||
srLink.setAttribute('href',searchData[e][1][1][0]);
|
||||
if (searchData[e][1][1][1])
|
||||
{
|
||||
srLink.setAttribute('target','_parent');
|
||||
}
|
||||
var srScope = document.createElement('span');
|
||||
setClassAttr(srScope,'SRScope');
|
||||
srScope.innerHTML = searchData[e][1][1][2];
|
||||
srEntry.appendChild(srScope);
|
||||
}
|
||||
else // multiple results
|
||||
{
|
||||
srLink.setAttribute('href','javascript:searchResults.Toggle("SR_'+id+'")');
|
||||
var srChildren = document.createElement('div');
|
||||
setClassAttr(srChildren,'SRChildren');
|
||||
for (var c=0; c<searchData[e][1].length-1; c++)
|
||||
{
|
||||
var srChild = document.createElement('a');
|
||||
srChild.setAttribute('id','Item'+e+'_c'+c);
|
||||
setKeyActions(srChild,'return searchResults.NavChild(event,'+e+','+c+')');
|
||||
setClassAttr(srChild,'SRScope');
|
||||
srChild.setAttribute('href',searchData[e][1][c+1][0]);
|
||||
if (searchData[e][1][c+1][1])
|
||||
{
|
||||
srChild.setAttribute('target','_parent');
|
||||
}
|
||||
srChild.innerHTML = searchData[e][1][c+1][2];
|
||||
srChildren.appendChild(srChild);
|
||||
}
|
||||
srEntry.appendChild(srChildren);
|
||||
}
|
||||
srResult.appendChild(srEntry);
|
||||
results.appendChild(srResult);
|
||||
}
|
||||
}
|
||||
|
||||
function init_search()
|
||||
{
|
||||
var results = document.getElementById("MSearchSelectWindow");
|
||||
for (var key in indexSectionLabels)
|
||||
{
|
||||
var link = document.createElement('a');
|
||||
link.setAttribute('class','SelectItem');
|
||||
link.setAttribute('onclick','searchBox.OnSelectItem('+key+')');
|
||||
link.href='javascript:void(0)';
|
||||
link.innerHTML='<span class="SelectionMark"> </span>'+indexSectionLabels[key];
|
||||
results.appendChild(link);
|
||||
}
|
||||
searchBox.OnSelectItem(0);
|
||||
}
|
||||
|
||||
BIN
html/search/search_l.png
Normal file
|
After Width: | Height: | Size: 604 B |
BIN
html/search/search_m.png
Normal file
|
After Width: | Height: | Size: 158 B |
BIN
html/search/search_r.png
Normal file
|
After Width: | Height: | Size: 612 B |
36
html/search/searchdata.js
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
var indexSectionsWithContent =
|
||||
{
|
||||
0: "_abgirs",
|
||||
1: "a",
|
||||
2: "a",
|
||||
3: "_abgrs",
|
||||
4: "i",
|
||||
5: "_",
|
||||
6: "i",
|
||||
7: "i"
|
||||
};
|
||||
|
||||
var indexSectionNames =
|
||||
{
|
||||
0: "all",
|
||||
1: "classes",
|
||||
2: "files",
|
||||
3: "functions",
|
||||
4: "typedefs",
|
||||
5: "enums",
|
||||
6: "enumvalues",
|
||||
7: "defines"
|
||||
};
|
||||
|
||||
var indexSectionLabels =
|
||||
{
|
||||
0: "All",
|
||||
1: "Classes",
|
||||
2: "Files",
|
||||
3: "Functions",
|
||||
4: "Typedefs",
|
||||
5: "Enumerations",
|
||||
6: "Enumerator",
|
||||
7: "Macros"
|
||||
};
|
||||
|
||||
26
html/search/typedefs_0.html
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html><head><title></title>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<link rel="stylesheet" type="text/css" href="search.css"/>
|
||||
<script type="text/javascript" src="typedefs_0.js"></script>
|
||||
<script type="text/javascript" src="search.js"></script>
|
||||
</head>
|
||||
<body class="SRPage">
|
||||
<div id="SRIndex">
|
||||
<div class="SRStatus" id="Loading">Loading...</div>
|
||||
<div id="SRResults"></div>
|
||||
<script type="text/javascript"><!--
|
||||
createResults();
|
||||
--></script>
|
||||
<div class="SRStatus" id="Searching">Searching...</div>
|
||||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||||
<script type="text/javascript"><!--
|
||||
document.getElementById("Loading").style.display="none";
|
||||
document.getElementById("NoMatches").style.display="none";
|
||||
var searchResults = new SearchResults("searchResults");
|
||||
searchResults.Search();
|
||||
--></script>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
4
html/search/typedefs_0.js
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
var searchData=
|
||||
[
|
||||
['ina237_5falerttype',['INA237_AlertType',['../_adafruit___i_n_a237_8h.html#a1c988ddedc2786e59aca503b313b0724',1,'Adafruit_INA237.h']]]
|
||||
];
|
||||