imx219制御用関数一覧
#-----------------------------------------------------------------------
# Copyright(c) 2020 Soho Enterprise Ltd. (https://soho-enterprise.com/)
#-----------------------------------------------------------------------

#-----------------------------------------------------------------------
名前
	imx219OpenSensor --- imx219デバイスをオープンする
書式
	C) int imx219OpenSensor(int mode)
	P) status,width,height = imx219.OpenSensor(mode)
説明
	imx219デバイスをオープンします。
	引数にはセンサーのモードを設定します。
	使用できるモードは、imx219DispMode() で知ることができます。
	返り値は、imx219CloseSensorの引数として渡す必要があります。
	Pythonの場合は、widthとheightも同時に取得します。
返り値
	 0 ……正常終了
	<0 ……エラー
関連項目
	imx219CloseSensor()
	imx219DispMode()

#-----------------------------------------------------------------------
名前
	imx219CloseSendor --- imx219デバイスをクローズする
書式
	C) int imx219CloseSensor(int val)
	P) status = imx219.CloseSensor(val)
説明
	imx219デバイスをクローズします。
	引数には、imx219OpenSensor() の返り値を設定します。
返り値
	 0 ……正常終了
	<0 ……エラー
関連項目
	imx219OpenSensor()

#-----------------------------------------------------------------------
名前
	imx219ReadRAW10 --- フレーム画像を読み込む(RAW10)
書式
	C) int imx219ReadRAW10(unsigned char *buf)
	P) status = imx219.ReadRAW10(buf)
説明
	１フレームの画像データを読み込みます。
	引数には、読み込んだ画像データを格納する領域を指定します。
	RAW10で読み込みますので、画角x5/4倍の領域を指定する必要があります。
	下記の形式で読み込まれます。
	+-+-+-+-+-+-+-+-+-+-+-+-
	|B|G|B|G|e|B|G|B|G|e|....
	+-+-+-+-+-+-+-+-+-+-+-+-
	|G|R|G|R|e|G|R|G|R|e|....
	+-+-+-+-+-+-+-+-+-+-+-+-
返り値
	0 ‥ ‥   未読み込み
	1 ‥ ‥   読み込み終了
関連項目
	なし

#-----------------------------------------------------------------------
名前
	imx219ReadRAW8 --- フレーム画像を読み込む(RAW8)
書式
	C) int imx219ReadRAW8(unsigned char *buf)
	P) status = imx219.ReadRAW8(buf)
説明
	１フレームの画像データを読み込みます。
	引数には、読み込んだ画像データを格納する領域を指定します。
	画角分の領域を指定する必要があります。
	下記の形式で読み込まれます。
	+-+-+-+-+-+-+-+-+-+-+-+-
	|B|G|B|G|B|G|B|G|B|G|....
	+-+-+-+-+-+-+-+-+-+-+-+-
	|G|R|G|R|G|R|G|R|G|R|....
	+-+-+-+-+-+-+-+-+-+-+-+-
返り値
	0 ‥ ‥   未読み込み
	1 ‥ ‥   読み込み終了
関連項目

#-----------------------------------------------------------------------
名前
	imx219SetFrameLength --- Frame Lengthを設定する
書式
	C) imx219SetFrameLength(int val)
	P) imx219.SetFrameLength(val)
説明
	Frame Lengthを設定します。
	引数で指定した値をレジスタアドレス 0x0160:0x0161 に書き込みます。
返り値
	なし
関連項目
	imx219SetReg()
	imx219GetReg()

#-----------------------------------------------------------------------
名前
	imx219SetAnaGain --- アナログゲインを設定する 
書式
	C) imx219SetAnaGain(int val)
	P) imx219.SetAnaGain(val)
説明
	アナログゲインを設定します。
	引数で指定した値をレジスタアドレス 0x0157 に書き込みます。
	指定できる値は、０〜232 です。
	関数内では、設定値の範囲チェックは行いません。
返り値
	なし
関連項目
	imx219SetReg()
	imx219GetReg()

