foxBMS  1.2.0
The foxBMS Battery Management System API Documentation
sps_types.h File Reference

Types for the SPS driver. More...

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

Go to the source code of this file.

Typedefs

typedef uint8_t SPS_CHANNEL_INDEX
 
typedef enum SPS_CHANNEL_AFFILIATION SPS_CHANNEL_AFFILIATION_e
 affiliation type of a sps channel More...
 

Enumerations

enum  SPS_CHANNEL_AFFILIATION { SPS_AFF_CONTACTOR , SPS_AFF_GENERAL_IO }
 affiliation type of a sps channel More...
 

Detailed Description

Types for the SPS driver.

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:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

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:

  • ″This product uses parts of foxBMS®″
  • ″This product includes parts of foxBMS®″
  • ″This product is derived from foxBMS®″
Author
foxBMS Team
Date
2020-12-01 (date of creation)
Updated
2020-12-01 (date of last update)
Prefix
SPS

Definition in file sps_types.h.

Typedef Documentation

◆ SPS_CHANNEL_AFFILIATION_e

affiliation type of a sps channel

These values are used to mark if the SPS channel is a contactor or general IO (or possibly something else in the future). This has implication on the type of interface that may access the channel.

◆ SPS_CHANNEL_INDEX

typedef uint8_t SPS_CHANNEL_INDEX

index of a SPS channel; not to be confused with CONT_CONTACTOR_INDEX

Definition at line 63 of file sps_types.h.

Enumeration Type Documentation

◆ SPS_CHANNEL_AFFILIATION

affiliation type of a sps channel

These values are used to mark if the SPS channel is a contactor or general IO (or possibly something else in the future). This has implication on the type of interface that may access the channel.

Enumerator
SPS_AFF_CONTACTOR 

affiliation of channel is contactor

SPS_AFF_GENERAL_IO 

affiliation of channel is general IO

Definition at line 71 of file sps_types.h.