API Spec Review
- Maruyama Masanori
依頼事項
IC-ServiceのAPI仕様書のレビューをお願い致します。
以下にレビュー対象ドキュメントを添付致します。
- 指摘/コメントは、Confluenceのコメント機能（Add Inline Commnet）を使用して、以下に直接追記頂けますようお願い致します。
2020/8/7追記
レビューありがとうございました。コメントに基づき、以下添付の通り、修正しました。ご査収ください。
一部コメントについては、口頭で対応協議させて頂いた上で、必要に応じて修正したいと思います。
対応希望納期
- 7/24(金)
-----------------------------------------------------------------------------------------------------------------------------------------------------------
IC-Service API仕様書
目次
3-1-5 IC_HMI_TRCOM_UNIT_VAL.. 9
3-1-6 IC_HMI_FUEL_ECONOMY_UNIT_VAL.. 10
3-4-18 getAdaptingLighting. 32
3-4-23 getExteriorLightFault. 35
3-4-27 getAutoHiBeamGreen.. 37
3-4-32 getDrivingPowerMode. 40
3-8-18 getFuelEconomyUnitVal 57
1目的
本仕様書は、HMI LayerのCluster UIが、共有メモリにセットされたIC-Serviceのシグナル情報取得APIについて記載する。
2概要
画面描画を行うHMI LayerのCluster UIと機能処理を行うService LayerのIC-Service間におけるAPIを定義する。
Container |
Container Host |
Cluster UI |
IC-Service |
Inter Process Communication |
HMI Layer |
Service Layer |
図2.1 HMI Layerの位置づけ
HMI LayerのCluster UIとService LayerのIC-Service間は、Inter Process Communicationの共有メモリを使用して、通信を行う。
共有メモリの使い方は、Polling方式とEvent方式を用意する。
①Polling方式
IC-Serviceは共有メモリの値に変化があった場合、setData関数などを用いて、値の更新を行う。
Cluster UIは周期的にgetData関数などを実行し、値の変化にかかわらず、共有メモリから値を取得する。
以下に概略図を示す。
図2.2 Polling方式における通信
②Event方式
Cluster UIは通知を受けたい共有メモリをIC-Serviceに登録する。IC-Serviceは共有メモリの値に変化があった場合は、setData関数などを用いて、値の更新を行う。その際、Cluster UIから登録された共有メモリの値が変わった場合は、Notify関数でCluster UIへ通知を行う。
Notify関数では変更したシグナルと状態をClusterUIに通知させ、Cluster UIは値を取得する。
以下に概略図を示す。
図2.3 Event方式における通信
3 API詳細
本項は、各シグナル取得するために使用するAPIの詳細を記述する。
Enum定数定義の詳細については次の1～4で形成される。
1：APIの名前
2：APIの説明
3：定数名、値及び説明
4：特記事項
Macro定数定義の詳細については次の1～4で形成される。
1：APIの名前
2：APIの説明
3：値及び説明
4：特記事項
シグナル取得APIの詳細については次の1～6で形成される。
1：プロトタイプ宣言
2：APIの説明
3：返り値の型種別
4：返り値の詳細
5：引数の詳細
6：特記事項
3-1 Enum Definition
3-1-1 IC_HMI_ON_OFF
1:APIの名前
IC_HMI_ON_OFF
2:APIの説明
TelltaleのON/OFF状態
3:定数名及び値
0：IC_HMI_OFF OFF状態
1：IC_HMI_ON ON状態
4:特記事項
特になし
3-1-2 IC_HMI_GEAR_AT_VAL
1: APIの名前
IC_HMI_GEAR_AT_VAL
2:APIの説明
ギア状態(AT)
3:定数名及び値
0：IC_HMI_AT_OFF ギアが非表示状態
1：IC_HMI_AT_PARKING ギアがParking状態
2：IC_HMI_AT_REVERSE ギアがReverse状態
3：IC_HMI_AT_NEUTRAL ギアがNeutral状態
4：IC_HMI_AT_DRIVE ギアがDrive状態
5：IC_HMI_AT_SECOND ギアがSecond状態
6：IC_HMI_AT_LOW_GEAR ギアがLowGear状態
7：IC_HMI_AT_FIRST ギアがFirst状態
8：IC_HMI_AT_MANUAL ギアがManual状態
9：IC_HMI_AT_BRAKE ギアがBrake状態
10：IC_HMI_AT_ALL_ON 全点灯状態
11：IC_HMI_AT_ALL_OFF 全消灯状態
12：IC_HMI_AT_UNUSED ギアが未使用状態
4:特記事項
特になし
3-1-3 IC_HMI_GEAR_MT_VAL
1: APIの名前
IC_HMI_GEAR_MT_VAL
2:APIの説明
ギア状態(MT)
3:定数名及び値
0：IC_HMI_MT_OFF ギアが非表示状態
1：IC_HMI_MT_FIRST ギアが1速状態
2：IC_HMI_MT_SECOND ギアが2速状態
3：IC_HMI_MT_THIRD ギアが3速状態
4：IC_HMI_MT_FOURTH ギアが4速状態
5：IC_HMI_MT_FIFTH ギアが5速状態
6：IC_HMI_MT_SIXTH ギアが6速状態
7：IC_HMI_MT_SEVENTH ギアが7速状態
8：IC_HMI_MT_EIGHTTH ギアが8速状態
4:特記事項
特になし
3-1-4 IC_HMI_SP_UNIT_VAL
1: APIの名前
IC_HMI_SP_UNIT_VAL
2:APIの説明
車速単位
3:定数名及び値
0：IC_HMI_SP_KM_H 車速単位がkm/h状態
1：IC_HMI_SP_MPH 車速単位がmph状態
4:特記事項
特になし
3-1-5 IC_HMI_TRCOM_UNIT_VAL
1: APIの名前
IC_HMI_TRCOM_UNIT_VAL
2:APIの説明
トリップコンピュータ単位
3:定数名及び値
0：IC_HMI_TRCOM_KM トリップコンピュータ単位がkm状態
1：IC_HMI_TRCOM_MILE トリップコンピュータ単位がmile状態
4:特記事項
特になし
3-1-6 IC_HMI_FUEL_ECONOMY_UNIT_VAL
1:APIの名前
IC_HMI_FUEL_ECONOMY_UNIT_VAL
2:APIの説明
燃費表示単位
・瞬間燃費
・平均燃費A/B
・瞬間電費
・瞬間電費A/B
3:定数名及び値
0：IC_HMI_FUEL_KM_L 燃費表示単位がkm/L状態
1：IC_HMI_FUEL_MPG_US 燃費表示単位がMPG(U.S gallon) 状態
2：IC_HMI_FUEL_MPG_IG 燃費表示単位がMPG(imperial gallon) 状態
3：IC_HMI_FUEL_L_100KM 燃費表示単位がL/100km状態
4：IC_HMI_FUEL_MILE_KWH 燃費表示単位がmile/kwh状態
5：IC_HMI_FUEL_KM_KWH 燃費表示単位がkm/kwh状態
6：IC_HMI_FUEL_MILE_KG 燃費表示単位がmile/kg状態
7：IC_HMI_FUEL_KM_KG 燃費表示単位がkm/kg状態
8：IC_HMI_FUEL_KWH_100KM 燃費表示単位がkwh/100km状態
4:特記事項
特になし
3-2 Macro Definition
3-2-1 TellTale
3-2-1-1 IC_HMI_TT_TURN_R
1: APIの名前
IC_HMI_TT_TURN_R
2:APIの説明
右方向指示器状態のビットフラグ
3:値
0x0000000000000001
4:特記事項
特になし
3-2-1-2 IC_HMI_TT_TURN_L
1: APIの名前
IC_HMI_TT_TURN_L
2:APIの説明
左方向指示器状態のビットフラグ
3:値
0x0000000000000002
4:特記事項
特になし
3-2-1-3 IC_HMI_TT_BRAKE
1: APIの名前
IC_HMI_TT_BRAKE
2:APIの説明
ブレーキ警告灯状態のビットフラグ
3:値
0x0000000000000004
4:特記事項
特になし
3-2-1-4 IC_HMI_TT_SEATBELT
1: APIの名前
IC_HMI_TT_SEATBELT
2:APIの説明
ブレーキ警告灯状態のビットフラグ
3:値
0x0000000000000008
4:特記事項
特になし
3-2-1-5 IC_HMI_TT_HIGHBEAM
1: APIの名前
IC_HMI_HIGHBEAM
2:APIの説明
ビームパッシング警告灯状態のビットフラグ
3:値
0x0000000000000010
4:特記事項
特になし
3-2-1-6 IC_HMI_TT_DOOR
1: APIの名前
半ドア警告灯状態のビットフラグ
2:APIの説明
左方向指示器
3:値
0x0000000000000020
4:特記事項
特になし
3-2-1-7 IC_HMI_TT_EPS
1: APIの名前
IC_HMI_EPS
2:APIの説明
EPS警告灯状態のビットフラグ
3:値
0x0000000000000040
4:特記事項
特になし
3-2-1-8 IC_HMI_TT_SRS_AIRBAG
1: APIの名前
IC_HMI_SRS_AIRBAG
2:APIの説明
SRSエアバッグ警告灯状態のビットフラグ
3:値
0x0000000000000080
4:特記事項
特になし
3-2-1-9 IC_HMI_TT_ABS
1: APIの名前
IC_HMI_ABS
2:APIの説明
ABS警告灯状態のビットフラグ
3:値
0x0000000000000100
4:特記事項
特になし
3-2-1-10 IC_HMI_TT_LOW_BATTERY
1: APIの名前
IC_HMI_LOW_BATTERY
2:APIの説明
チャージ警告灯状態のビットフラグ
3:値
0x0000000000000200
4:特記事項
特になし
3-2-1-11 IC_HMI_TT_OIL_PRESS
1: APIの名前
IC_HMI_OIL_PRESS
2:APIの説明
オイルプレッシャー警告灯状態のビットフラグ
3:値
0x0000000000000400
4:特記事項
特になし
3-2-1-12 IC_HMI_TT_ENGINE
1: APIの名前
IC_HMI_ENGINE
2:APIの説明
燃料残量警告灯状態のビットフラグ
3:値
0x0000000000000800
4:特記事項
特になし
3-2-1-13 IC_HMI_TT_FUEL
1: APIの名前
IC_HMI_FUEL
2:APIの説明
燃料残量警告灯状態のビットフラグ
3:値
0x0000000000001000
4:特記事項
特になし
3-2-1-14 IC_HMI_TT_IMMOBI
1: APIの名前
IC_HMI_IMMOBI
2:APIの説明
Immobilizer警告灯状態のビットフラグ
3:値
0x0000000000002000
4:特記事項
特になし
3-2-1-15 IC_HMI_TT_TM_FAIL
1: APIの名前
IC_HMI_TM_FAIL
2:APIの説明
TM Failure警告灯状態のビットフラグ
3:値
0x0000000000004000
4:特記事項
特になし
3-2-1-16 IC_HMI_TT_ESP_ACT
1: APIの名前
IC_HMI_ESP_ACT
2:APIの説明
ESP-ACT警告灯状態のビットフラグ
3:値
0x0000000000008000
4:特記事項
特になし
3-2-1-17 IC_HMI_TT_ESP_OFF
1: APIの名前
IC_HMI_ESP_OFF
2:APIの説明
ESP-OFF警告灯状態のビットフラグ
3:値
0x0000000000010000
4:特記事項
特になし
3-2-1-18 IC_HMI_TT_ADAPTING_LIGHTING
1: APIの名前
IC_HMI_ADAPTING_LIGHTING
2:APIの説明
Adapting Lightig警告灯状態のビットフラグ
3:値
0x0000000000020000
4:特記事項
特になし
3-2-1-19 IC_HMI_TT_AUTO_STOP
1: APIの名前
IC_HMI_AUTO_STOP
2:APIの説明
Auto Stop警告灯状態のビットフラグ
3:値
0x0000000000040000
4:特記事項
特になし
3-2-1-20 IC_HMI_TT_AUTO_STOP_FAIL
1: APIの名前
Auto Stop Fail警告灯状態のビットフラグ
2:APIの説明
左方向指示器
3:値
0x0000000000080000
4:特記事項
特になし
3-2-1-21 IC_HMI_TT_PARKING_LIGHTS
1: APIの名前
IC_HMI_PARKING_LIGHTS
2:APIの説明
Parking Lights警告灯状態のビットフラグ
3:値
0x0000000000100000
4:特記事項
特になし
3-2-1-22 IC_HMI_TT_FRONT_FOG
1: APIの名前
IC_HMI_FRONT_FOG
2:APIの説明
FrontFog警告灯状態のビットフラグ
3:値
0x0000000000200000
4:特記事項
特になし
3-2-1-23 IC_HMI_TT_EXTERIOR_LIGHT_FAULT
1: APIの名前
IC_HMI_EXTERIOR_LIGHT_FAULT
2:APIの説明
ExteriorLightFault警告灯状態のビットフラグ
3:値
0x0000000000400000
4:特記事項
特になし
3-2-1-24 IC_HMI_TT_ACC_FAIL
1: APIの名前
IC_HMI_ACC_FAIL
2:APIの説明
ACC-Failure警告灯状態のビットフラグ
3:値
0x0000000000800000
4:特記事項
特になし
3-2-1-25 IC_HMI_TT_LDW_OFF
1: APIの名前
IC_HMI_LDW_OFF
2:APIの説明
Lane Departure Warning OFF警告灯状態のビットフラグ
3:値
0x0000000001000000
4:特記事項
特になし
3-2-1-26 IC_HMI_TT_HILL_DESCENT
1: APIの名前
IC_HMI_HILL_DESCENT
2:APIの説明
Hill-Descent警告灯状態のビットフラグ
3:値
0x0000000002000000
4:特記事項
特になし
3-2-1-27 IC_HMI_TT_AUTO_HI_BEAM_GREEN
1: APIの名前
IC_HMI_AUTO_HI_BEAM_GREEN
2:APIの説明
AutoHiBeamGreen警告灯状態のビットフラグ
3:値
0x0000000004000000
4:特記事項
特になし
3-2-1-28 IC_HMI_TT_AUTO_HI_BEAM_AMBER
1: APIの名前
IC_HMI_AUTO_HI_BEAM_AMBER
2:APIの説明
AutoHiBeamAmber警告灯状態のビットフラグ
3:値
0x0000000008000000
4:特記事項
特になし
3-2-1-29 IC_HMI_TT_LDW_OPERATE
1: APIの名前
IC_HMI_LDW_OPERATE
2:APIの説明
Lane Departure Warning Operate警告灯状態のビットフラグ
3:値
0x0000000010000000
4:特記事項
特になし
3-2-1-30 IC_HMI_TT_GENERAL_WARN
1: APIの名前
IC_HMI_GENERAL_WARN
2:APIの説明
General Warn警告灯状態のビットフラグ
3:値
0x0000000020000000
4:特記事項
特になし
3-2-1-31 IC_HMI_TT_SPORTS_MODE
1: APIの名前
IC_HMI_SPORTS_MODE
2:APIの説明
Sports Mode警告灯状態のビットフラグ
3:値
0x0000000040000000
4:特記事項
特になし
3-2-1-32 IC_HMI_TT_DRIVING_POWER_MODE
1: APIの名前
IC_HMI_DRIVING_POWER_MODE
2:APIの説明
Driver Power Mode警告灯状態のビットフラグ
3:値
0x0000000080000000
4:特記事項
特になし
3-2-1-33 IC_HMI_TT_HOT_TEMP
1: APIの名前
IC_HMI_HOT_TEMP
2:APIの説明
Hot Temp警告灯状態のビットフラグ
3:値
0x0000000100000000
4:特記事項
特になし
3-2-1-34 IC_HMI_TT_LOW_TEMP
1: APIの名前
IC_HMI_TT_LOW_TEMP
2:APIの説明
Low Temp警告灯状態のビットフラグ
3:値
0x0000000200000000
4:特記事項
特になし
3-2-1-35 IC_HMI_TT_ALL
1: APIの名前
IC_HMI_TT_ALL
2:APIの説明
全警告灯をONにするビットフラグ
3:値
0xFFFFFFFFFFFFFFFF
4:特記事項
特になし
3-3 Callback Function
3-3-1 IC_HMI_FUNC_NOTIFY_IC_HMI
1:APIの名前
typedef void(* IC_HMI_FUNC_NOTIFY_IC_HMI)(unsigned long long arg_1,
IC_HMI_ON_OFF arg_2)
2:APIの説明
Event方式で使用するregisterIcHmi関数の引数に渡すコールバック関数の型
3:返り値の型種別
void
4:返り値の詳細
None
5:引数の詳細
unsigned long long arg_1：取得するシグナルに対応したビットフラグ
各ビットに対応するシグナルは3-2-1参照
IC_HMI_ON_OFF arg_2：変化検出後のシグナルの状態
各状態については3-1-1参照
6:特記事項
特筆事項無し
3-4 Telltale
3-4-1 getTurnR
1:プロトタイプ宣言
IC_HMI_ON_OFF getTurnR(void)
2:APIの説明
右方向指示器状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
点滅制御はIC-Serviceでする。
3-4-2 getTurnL
1:プロトタイプ宣言
IC_HMI_ON_OFF getTurnL(void)
2:APIの説明
左方向指示器状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
点滅制御はIC-Serviceでする。
3-4-3 getBrake
1:プロトタイプ宣言
IC_HMI_ON_OFF getBrake(void)
2:APIの説明
ブレーキ警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項なし
3-4-4 getSeatbelt
1:プロトタイプ宣言
IC_HMI_ON_OFF getSeatbelt(void)
2:APIの説明
シートベルト警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項なし
3-4-5 getHighbeam
1:プロトタイプ宣言
IC_HMI_ON_OFF getHighbeam(void)
2:APIの説明
ビームパッシング警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項なし
3-4-6 getDoor
1:プロトタイプ宣言
IC_HMI_ON_OFF getDoor(void)
2:APIの説明
半ドア警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項なし
3-4-7 getEps
1:プロトタイプ宣言
IC_HMI_ON_OFF getEps(void)
2:APIの説明
EPS警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項無し
3-4-8 getSrsAirbag
1:プロトタイプ宣言
IC_HMI_ON_OFF getSrsAirbag(void)
2:APIの説明
SRSエアバッグ警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項無し
3-4-9 getAbs
1:プロトタイプ宣言
IC_HMI_ON_OFF getAbs(void)
2:APIの説明
ABS警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項無し
3-4-10 getLowBattery
1:プロトタイプ宣言
IC_HMI_ON_OFF getLowBattery(void)
2:APIの説明
チャージ警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項無し
3-4-11 getOilPress
1:プロトタイプ宣言
IC_HMI_ON_OFF getOilPress(void)
2:APIの説明
オイルプレッシャー警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項無し
3-4-12 getEngine
1:プロトタイプ宣言
IC_HMI_ON_OFF getEngine(void)
2:APIの説明
燃料残量警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項なし
3-4-13 getFuel
1:プロトタイプ宣言
IC_HMI_ON_OFF getFuel(void)
2:APIの説明
燃料残量警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項無し。
3-4-14 getImmobi
1:プロトタイプ宣言
IC_HMI_ON_OFF getImmobi(void)
2:APIの説明
Immobilizer警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項無し。
3-4-15 getTMFail
1:プロトタイプ宣言
IC_HMI_ON_OFF getTMFail(void)
2:APIの説明
TM Failure警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項無し。
3-4-16 getEspAct
1:プロトタイプ宣言
IC_HMI_ON_OFF getEspAct(void)
2:APIの説明
ESP-ACT警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項無し。
3-4-17 getEspOff
1:プロトタイプ宣言
IC_HMI_ON_OFF getEspOff(void)
2:APIの説明
ESP-OFF警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項無し。
3-4-18 getAdaptingLighting
1:プロトタイプ宣言
IC_HMI_ON_OFF getAdaptingLighting(void)
2:APIの説明
Adapting Lightig警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項無し。
3-4-19 getAutoStop
1:プロトタイプ宣言
IC_HMI_ON_OFF getAutoStop(void)
2:APIの説明
Auto Stop警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項無し。
3-4-20 getAutoStopFail
1:プロトタイプ宣言
IC_HMI_ON_OFF getAutoStopFail(void)
2:APIの説明
Auto Stop Fail警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項無し。
3-4-21 getParkingLights
1:プロトタイプ宣言
IC_HMI_ON_OFF getParkingLights(void)
2:APIの説明
Parking Lights警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項無し。
3-4-22 getFrontFog
1:プロトタイプ宣言
IC_HMI_ON_OFF getFrontFog(void)
2:APIの説明
FrontFog警告灯状態を取得する。
3:返り値の型種別
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
4:返り値の詳細
IC_HMI_ON_OFFの要素
5:引数の詳細
None
6:特記事項
特筆事項無し。
3-4-23 getExteriorLightFault
1:プロトタイプ宣言
IC_HMI_ON_OFF getExteriorLightFault(void)
2:APIの説明
ExteriorLightFault警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項無し。
3-4-24 getAccFail
1:プロトタイプ宣言
IC_HMI_ON_OFF getAccFail(void)
2:APIの説明
ACC-Failure警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項無し。
3-4-25 getLdwOff
1:プロトタイプ宣言
IC_HMI_ON_OFF getLdwOff(void)
2:APIの説明
Lane Departure Warning OFF警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項無し。
3-4-26 getHillDescent
1:プロトタイプ宣言
IC_HMI_ON_OFF getHillDescent(void)
2:APIの説明
Hill-Descent警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項無し。
3-4-27 getAutoHiBeamGreen
1:プロトタイプ宣言
IC_HMI_ON_OFF getAutoHiBeamGreen(void)
2:APIの説明
AutoHiBeamGreen警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項無し。
3-4-28 getAutoHiBeamAmber
1:プロトタイプ宣言
IC_HMI_ON_OFF getAutoHiBeamAmber(void)
2:APIの説明
AutoHiBeamAmber警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項無し。
3-4-29 getSportsMode
1:プロトタイプ宣言
IC_HMI_ON_OFF getSportsMode(void)
2:APIの説明
Sports Mode警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項無し。
3-4-30 getLdwOperate
1:プロトタイプ宣言
IC_HMI_ON_OFF getLdwOperate(void)
2:APIの説明
Lane Departure Warning Operate警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項無し。
3-4-31 getGeneralWarn
1:プロトタイプ宣言
IC_HMI_ON_OFF getGeneralWarn(void)
2:APIの説明
General Warn警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項無し。
3-4-32 getDrivingPowerMode
1:プロトタイプ宣言
IC_HMI_ON_OFF getDriverPowerMode(void)
2:APIの説明
Driver Power Mode警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項無し。
3-4-33 getHotTemp
1:プロトタイプ宣言
IC_HMI_ON_OFF getHotTemp(void)
2:APIの説明
Hot Temp警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項無し。
3-4-34 getLowTemp
1:プロトタイプ宣言
IC_HMI_ON_OFF getLowTemp(void)
2:APIの説明
Low Temp警告灯状態を取得する。
3:返り値の型種別
IC_HMI_ON_OFF
4:返り値の詳細
IC_HMI_OFF ：消灯
IC_HMI_ON ：点灯
5:引数の詳細
None
6:特記事項
特筆事項無し。
3-5 ShiftPosition
3-5-1 getGearAtVal
1:プロトタイプ宣言
IC_HMI_GEAR_AT_VAL getGearAtVal(void)
2:APIの説明
ギア状態値を取得する。
3:返り値の型種別
IC_HMI_GEAR_AT_VAL
4:返り値の詳細
0：IC_HMI_AT_OFF ギアが非表示状態を表す。
1：IC_HMI_AT_PARKING ギアがParking状態を表す。
2：IC_HMI_AT_REVERSE ギアがReverse状態を表す。
3：IC_HMI_AT_NEUTRAL ギアがNeutral状態を表す。
4：IC_HMI_AT_DRIVE ギアがDrive状態を表す。
5：IC_HMI_AT_SECOND ギアがSecond状態を表す。
6：IC_HMI_AT_LOW_GEAR ギアがLowGear状態を表す。
7：IC_HMI_AT_FIRST ギアがFirst状態を表す。
8：IC_HMI_AT_MANUAL ギアがManual状態を表す。
9：IC_HMI_AT_BRAKE ギアがBrake状態を表す。
10：IC_HMI_AT_ALL_ON 故障全点灯状態を表す。
11：IC_HMI_AT_ALL_OFF 故障全消灯状態を表す。
12：IC_HMI_AT_UNUSED ギアが未使用状態を表す。
5:引数の詳細
None
6:特記事項
特筆事項無し。
3-5-2 getGearMtVal
1:プロトタイプ宣言
IC_HMI_GEAR_MT_VAL getGearMtVal(void)
2:APIの説明
ギア状態値を取得する。
3:返り値の型種別
IC_HMI_GEAR_MT_VAL
4:返り値の詳細
0：IC_HMI_MT_OFF ギアが非表示状態を表す。
1：IC_HMI_MT_FIRST ギアが1速状態を表す。
2：IC_HMI_MT_SECOND ギアが2速状態を表す。
3：IC_HMI_MT_THIRD ギアが3速状態を表す。
4：IC_HMI_MT_FOURTH ギアが4速状態を表す。
5：IC_HMI_MT_FIFTH ギアが5速状態を表す。
6：IC_HMI_MT_SIXTH ギアが6速状態を表す。
7：IC_HMI_MT_SEVENTH ギアが7速状態を表す。
8：IC_HMI_MT_EIGHTH ギアが8速状態を表す。
5:引数の詳細
None
6:特記事項
特筆事項無し。
3-6 Speed
3-6-1 getSpAnalogVal
1:プロトタイプ宣言
unsigned long getSpAnalogVal(void)
2:APIの説明
車速アナログ指示値(分解能：0.01 平滑化処理後の値)を取得する。
3:返り値の型種別
unsigned long
4:返り値の詳細
0x00000000 ：Min Speed (0.00)
0x00007530 ：Max Speed (300.00)
0x000007531~0xFFFFFFFF ：未使用 (300.01~42949672.95)
5:引数の詳細
None
6:特記事項
単位は仕向依存で対応する
3-6-2 getSpAnaDigUnitVal
1:プロトタイプ宣言
IC_HMI_SP_UNIT_VAL getSpAnaDigUnitVal(void)
2:APIの説明
車速単位を取得する。
3:返り値の型種別
IC_HMI_SP_UNIT_VAL
4:返り値の詳細
0：IC_HMI_SP_KM_H 車速単位をkm/hで表示する。
1：IC_HMI_SP_MPH 車速単位をmphで表示する。
5:引数の詳細
None
6:特記事項
特筆事項無し
3-7 Tacho
3-7-1 getTaAnalogVal
1:プロトタイプ宣言
unsigned long getTaAnalogVal(void)
2:APIの説明
Tachoアナログ指示値(分解能：1 平滑化処理後の値)を取得する。単位はrpm。
3:返り値の型種別
unsigned long
4:返り値の詳細
0x00000000 ：Min rpm (0)
0x00004E20 ：Max rpm (20000)
0x000007531~0xFFFFFFFF ：未使用 (20001~4294967295)
5:引数の詳細
None
6:特記事項
特筆事項無し
3-8 TripComputer
3-8-1 getTrcomTripAVal
1:プロトタイプ宣言
unsigned long getTrcomTripAVal(void)
2:APIの説明
TripA値(分解能：0.1)を取得する。
3:返り値の型種別
unsigned long
4:返り値の詳細
0x00000000 ：TripA Min (0.0)
0x0001869F ：TripA Max (9999.9)
0x00018670 ~0xFFFFFFFD ：未使用 (1000.0~429496729.5)
0xFFFFFFFE ：”—“表示
0xFFFFFFFF ：非表示
5:引数の詳細
None
6:特記事項
表示桁数は機種依存にする
3-8-2 getTrcomTripBVal
1:プロトタイプ宣言
unsigned long getTrcomTripBVal(void)
2:APIの説明
TripB値(分解能：0.1)を取得する。
3:返り値の型種別
unsigned long
4:返り値の詳細
0x00000000 ：TripB Min (0.0)
0x0001869F ：TripB Max (9999.9)
0x00018670 ~0xFFFFFFFD ：未使用 (1000.0~429496729.5)
0xFFFFFFFE ：”—“表示
0xFFFFFFFF ：非表示
5:引数の詳細
None
6:特記事項
表示桁数は機種依存にする。
3-8-3 getTrcomOdoVal
1:プロトタイプ宣言
unsigned long getTrcomOdoVal(void)
2:APIの説明
ODO値(分解能：1)を取得する。
3:返り値の型種別
unsigned long
4:返り値の詳細
0x00000000 ：ODO Min (0)
0x000F423F ：ODO Max (999999)
0x000F4240 ~0xFFFFFFFD ：未使用 (1000000~4294967295)
0xFFFFFFFE ：”—“表示
0xFFFFFFFF ：非表示
5:引数の詳細
None
6:特記事項
表示桁数は機種依存にする。
3-8-4 getTrcomUnitVal
1:プロトタイプ宣言
IC_HMI_TRCOM_UNIT_VAL getTrcomUnitVal(void)
2:APIの説明
トリップコンピュータ単位を取得する。
3:返り値の型種別
IC_HMI_TRCOM_UNIT_VAL
4:返り値の詳細
0：IC_HMI_TRCOM_KM トリップコンピュータ単位をkmで表示する。
1：IC_HMI_TRCOM_MILE トリップコンピュータ単位をmileで表示する。
5:引数の詳細
TripA/BおよびODO値の単位取得に使用する。
3-8-4 getAvgSpeedAVal
1:プロトタイプ宣言
unsigned char getAveSpeedAVal(void)
2:APIの説明
TripAと連動した平均車速値(分解能：1)を取得する。
3:返り値の型種別
unsigned char
4:返り値の詳細
0x00 ：Average Speed A Min (0)
0xFD ：Average Speed A Max (253)
0xFE ：”—“表示
0xFF ：非表示
5:引数の詳細
None
6:特記事項
表示範囲は機種依存にする。
3-8-5 getAvgSpeedBVal
1:プロトタイプ宣言
unsigned char getAveSpeedBVal(void)
2:APIの説明
TripBと平均車速値(分解能：1)を取得する。
3:返り値の型種別
unsigned char
4:返り値の詳細
0x00 ：Average Speed B Min (0)
0xFD ：Average Speed B Max (253)
0xFE ：”—“表示
0xFF ：非表示
5:引数の詳細
None
6:特記事項
表示範囲は機種依存にする。
3-8-6 getHourAVal
1:プロトタイプ宣言
unsigned short getHourAVal(void)
2:APIの説明
TripAと連動した経過時間(時) (分解能：1) を取得する。
3:返り値の型種別
unsigned short
4:返り値の詳細
0x0000 ：Hour A Min (0)
0x03E7 ：Hour A Max (999)
0x03E8~0xFFFD ：未使用 (1000~65533)
0xFFFE ：”—“表示
0xFFFF ：非表示
5:引数の詳細
None
6:特記事項
表示範囲は機種依存にする。
3-8-7 getHourBVal
1:プロトタイプ宣言
unsigned short getHourBVal(void)
2:APIの説明
TripBと連動した経過時間(時) (分解能：1)を取得する。
3:返り値の型種別
unsigned short
4:返り値の詳細
0x0000 ：Hour B Min (0)
0x03E7 ：Hour B Max (999)
0x03E8~0xFFFD ：未使用 (1000~65533)
0xFFFE ：”—“表示
0xFFFF ：非表示
5:引数の詳細
None
6:特記事項
表示範囲は機種依存にする。
3-8-8 getMinuteAVal
1:プロトタイプ宣言
unsigned char getMinuteAVal(void)
2:APIの説明
TripAと連動した経過時間(分) (分解能：1)を取得する。
3:返り値の型種別
unsigned char
4:返り値の詳細
0x00 ：Minute A Min (0)
0x3B ：Minute A Max (59)
0x3C ~ 0xFD ：未使用 (60~253)
0xFÊ ：”—“表示
0xFF ：非表示
5:引数の詳細
None
6:特記事項
表示範囲は機種依存にする。
3-8-9 getMinuteBVal
1:プロトタイプ宣言
unsigned char getMinuteBVal(void)
2:APIの説明
TripBと連動した経過時間(分) (分解能：1)を取得する。
3:返り値の型種別
unsigned char
4:返り値の詳細
0x00 ：Minute B Min (0)
0x3B ：Minute B Max (59)
0x3C ~ 0xFD ：未使用 (60~253)
0xFÊ ：”—“表示
0xFF ：非表示
5:引数の詳細
None
6:特記事項
表示範囲は機種依存にする。
3-8-10 getSecondAVal
1:プロトタイプ宣言
unsigned char getSecondAVal(void)
2:APIの説明
TripAと連動した経過時間(秒) (分解能：1)を取得する。
3:返り値の型種別
unsigned char
4:返り値の詳細
0x00 ：Second A Min (0)
0x3B ：Second A Max (59)
0x3C ~ 0xFD ：未使用 (60~253)
0xFÊ ：”—“表示
0xFF ：非表示
5:引数の詳細
None
6:特記事項
表示範囲は機種依存にする。
3-8-11 getSecondBVal
1:プロトタイプ宣言
unsigned char getSecondBVal(void)
2:APIの説明
TripBと連動した経過時間(秒) (分解能：1)を取得する。
3:返り値の型種別
unsigned char
4:返り値の詳細
0x00 ：Second B Min (0)
0x3B ：Second B Max (59)
0x3C ~ 0xFD ：未使用 (60~253)
0xFÊ ：”—“表示
0xFF ：非表示
5:引数の詳細
None
6:特記事項
表示範囲は機種依存にする。
3-8-12 getOTempVal
1:プロトタイプ宣言
signed short getOTempVal(void)
2:APIの説明
外気温表示値(分解能：1)を取得する。
3:返り値の型種別
Signed short
4:返り値の詳細
0x8001~-0xFFD7 ：未使用 (-32767 ~ -41)
0xFFD8 ：Outside Temp Min (-40)
0x0083 ：Outside Temp Max (131)
0x0084 ~0x7FFE ：未使用 (132~32765)
0x7FFE ：”—“表示 (32766)
0x7FFF ：非表示 (32767)
5:引数の詳細
None
6:特記事項
表示範囲は機種依存にする。
3-8-13 getCruRangeVal
1:プロトタイプ宣言
unsigned short getCruRangeVal(void)
2:APIの説明
航続距離可能表示値(分解能：1)を取得する。
3:返り値の型種別
unsigned short
4:返り値の詳細
0x0000 ：Cruise Range Min (0)
0x064A ：Cruise Range Max (1610)
0x064B ~ 0xFFFD ：未使用 (1611~65533)
0xFFFE ：”—“表示
0xFFFF ：非表示
5:引数の詳細
None
6:特記事項
表示範囲は機種依存にする。
3-8-14 getAvgFuelAVal
1:プロトタイプ宣言
unsigned short getAvgFuelAVal(void)
2:APIの説明
TripAと連動した平均燃費値(分解能：0.1)を取得する。
3:返り値の型種別
unsigned short
4:返り値の詳細
0x0000 ：Average Fuel TripA Min (0.0)
0x07CF ：Average Fuel TripA Max (199.9)
0x07D0 ~ 0xFFFD ：未使用 (200.0~6553.3)
0xFFFE ：”—“表示
0xFFFF ：非表示
5:引数の詳細
None
6:特記事項
表示範囲は機種依存にする。
3-8-15 getAvgFuelBVal
1:プロトタイプ宣言
unsigned short getAvgFuelBVal(void)
2:APIの説明
TripBと連動した平均燃費値(分解能：0.1)を取得する。
3:返り値の型種別
unsigned short
4:返り値の詳細
0x0000 ：Average Fuel TripB Min (0.0)
0x07CF ：Average Fuel TripB Max (199.9)
0x07D0 ~ 0xFFFD ：未使用 (200.0~6553.3)
0xFFFE ：”—“表示
0xFFFF ：非表示
5:引数の詳細
None
6:特記事項
表示範囲は機種依存にする。
3-8-16 getInsFuelAVal
1:プロトタイプ宣言
unsigned short getInsAVal(void)
2:APIの説明
TripAと連動した瞬間燃費値(分解能：0.1)を取得する。
3:返り値の型種別
unsigned short
4:返り値の詳細
0x0000 ：Instant Fuel TripA Min (0.0)
0x07CF ：Instant Fuel TripA Max (199.9)
0x07D0 ~ 0xFFFD ：未使用 (200.0~6553.3)
0xFFFE ：”—“表示
0xFFFF ：非表示
5:引数の詳細
None
6:特記事項
表示範囲は機種依存にする。
3-8-17 getInsFuelBVal
1:プロトタイプ宣言
unsigned short getInsBVal(void)
2:APIの説明
TripBと連動した瞬間燃費値(分解能：0.1)を取得する。
3:返り値の型種別
unsigned short
4:返り値の詳細
0x0000 ：Instant Fuel TripA Min (0.0)
0x07CF ：Instant Fuel TripA Max (199.9)
0x07D0 ~ 0xFFFD ：未使用 (200.0~6553.3)
0xFFFE ：”—“表示
0xFFFF ：非表示
5:引数の詳細
None
6:特記事項
表示範囲は機種依存にする。
3-8-18 getFuelEconomyUnitVal
1:プロトタイプ宣言
IC_HMI_FUEL_ECONOMY_UNIT_VAL getFuelEconomyUnitVal(void)
2:APIの説明
燃費表示単位を取得する。
3:返り値の型種別
IC_HMI_FUEL_ECONOMY_UNIT_VAL
4:返り値の詳細
0：IC_HMI_FUEL_KM_L 燃費表示単位をkm/Lで表示する。
1：IC_HMI_FUEL_MPG_US 燃費表示単位をMPG(U.S gallon)で表示する。
2：IC_HMI_FUEL_MPG_IG 燃費表示単位をMPG(imperial gallon)で表示する。
3：IC_HMI_FUEL_L_100KM 燃費表示単位をL/100kmで表示する。
4：IC_HMI_FUEL_MILE_KWH 燃費表示単位をmile/kwhで表示する。
5：IC_HMI_FUEL_KM_KWH 燃費表示単位をkm/kwhで表示する。
6：IC_HMI_FUEL_MILE_KG 燃費表示単位をmile/kgで表示する。
7：IC_HMI_FUEL_KM_KG 燃費表示単位をkm/kgで表示する。
8：IC_HMI_FUEL_KWH_100KM 燃費表示単位をkwh/100kmで表示する。
5:引数の詳細
平均燃費と瞬間燃費の単位取得に使用する。
6:特記事項
特記事項無し
3-9 Register/Notify
3-9-1 registerIcHmi
1:プロトタイプ宣言
bool registerIcHmi(unsigned long long arg_1,
IC_HMI_FUNC_NOTIFY_IC_HMI addr)
2:APIの説明
Event方式通信においてCluster UI側で取得したいシグナルを決定するために使用される。通信方式については2章参照。
シグナル決定方法は第1引数にマスクビットを指定し、立ったフラグに該当するシグナルを取得する。第2引数にはアプリケーション側で作成したコールバック関数を指定する。
3:返り値の型種別
bool
4:返り値の詳細
true ：登録成功
false ：登録失敗
5:引数の詳細
unsigned long long arg_1 ：取得するシグナルに対するビットフラグ。
各ビットに対応するシグナルは3-2-1参照。
未使用フラグを設定した場合は無視する。
IC_HMI_FUNC_NOTIFY_IC_HMI addr：定義されたコールバック関数の先頭アドレス。
コールバック関数の詳細は3-3-1参照。
addrにnullが設定された場合、登録失敗とする。
6:特記事項
TurnRとTurnLのシグナルを登録する場合の実装例を以下に示す。
registerIcHmi((IC_HMI_TT_TURN_R||IC_HMI_TT_TURN_L ),
IC_HMI_FUNC_NOTIFY_IC_HMI addr)
当該シグナル変化検出時にaddrで指定したコールバック関数が呼ばれる。
3-9-2 notifyIcHmi
1:プロトタイプ宣言
void notifyIcHmi(unsigned long long arg_1, IC_HMI_ON_OFF arg_2)
2:APIの説明
登録されたシグナルが変更されたことをIC-ServiceからCluster UIに通知する。変化されたタイミングで本関数は呼ばれる。第1引数にはどのシグナルかを示すビットフラグ、第2引数には変化後の値が通知される。
3:返り値の型種別
void
4:返り値の詳細
None
5:引数の詳細
unsigned long long arg_1：取得するシグナルに対応したビットフラグ。
各シグナルのビットフラグは3-2-1参照
IC_HMI_ON_OFF arg_2：変化検出後のシグナルの状態
各状態については3-1-1参照
6:特記事項
当該シグナル変化検出時に3-9-1で指定したコールバック関数が呼ばれる
void notifyIcHmi(unsigned long long arg_1, IC_HMI_ON_OFF arg_2)
{
if(arg_1 == TRUN_R){
//TurnR変化検出時の処理
if(arg_2 == IC_HMI_ON){
//ON時の処理
}else{
//OFF時の処理
}
}
}