foxBMS
1.2.1
The foxBMS Battery Management System API Documentation
|
Definition of foxBMS standard types. More...
Go to the source code of this file.
Macros | |
#define | NULL ((void *)0u) |
NULL definition. More... | |
#define | NULL_PTR ((void *)(0u)) |
Null pointer. More... | |
Typedefs | |
typedef enum STD_RETURN_TYPE | STD_RETURN_TYPE_e |
typedef enum STD_PIN_STATE | STD_PIN_STATE_e |
Enumerations | |
enum | STD_RETURN_TYPE { STD_OK , STD_NOT_OK } |
enum | STD_PIN_STATE { STD_PIN_LOW , STD_PIN_HIGH , STD_PIN_UNDEFINED } |
Definition of foxBMS standard types.
SPDX-License-Identifier: BSD-3-Clause
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
We kindly request you to use one or more of the following phrases to refer to foxBMS in your hardware, software, documentation or advertising materials:
Definition in file fstd_types.h.
#define NULL ((void *)0u) |
NULL definition.
This define describes a null. Use it to compare against null.
Definition at line 65 of file fstd_types.h.
#define NULL_PTR ((void *)(0u)) |
Null pointer.
This define describes a null pointer. Use it to compare for null pointer access.
Definition at line 75 of file fstd_types.h.
typedef enum STD_PIN_STATE STD_PIN_STATE_e |
enum for pin state
typedef enum STD_RETURN_TYPE STD_RETURN_TYPE_e |
enum for standard return type
enum STD_PIN_STATE |
enum for pin state
Enumerator | |
---|---|
STD_PIN_LOW | electrical pin state: low |
STD_PIN_HIGH | electrical pin state: high |
STD_PIN_UNDEFINED | electrical pin state: undefined |
Definition at line 86 of file fstd_types.h.
enum STD_RETURN_TYPE |
enum for standard return type
Enumerator | |
---|---|
STD_OK | ok |
STD_NOT_OK | not ok |
Definition at line 80 of file fstd_types.h.