イントロダクション

OSS-ECALとは、電子部品抽象化レイヤのオープンソースソフトウェア( Open Source Software for Electronic Components Abstraction Layer)の略称です。OSS-ECALは、電子部品のソフトウェア開発の効率化および電子部品の利用性向上を目的としたソフトウェアレイヤであり、電子部品の特徴に合わせたソフトウェアインタフェースを有しています。
OSS-ECALのプログラム言語は、C言語です。

用語の定義

用語意味
ABC電子部品の仮称
APIアプリケーション・インタフェース
COMMANDコマンドの仮称
etCMDにて宣言した名称”eCMD_”以降の名称
電子部品に合わせてメンバー名をリネーム
e(接頭語)列挙型enum メンバー名
et(接頭語)列挙型enum タグ名
etCMDコマンドの列挙型(enum)型定義
電子部品に合わせてメンバー名をリネームすると使いやすい
etSTSステータスの列挙型(enum)型定義
f浮動小数点
HALHardware Abstraction Layer, AUTOSAR MCAL
HALNAMEHALの仮称
HALNAMEはHAL対応表を参照してください
i整数
固定小数点
接頭語 #define immediate
oABCABC用API関数名(引数にコマンド渡す)
電子部品に合わせてメンバー名をリネームすると使いやすい
oABC_COMMANDABC用API関数名
電子部品に合わせてメンバー名をリネームすると使いやすい
OSS-ECALOpen Source Software for Electronic Components Abstraction Layer
READ電子部品から読込み(通信の場合、受信)
st(接頭語)構造体の型struct タグ名
stABC_IAPI関数のインプットの引数型の仮称
stABC_OAPI関数のアウトプットの引数型の仮称
WRITE電子部品への書込み(送信)
WRITE_READ1. 電子部品への書込み(送信)
2. 電子部品から読込み(通信の場合、受信)

API

電子部品の標準インタフェースおよび各電子部品の特徴に合わせたインタフェースを実現するため、APIには次の2つのタイプのAPI関数を用意しています。

etSTS oABC( etCMD cmd, stABC_I dat, stABC_O* rlt )

このAPI関数タイプは、引数にコマンドを渡すタイプです。

関数名oABCABC用API関数
戻り値etSTSOSS-ECALステータスコード
引数 INetCMD cmdOSS-ECALコマンドコード
stABC_I datABC用 API関数入力値
引数 OUTfloat32* rltABC用 API関数出力値
例 : Analog Devices社製 温度センサ AD22100A ADC type
etSTS oAD22100A( etCMD, float32* );

void function(void)
{
    float32 rlt;           // Temperature[degrees Celsius]
    // Output voltage of AD22100A is converted to AD and the result of temperature conversion is
    // read into vgPHY (READ command)
    etSTS sts = oAD22100A( eCMD_START_READ, &rlt );
}
etSTS oAD22100A( etCMD cmd, float32* rlt )

oAD22100A関数は、引数のコマンドによってAD22100Aの処理を実行するAPI関数です。

戻り値etSTSOSS-ECALステータスコード
eSTS_FIN正常終了
eSTS_ERR_MIN最小温度エラー(rltは最小温度)
eSTS_ERR_MAX最大温度エラー(rltは最大温度)
eSTS_ERR_HAL_ADCHAL ADCエラー
eSTS_ERR_COMMAND_CODEコマンド選択エラー
eSTS_ERR_OTHERS_RUN他コンポーネント実行中エラー
eSTS_ERR_ADC_OBJECTAD変換オブジェクト選択エラー
引数 INetCMD cmdOSS-ECALコマンドコード
eCMD_STARTAD変換をスタートするコマンド
eCMD_READAD変換値を読込み、AD変換値を温度に変換するコマンド
AD変換値から温度変換式
電圧値=(AD変換値×VDD)/(2AD bit)
温度=((電圧値-電圧オフセット値)/ゲイン係数)+温度オフセット値 (Min, Max Limit)
eCMD_START_READAD変換をスタートし、AD変換値を読込み、AD変換値を温度に変換するコマンド
AD変換値から温度変換式
電圧値=(AD変換値×VDD)/(2AD bit)
温度=((電圧値-電圧オフセット値)/ゲイン係数)+温度オフセット値 (Min, Max Limit)
引数 OUTfloat32* rlt温度 -40.0~85.0 [℃]

HAL別コマンド対応表

ArduinoArduinoeCMD_START_READ
ARMMbedeCMD_START_READ
AUTOSARAUTOSAR
Debian ProjectDebian(Linux)eCMD_START_READ
InfineonModusToolbox eCMD_START_READ
NXPMCUXpresso MXRT1051B_1052BeCMD_START
eCMD_READ
eCMD_START_READ
RenesasSSPeCMD_START
eCMD_READ
eCMD_START_READ
STMSTM32Cube FW_F4 eCMD_START
eCMD_READ
eCMD_START_READ

etSTS oABC_COMMAND( stABC_I dat, stABC_O* rlt )