#-----------------------------------------------------------------------
名前
	imx219SetDigGain --- デジタルゲインを設定する 
書式
	C) imx219SetDigGain(int val)
	P) imx219.SetDigGain(val)
説明
	デジタルゲインを設定します。
	引数で指定した値をレジスタアドレス 0x0158:0x0159 に書き込みます。
	指定できる値は、０〜4057 です。
	関数内では、設定値の範囲チェックは行いません。
返り値
	なし
関連項目
	imx219SetReg()
	imx219GetReg()

#-----------------------------------------------------------------------
名前
	imx219SetExposure --- 露光を設定する 
書式
	C) imx219SetExposure(int val)
	P) imx219.SetExposure(val)
説明
	露光を設定します。
	引数で指定した値をレジスタアドレス 0x015A:0x015B に書き込みます。
	関数内では、設定値の範囲チェックは行いません。
	露光値はライン数単位で設定可能です。
	１フレームのライン数を超えて設定することも可能です。
	１フレームの垂直のライン数を超える場合は垂直ブランキング期間が延びます。
	結果的にフレームレートが減少します。
返り値
	なし
関連項目
	imx219SetReg()
	imx219GetReg()

#-----------------------------------------------------------------------
名前
	imx219SetReg --- 指定したレジスタドレスに値を設定する 
書式
	C) imx219SetReg(int address, int byte_num, int val)
	P) imx219.SetReg(address, byte_num, val)
説明
	指定したレジスタアドレスに値を書き込みます。
	書き込むバイト数も指定します。
	デジタルゲインを設定したい場合は、
	imx219SetReg(0x0158, 2, val) のように設定します。
	アナログゲインを設定したい場合は、
	imx219SetReg(0x0157, 1, val) のように設定します。
返り値
	なし
関連項目
	imx219GetReg()

#-----------------------------------------------------------------------
名前
	imx219GetReg --- 指定したレジスタドレスの値を取得する 
書式
	C) val = imx219GetReg(int address, int byte_num)
	P) val = imx219.GetReg(address, byte_num)
説明
	指定したレジスタアドレスの値を読み込みます。
	読み込むバイト数も指定します。
	指定できるバイト数は１または２です。それ以外はエラー(-1)になります。
	デジタルゲインを取得したい場合は、
	val = imx219SetReg(0x0158, 2) のように設定します。
	アナログゲインを取得したい場合は、
	val = imx219SetReg(0x0157, 1) のように設定します。
返り値
	取得した値
	-1 ……エラー (エラーメッセージが表示されます)
関連項目
	imx219SetReg()

#-----------------------------------------------------------------------
名前
	imx219GetWidth --- 画角の幅を取得する 
書式
	C) val = imx219GetWidth()
	P) val = imx219.GetWidth()
説明
	画角の幅を取得します。
	この関数の実行前に、imx219OpenSensor()を実行しておく必要があります。
	Pythonでは、imx219.OpenSensor()実行時に width,height も同時に
	取得しすので、本関数は不要です。
返り値
	取得した画角の幅
関連項目
	imx219OpenSensor()

#-----------------------------------------------------------------------
名前
	imx219GetWidth --- 画角の高さを取得する 
書式
	C) val = imx219GetHeight()
	P) val = imx219.GetHeight()
説明
	画角の幅を取得します。
	この関数の実行前に、imx219OpenSensor()を実行しておく必要があります。
	Pythonでは、imx219.OpenSensor()実行時に width,height も同時に
	取得しすので、本関数は不要です。
返り値
	取得した画角の高さ
関連項目
	imx219OpenSensor()

#-----------------------------------------------------------------------
名前
	imx219DispMode --- 使用できる mode を表示する
書式
	C) imx219DispMode()
	P) imx219.DispMode()
説明
	imx219OpenSensor() で指定できる mode を表示します。
	各モードで設定されるレジスタアドレスと設定値も表示します。
返り値
	なし
関連項目
	imx219OpenSensor()
