イントロダクション

Post Views: 33

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

用語の定義

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

API

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

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

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

関数名
戻り値
引数 IN

引数 OUT

oABC
etSTS
etCMD cmd
stABC_I dat
float32* rlt

ABC用API関数
OSS-ECALステータスコード
OSS-ECALコマンドコード
ABC用 API関数入力値
ABC用 API関数出力値

例 : ROHM社製　温度センサ　BD1020HFV　ADC type

etSTS oBD1020HFV( etCMD, float32* );

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

戻り値
引数 IN
引数 OUT

etSTS
etCMD cmd
float32* &rlt

OSS-ECALステータスコード
OSS-ECALコマンドコード
温度 -30.0～100.0 [℃]

etCMD
eCMD_START

処理：
1. AD変換スタート

API関数：etSTS oBD1020HFV_START(void)

戻り値：
eSTS_FIN
eSTS_ERR_HAL_ADC
eSTS_ERR_COMMAND_CODE
eSTS_ERR_OTHERS_RUN
eSTS_ERR_ADC_OBJECT

備考：Arduino, Mbeb, ModusToolboxは未対応

eCMD_READ

処理：
1. AD変換値読み出し
2. AD変換値を温度に変換
電圧値=(AD変換値×VDD)/(2^{AD bit})
温度＝((電圧値-電圧オフセット値)/ゲイン係数)+温度オフセット値 (Min ～ Max)
3. 温度をrltに書き込む

API関数：etSTS oBD1020HFV_READ( float32* rlt )

戻り値：
eSTS_FIN
eSTS_ERR_MIN
eSTS_ERR_MAX
eSTS_ERR_HAL_ADC
eSTS_ERR_COMMAND_CODE
eSTS_ERR_OTHERS_RUN
eSTS_ERR_ADC_OBJECT

備考：Arduino, Mbeb, ModusToolboxは未対応

eCMD_START_READ

処理：
1. AD変換スタート
2. AD変換終了まで待機
3. AD変換値読み出し
4. AD変換値を温度に変換
電圧値=(AD変換値×VDD)/(2^{AD bit})
温度＝((電圧値-電圧オフセット値)/ゲイン係数)+温度オフセット値 (Min ～ Max)
5. 温度をrltに書き込む

API関数：etSTS oBD1020HFV_START_READ( float32* rlt )

戻り値：
eSTS_FIN
eSTS_ERR_MIN
eSTS_ERR_MAX
eSTS_ERR_HAL_ADC
eSTS_ERR_COMMAND_CODE
eSTS_ERR_OTHERS_RUN
eSTS_ERR_ADC_OBJECT

備考：

etSTS oABC_COMMAND( stABC_I dat, stABC_O* rlt )

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

API関数名
戻り値
引数IN
引数OUT

oABC
etSTS
stABC_I dat
stABC_O* rlt

ABC用 API関数
OSS-ECALステータス・コード
ABC用 API関数入力値
ABC用 API関数出力値

例 : ROHM社製　温度センサ　BD1020HFV　ADC type

etSTS oBD1020HFV_READ( float32* );

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

戻り値
引数 OUT

etSTS
float32* &rlt

OSS-ECALステータスコード
温度 -30.0～100.0 [℃]

etSTS oBD1020HFV_READ( float32* rlt )

戻り値：
eSTS_FIN
eSTS_ERR_MIN
eSTS_ERR_MAX
eSTS_ERR_HAL_ADC
eSTS_ERR_COMMAND_CODE
eSTS_ERR_OTHERS_RUN
eSTS_ERR_ADC_OBJECT

備考：Arduino, Mbeb, ModusToolboxは未対応

ファイル構成

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

sample.c (.cpp)
sample.h
oABC.c (.cpp)
oABC.h
oss_ecal.h
user_setting.c (.cpp)
user_setting.h
readme.md
OSS-ECAL Terms of Use.txt

サンプルアプリケーションプログラム
サンプルアプリケーションヘッダ
ABC用OSS-ECALプログラム
ABC用OSS-ECALヘッダ
OSS-ECAL 共通ヘッダ
ユーザ設定定数・テーブル
ユーザ設定ヘッダ
Readme
OSS-ECAL利用条件

HAL対応表

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

MCU/Board メーカ	HAL	MCU*	開発環境*	HALNAME
Arduino	Arduino 1.8.6	ATmega2560 ATmega328P	Mega 2560 Rev3 Arduino Pro Mini 3.3V	ARDUINO
ARM	Mbed 6.17.0	STM32F401RETx	STM32 Nucleo-64 boards	MBED
Infineon	ModusToolbox HAL Cat1 2.4.3	CYBLE-416045-02	CY8CPROTO-063-BLE PSoC 6 BLE Prototyping Kit	ModusToolbox
NXP	MCUXpresso SDK iMXRT1051B_1052B ksdk2_0	CYBLE-416045-02	IMXRT1050-EVKB	iMXRT1051B1052B
Renesas	SSP 2.4.0	R7FS7G27H3A01CFC	S7G2 SK	SSP
STM	STM32Cube FW_F4 V1.27.1	STM32F401RETx	STM32 Nucleo-64 boards	STM32F4
NXP	MCAL	MPC574XG-100DS	MPC574XG-MB( Motherboard) MPC574XG-100DS(Daughter boards)	MCAL

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

組込み方法

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

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

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

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

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