このAPI関数タイプは、関数名でコマンドを指定するタイプです。(コマンドAPI関数)

関数名oABCABC用API関数
戻り値etSTSOSS-ECALステータスコード
引数 INstABC_I datABC用 API関数入力値
引数 OUTfloat32* rltABC用 API関数出力値
例 : Analog Devices社製 温度センサ AD22100A ADC type
etSTS oAD22100A_READ( float32* );

void function(void)
{
    float32 rlt;           // Temperature[degrees Celsius]
    // Output voltage of AD22100A is converted to AD and the result of temperature conversion is
    // read into vgPHY (READ command)
    etSTS sts = oAD22100A_READ( &rlt );
}
etSTS oAD22100A_READ( float32* rlt )

oAD22100A_READ関数は、AD変換の終了を確認し、AD変換値を読み込み、そのAD変換値を温度に特性変換して、その温度をrltに保存するAPI関数です。

AD変換値から温度変換式
電圧値=(AD変換値×VDD)/(2AD bit)
温度=((電圧値-電圧オフセット値)/ゲイン係数)+温度オフセット値 (Min, Max Limit)

戻り値etSTSOSS-ECALステータスコード
eSTS_FIN正常終了
eSTS_ERR_MIN最小温度エラー(rltは最小温度)
eSTS_ERR_MAX最大温度エラー(rltは最大温度)
eSTS_ERR_HAL_ADCHAL ADCエラー
eSTS_ERR_TIMEOUTADC Timeoutエラー(AUTOSARのみ)
eSTS_ERR_OTHERS_RUN他コンポーネント実行中エラー
eSTS_ERR_ADC_OBJECTAD変換オブジェクト選択エラー
引数 OUTfloat32* rlt温度 -40.0~85.0 [℃]

HAL別関数対応表

ArduinoArduino
ARMMbed
AUTOSARAUTOSARXTime-out時間 ADC_TIMEOUT [us]設定
Debian ProjectDebian(Linux)
InfineonModusToolbox
NXPMCUXpresso MXRT1051B_1052BX
RenesasSSPX
STMSTM32Cube FW_F4 XTime-out時間 HAL_MAX_DELAY

ファイル構成

OSS-ECALのファイル構成は、次の通りです。尚、HALによって構成が異なりますので、各電子部品のOSS-ECALページでご確認ください。

フォルダ*ファイル概要
ABC_HALNAME_VERSION/samplesample.c (.cpp)サンプル・アプリケーション・プログラム
sample.hサンプル・アプリケーション・ヘッダ
ABC_HALNAME_VERSIONoABC.c (.cpp)ABC用OSS-ECALプログラム
oABC.hABC用OSS-ECALヘッダ
ABC_ARDUINO.inoArduino用サンプル・アプリケーション・プログラム
oss_ecal.hOSS-ECAL 共通ヘッダ (Ver 01.00.00以降、AUTOSARはVer01.01.07以降)
oTypes.hAUTOSAR用typedefヘッダファイル
user_setting.c (.cpp)ユーザ設定定数・テーブル
user_setting.hユーザ設定ヘッダ
readme.mdReadme
OSS-ECAL Terms of Use.txtOSS-ECAL利用条件

HAL対応表

OSS-ECALのHAL対応は、次の通り(順次拡大中)です。尚、HAL対応は各電子部品のOSS-ECALページでご確認ください。

MCU/Board
メーカ
HALMCU*開発環境*HALNAME
ArduinoArduino 1.8.6ATmega2560
ATmega328P
Mega 2560 Rev3
Arduino Pro Mini 3.3V
ARDUINO
ARMMbed 6.17.0STM32F401RESTM32 Nucleo-64 boardsMBED
AUTOSARAUTOSAR 4.4 (MCAL)S32K144S32K144EVB-Q100MCAL
InfineonModusToolbox HAL Cat1 2.4.3CYBLE-416045-02CY8CPROTO-063-BLE PSoC 6 BLE Prototyping KitModusToolbox
NXPMCUXpresso SDK
iMXRT1051B_1052B
ksdk2_0
MIMXRT1052DVL6AIMXRT1050-EVKBiMXRT1051B1052B
RenesasSSP 2.4.0R7FS7G27H3A01CFCS7G2 SKSSP
STMSTM32Cube FW_F4 V1.27.1STM32F401RESTM32 Nucleo-64 boardsSTM32F4
Debian ProjectDebian(Linux) v2022.04TI AM335xBeagleBone Black – Rev CLinux

*   開発時のMCUおよび開発環境。同じHALであってもMCUや開発環境が異なると動作が合わない場合があります。

組込み方法

ユーザプログラムにOSS-ECALを組み込む方法

ユーザプログラムに複数のOSS-ECAL(同じMCU機能の電子部品)を組み込む方法

ユーザプログラムに複数のOSS-ECAL(異なるMCU機能の電子部品)を組み込む方法

ユーザプログラムに複数同じ電子部品を組み込む方法

電子部品の入れ替えによるユーザプログラムへの影響低減方法

OSS-ECAL Japanese
error: コンテンツは保護されている