HN 日本語サマリー

← 一覧へ戻る
プログラミング

35ドルのバックカメラディスプレイ(AMT630A)のリバースエンジニアリング

Reverse-engineering a $35 backup camera display (AMT630A) (github.com)

82 pointsby mogrinz25 コメント

要約

AMT630AベースのコンポジットビデオLCDモニターボードのオン・スクリーン・ディスプレイ(OSD)エンジンを制御するためのArduino/ESP32ライブラリが公開されました。このライブラリは、テキスト、カスタムグリフ、ビットマップ、パレットアニメーション、ウィンドウ操作など、OSDの機能をArduino APIとして提供します。また、隠しファクトリーメニューへのアクセスを自動化する機能も含まれており、ハードウェアの解析とライブラリ開発に関する詳細が解説されています。

全文翻訳

AMT630A OSD

AMT630AベースのコンポジットビデオLCDモニターボードのハードウェアオン・スクリーン・ディスプレイ(OSD)エンジンを制御するためのArduino/ESP32ライブラリ。

バージョン 0.7.0

プロジェクト動画

[画像: YouTubeでAMT630A OSD / Robby HUDプロジェクトを見る]

YouTubeで視聴

このライブラリは、AMT630Aの5つのハードウェアOSDウィンドウを、テキスト、カスタムグリフ、16色4bppビットマップ、パレットアニメーション、不透明度/ビデオブレンド、スケーリング、点滅領域、ウィンドウ移動のための実用的なArduino APIとして公開します。また、Pythonの画像コンバーターと、テスト済みの3ボタンモニターファームウェアの隠しファクトリーメニューに入るためのオプションの自動化も含まれています。

ハードウェアステータス: このプロジェクトは、実際のAMT630Aモニターボードのハードウェアテストとリバースエンジニアリングに基づいています。AMT630A製品がすべて同じファームウェア、パネルタイミング、キーパッド回路、または公開されたI2C接続を使用しているとは限りません。ハードウェア/ファームウェア固有とマークされた機能は、そのように扱う必要があります。

特徴

  • 独立して配置可能な5つのAMT630A OSDウィンドウ。
  • LargeFont(16x22セルジオメトリ)とSmallFont(10x16セルジオメトリ)。
  • テキスト描画、前景/背景色、中央揃え文字列、バー、矩形、および生のグリフID。
  • 共有512セルIndex RAM割り当てと検査ヘルパー。
  • Font RAMに格納されたLargeFontカスタムグリフ。
  • 16x22 LargeFont互換タイルを使用した4bppビットマップリソース。
  • 4096ワード/8192バイトのFont RAMビットマップアロケーター。
  • グローバル16エントリビットマップパレット、RGBヘルパー、パレット0の透明度、パレットアニメーション。
  • グローバルOSD/ビデオブレンド、不透明度、明るさコントロール。
  • ウィンドウごとの1x~4xの水平および垂直スケーリング。
  • ハードウェア点滅領域サポート。
  • 軽量なウィンドウ移動およびバッチ更新API。
  • RGB444対応量子化、共有パレット、メモリ制限、プレビュー出力を備えたPython GIF/PNG/JPEG/BMPからArduinoビットマップへのコンバーター。
  • LargeFontおよびSmallFont文字セットブラウザの例。
  • 互換性のあるストックファームウェア向けのオプションのGPIO駆動ファクトリーメニューキーパッド自動化。

インストール

Arduino Library Manager

このリポジトリがArduino Library Managerレジストリに登録された後:

  1. Arduino IDEを開きます。
  2. スケッチ > ライブラリをインクルード > ライブラリを管理... を選択します(またはArduino IDE 2.xでライブラリマネージャーを開きます)。
  3. AMT630A OSD を検索します。
  4. 希望のバージョンを選択して インストール をクリックします。
ZIPからインストール

リリースZIPをダウンロードし、Arduino IDEで スケッチ > ライブラリをインクルード > ZIPライブラリを追加... を選択してインストールします。

ソースからインストール

リポジトリをクローンまたはコピーして、Arduinoスケッチブックの libraries ディレクトリに配置します。IDEが開いている場合は再起動してください。

基本的な配線

ライブラリはI2C経由でAMT630Aと通信します。begin() で使用されるデフォルトのESP32ピンは次のとおりです。

シグナルデフォルトESP32ピン
SDAGPIO 21
SCLGPIO 22

ESP32とモニター電子機器の間は常にGNDを接続してください。すべてのAMT630Aモニターが同じテストパッド、電圧レベル、電源入力、またはキーパッド配置を公開しているとは想定しないでください。接続する前にご自身のボードを確認してください。

カスタムピンとI2Cクロックは begin() に渡すことができます。

display.begin(21, 22, 100000);

最小限のテキスト例

#include <AMT630A_OSD.h>

AMT630A_OSD display;

void setup() {
  Serial.begin(115200);

  if (!display.begin()) return;
  if (!display.setFontMode(AMT630A_OSD::LargeFont)) return;
  if (!display.configureWindow(0, 160, 44)) return;

  display.setDisplayOrigin(0, 40, 40);
  display.writeString(0, 0, 0, "HELLO", AMT630A_OSD::White);
  display.setVisible(0, true);
  display.forceUpdate();
}

void loop() {
  display.service();
}

重要なストックファームウェア/C6所有権に関する注意

AMT630Aは、内部8051 MCUまたは外部I2Cのどちらが内部レジスタを制御するかを選択するためにSYSレジスタ C6 を使用します。テスト済みのモニターでは、ストックファームウェアは定期的に内部ビデオ/デコーダーレジスタにアクセスし、通常はMCUの所有権を期待します。通常のストックファームウェア操作中に継続的に外部所有権を取得すると、OSDとライブコンポジットビデオの両方を含む、ディスプレイパイプライン全体がフリーズすることが判明しました。

ライブラリはOSDが制御される方法であるため、引き続き外部I2Cメカニズムを使用します。テスト済みの3ボタンモニターでは、長時間の外部OSDアクティビティ中に隠しファクトリーメニューに入ることで、長時間のテスト中に観測された競合/フリーズを防ぐことができました。EnterFactoryMode の例は、既存のキーパッドスイッチに接続された74HC4066を使用してその手順を自動化します。

このファクトリーメニュー手順はファームウェア固有です。begin() によって自動的に呼び出されるわけではなく、他の例にも挿入されません。モニターのファームウェアが異なる場合は、その動作を独立して検証してください。

ファクトリーメニュー自動化

テスト済みのモニターには、パッシブ抵抗ラダーとして実装された3つの物理ボタン(メニュー、+、-)があります。ESP32が電子的にそれらを押せるように、これらのボタン接点の両側に74HC4066の3チャンネルを配置できます。これにより、ESP32/4066回路に電源が入っている間は物理ボタンも使用可能になります。

テスト済みの74HC4066マッピング:

ボタン4066スイッチピン4066制御例ESP32 GPIO
+1, 2135
メニュー3, 4518
-8, 9619
電源VCC 14, GND 73.3 V / GND

デフォルトのライブラリシーケンスは次のとおりです。

メニュー、メニュー、メニュー、-、メニュー、+、-、-、+、+、メニュー

テスト済みのファームウェアでは、シーケンスは明るさがアクティブな間に終了する必要があり、最後のメニュープレスでファクトリー画面が開きます。ハードウェアテストでは、100msのプレス/150msのギャップが最も短い再現可能なタイミングであることが判明しました。例ではマージンとして150ms/200msを使用しています。

display.configureFactoryMenuControl(18, 5, 19); // メニュー、プラス、マイナス
display.setFactoryMenuTiming(150, 200);
display.enterFactoryMode();

FactoryMenuStep と setFactoryMenuSequence() でカスタムシーケンスを指定できます。

setFactoryOSDCoexistence(true) は、ライブラリの可視性管理が、ストックファームウェアによって既に設定されているOSD有効化/点滅ビットを置き換えるのではなく、保持するように指示します。これはファクトリーモードに入るものではありません。例の EnterFactoryMode を参照してください。

フォントと文字セット

フォントモードはグローバルです。

display.setFontMode(AMT630A_OSD::LargeFont);
display.setFontMode(AMT630A_OSD::SmallFont);

検証済みのセルジオメトリ:

モードセルサイズ
LargeFont16 x 22 ピクセル
SmallFont10 x 16 ピクセル

writeString() は一般的なASCII文字をAMT630Aの組み込みROMにマッピングします。writeGlyph() はASCIIマッピングをバイパスし、生の10ビットグリフIDを書き込みます。バンドルされている LargeFontCharacterSetBrowser および SmallFontCharacterSetBrowser の例では、シリアルモニターからモニターのROMを探索できます。検証済みの通常のASCIIによって使用されるSmallFont ROMマッピングは 0x1C0 付近から始まり、数字は 0x1C1、文字は 0x1CB から始まります。

ウィンドウとIndex RAM

5つのハードウェアOSDウィンドウがありますが、すべてが512個のIndex RAMセルを共有します。ウィンドウは視覚的に重なることがありますが、それらのバックエンドIndex RAM割り当ては共有512セルプールに収まる必要があります。

display.configureWindow(0, 160, 66);  // ピクセル; セルに変換済み
display.setDisplayOrigin(0, 30, 30);

検査ヘルパー:

display.getWindowWidth(0);
display.getWindowHeight(0);
display.getColumns(0);
display.getRows(0);
display.getWindowIndexStart(0);
display.getWindowIndexCells(0);
display.getIndexRAMUsed();
display.getIndexRAMFree();

releaseWindow() はウィンドウを解放し、ライブラリが残りのIndex RAM領域を再割り当てできるようにします。

テキストとセルの描画

display.clearWindow(0);
display.clearRegion(0, 2, 1, 4, 2);
display.fillRect(0, 0, 0, 8, 1, AMT630A_OSD::Blue);

display.setCell(0, 0, 0, glyph,
                AMT630A_OSD::White,
                AMT630A_OSD::Blue);

display.writeGlyph(0, 1, 0, 0x123,
                   AMT630A_OSD::White,
                   AMT630A_OSD::Transparent);

display.writeString(0, 0, 1, "READY",
                    AMT630A_OSD::Green,
                    AMT630A_OSD::Transparent);

display.writeStringCentered(0, 2, "CENTERED");
display.writeBar(0, 0, 3, 75, 100, 10, AMT630A_OSD::Green);

利用可能なテキスト色は Transparent、White、Red、Green、Blue、Cyan、Yellow、Black です。

描画はライブラリのRAMコピーを変更し、影響を受けたセルをダーティとしてマークします。updateDisplay() はダーティセルを送信し、forceUpdate() は要求されたウィンドウのすべてのセルを送信します。

可視性とサービス

display.setVisible(0, true);
display.setOSDVisible(true);
display.updateDisplay();

通常の例では、loop() で display.service() を呼び出します。これは、ライブラリ管理の可視性状態とハードウェアを定期的に調整します。間隔は setServiceInterval(milliseconds) で変更できます。

ウィンドウの移動

初期配置には setDisplayOrigin() を使用します。アニメーションの場合、moveWindow() は変更された位置バイトのみを更新し、ウィンドウのジオメトリとIndex RAM割り当てはそのまま維持します。

display.moveWindow(0, x, y);

バッチ更新

if (display.beginBatchUpdate()) {
  display.moveWindow(0, x0, y0);
  display.moveWindow(1, x1, y1);
  display.endBatchUpdate();
}

バッチ呼び出しはネストできます。これらは、操作のグループ中に所有権の遷移を繰り返す回数を減らしますが、バッチ処理は、前述のストックファームウェア所有権の問題を排除するものと解釈しないでください。

スケーリング

5つのウィンドウすべてが同じ公開された1x~4xスケールAPIを提供します。

display.setWindowScale(0, 2);      // XおよびYを2倍
display.setWindowScale(1, 3, 2);   // Xを3倍、Yを2倍
display.getWindowScaleX(0);
display.getWindowScaleY(0);

スケーリングはテキストおよびビットマップウィンドウに適用されます。ウィンドウ0は内部的に異なるAMT630Aスケーラーハードウェアを使用しますが、ライブラリはその違いを隠します。

点滅領域

ハードウェアテスト済みのプライマリ点滅エンジンは、選択されたOSDウィンドウ内の1つの矩形領域を対象とします。座標は1ベースのセル座標です。

display.configureBlink(0, 1, 1, 3, 1, 0x10);
display.setBlinkEnabled(true);

個別のコントロール:

display.setBlinkWindow(0);
display.setBlinkRegion(1, 1, 3, 1);
display.setBlinkRateRaw(0x10);
display.setBlinkEnabled(true);

生の点滅レートは6ビット(0x00~0x3F)です。ハードウェアテストにより、値が小さいほど速く点滅することが確立されました。正確な時間変換はキャリブレーションされていません。

不透明度、明るさ、ビデオブレンド

これらは、5つのウィンドウすべてで共有されるグローバルOSDコントロールです。

display.setBlendingEnabled(true);
display.setOpacity(4);      // 0 透明、7 最大OSD不透明度
display.setBrightness(16);  // 0..31
display.setBlendingEnabled(false);

ゲッターは isBlendingEnabled()、getOpacity()、getBrightness() です。

カスタムLargeFontグリフ

Font RAMは、カスタムLargeFontグリフスロットとビットマップストレージの間でパーティション化できます。

display.configureFontRAM(10);  // 最初に10個のカスタムグリフスロットを予約

カスタムグリフは16行のワードで構成されます。

uint16_t icon[AMT630A_OSD::CUSTOM_GLYPH_ROWS] = {
  // 16行の値...
};

display.loadCustomGlyph(0, icon);
display.writeCustomGlyph(0, 0, 0, 0, AMT630A_OSD::White);

カスタムグリフはLargeFontモードでのみサポートされます。現在のライブラリは、CustomGlyphBitmapConflict により、カスタムグリフとビットマップの同時ロードを意図的に拒否します。それらの安全な共存マッピングは、サポートされる公開機能としては公開されていません。

ビットマップ

ビットマップモードは、AMT630AのFont RAMを4bpp画像ストレージとして使用します。公開されているビットマップサポートは、LargeFontの16x22タイルジオメトリに意図的に結び付けられており、グローバル文字ジオメトリを変更せずにビットマップとLargeFont ROMテキストウィンドウを共存させることができます。

ソース画像は、完全な16x22タイルの数にパディングされます。元の幅と高さは生成されたリソースに残りますが、ストレージはパディングされたタイルグリッドに基づいています。

#include <AMT630A_OSD.h>
#include "MyLogo.h"

AMT630A_OSD display;
AMT630A_OSD::BitmapHandle logo = AMT630A_OSD::INVALID_BITMAP_HANDLE;

void setup() {
  display.begin();
  display.setFontMode(AMT630A_OSD::LargeFont);
  display.configureFontRAM(0);  // すべての8192バイトをビットマップに使用可能

  if (!display.loadBitmap(MyLogo, logo)) return;
  if (!display.configureBitmapWindow(0, logo)) return;

  display.setDisplayOrigin(0, 100, 60);
  display.setVisible(0, true);
  display.forceUpdate();
}

void loop() {
  display.service();
}
Font RAMアカウンティング
display.getBitmapMemoryTotal();       // 16ビットワード
display.getBitmapMemoryUsed();
display.getBitmapMemoryFree();
display.getBitmapMemoryTotalBytes();
display.getBitmapMemoryUsedBytes();
display.getBitmapMemoryFreeBytes();
display.getBitmapCount();

clearBitmaps() は、設定されたウィンドウがそれらのリソースを使用していない場合に、ロードされたビットマップリソースのブックキーピングをクリアします。

4bppパッキング

ハードウェアテストにより、16ビットFont RAMワードあたり4ピクセル(パレットインデックス)が次の順序で格納されることが検証されました。

ビット 15..12 = 最左ピクセル P0
ビット 11..8  = P1
ビット  7..4  = P2
ビット  3..0  = 最右ピクセル P3

等価なパッキング:

(P0 << 12) | (P1 << 8) | (P2 << 4) | P3

ビットマップパレット

すべてのビットマップウィンドウは、1つのグローバルな16エントリハードウェアパレットを共有します。

display.setBitmapPaletteColor(1, 255, 0, 0);
display.setBitmapPaletteColor(2, 255, 128, 0);
display.setBitmapPaletteColorRaw(3, 0x0F0);
display.setBitmapPalette0Transparent(true);

生のパレット値は、AMTの公称12ビット BBBB GGGG RRRR レイアウトを使用します。rgbToBitmapColor() は通常の8ビットRGB値を生の表現に変換します。

loadBitmap(bitmap, handle) はデフォルトでリソースパレットを適用します。パレットはグローバルであるため、異なるパレットを持つ2番目のビットマップをロードすると、既に表示されているビットマップの色が変わる可能性があります。同時に表示するリソースの場合、それらを同じ共有パレットに対して変換するか、loadBitmap(bitmap, handle, false) を呼び出してパレットを明示的に管理してください。

パレットのサイクリングは、Font RAMを書き換えることなく画像をアニメートできます。AnimationPaletteDemo1 および AnimationPaletteDemo2 を参照してください。

ビットマップコンバーター

コンバーターは次の場所にあります。

tools/bitmap_converter/amt630a_bitmap_converter.py

GIFファイルの最初のフレーム、またはPNG/JPEG/BMP画像を、AMT630A_OSD::Bitmap を定義するC++ヘッダーに変換します。

要件

  • Python 3
  • Pillow

Python依存関係を次のようにインストールします。

python -m pip install -r tools/bitmap_converter/requirements.txt

または:

python -m pip install Pillow

基本的な変換

python tools/bitmap_converter/amt630a_bitmap_converter.py input.png output.h --name MyLogo

次に、output.h をArduinoスケッチフォルダに配置してインクルードします。

#include "output.h"

生成されたシンボルは --name に指定された値です。省略された場合、コンバーターは出力ファイル名のステムをサニタイズしてシンボル名として使用します。

コンバーターコマンドライン

amt630a_bitmap_converter.py INPUT OUTPUT [options]

位置引数:

引数説明
INPUTGIF、PNG、JPEG、またはBMPソース。GIFは最初のフレームを使用します。
OUTPUT生成されるArduino/C++ .h ファイル。

オプション:

オプション説明
--name NAMEC/C++ビットマップシンボル名。デフォルト:サニタイズされた出力ファイル名のステム。
--font largeターゲットビットマップジオメトリ。現在サポートされているのは large のみで、16x22タイルを意味します。
--max-bytes NパックされたFont RAMデータがNバイトを超える場合、出力を拒否します。デフォルト:8192。
--max-colors Nパレットエントリの最大合計数(透明インデックス0を含む)。範囲は2~16。デフォルトは16。
--opaqueソースに透明度がない場合、パレットインデックス0を透明なパディング用に予約する代わりに、表示可能な色として使用できるようにします。
--palette FILE.json新しいパレットを自動量子化するのではなく、既存の共有JSONパレットに画像をマッピングします。
--export-palette FILE.json最終的なパレットをJSONとして保存し、他の画像で再利用できるようにします。
--preview FILE.pngAMT/ディスプレイキャリブレーションのコンバーターによる測定に基づいたPNGプレビューを書き込みます。既存のプレビューファイルは上書きされます。

メモリサイジング

AMT630A Font RAMには4096ワード(16ビット)= 8192バイトが含まれています。ビットマップは4ビット/ピクセルを使用し、完全な16x22タイルにパディングされます。コンバーターは以下を報告します。

  • ソースの寸法
  • タイルグリッド
  • パディングされたハードウェア寸法
  • Font RAMワード数
  • Font RAMバイト数

一部のFont RAMがビットマップアロケーターで利用できない場合は、--max-bytes を使用します。

python tools/bitmap_converter/amt630a_bitmap_converter.py robot.png robot.h \
  --name robot \
  --max-bytes 4096

コンバーターは、大きすぎるビットマップを生成する代わりに、エラーで終了します。

透明度

デフォルトでは、パレットインデックス0は、透明なソースピクセルと透明なタイルパディング用に予約されています。ソースピクセルのアルファ値が128未満の場合、透明として扱われます。

完全に不透明なソースの場合、--opaque オプションを使用すると、インデックス0を表示可能な色として使用できます。

python tools/bitmap_converter/amt630a_bitmap_converter.py logo.png logo.h --opaque

ソース自体に透明度が含まれている場合、--opaque が指定されていても、インデックス0は透明のままです。

色量子化とAMTディスプレイキャリブレーション

コンバーターは、単純に通常の24ビットRGBに量子化してから切り捨てるわけではありません。まず、AMT RGB444パレットで表現可能な色で処理し、知覚的なCIE Lab距離メトリックを使用します。そのパレット選択/洗練は、特定の色の予約を想定するのではなく、利用可能なスロットを画像エラーの削減に利用するように設計されています。

コンバーターには、テスト済みのAMT630A/LCDの組み合わせの測定された転送キャリブレーションも含まれています。観測されたニュートラル輝度関係は次のとおりでした。

意図した輝度AMTニブルコード
0%0
25%2.5
50%3.5
75%5.5
100%15

キャリブレーションは、赤、緑、青に対して独立して補間されます。したがって、パレット最適化は、線形RGB444出力を想定するのではなく、予測される表示外観から機能します。--preview は逆キャリブレーションを適用して、生成されたディスプレイカラーのコンバーターによる予測を表示します。

このキャリブレーションは、テスト済みのディスプレイに基づいています。すべてのLCDパネルまたはAMT630A製品で同一であるとは想定しないでください。

複数のビットマップ用の共有パレット

すべてのビットマップウィンドウは1つのハードウェアパレットを共有するため、同時に表示される複数の画像は、通常、1つの共有パレットに対して変換されるべきです。

最初の画像を作成し、そのパレットをエクスポートします。

python tools/bitmap_converter/amt630a_bitmap_converter.py first.png first.h \
  --name first \
  --export-palette hud_palette.json

別の画像をその正確なパレットにマッピングします。

python tools/bitmap_converter/amt630a_bitmap_converter.py second.png second.h \
  --name second \
  --palette hud_palette.json

パレットJSONには palette0_transparent とRGB16進色のリストが含まれています。コンバーターは、パレットファイルを読み取る際に、#RRGGBB 形式の色または3要素のRGB配列を受け入れます。

プレビュー出力

python tools/bitmap_converter/amt630a_bitmap_converter.py input.png output.h \
  --preview output_preview.png

プレビューは、生成されたヘッダーに使用された正確なパレットインデックスとキャリブレートされたパレット値から再構築されます。プレビューパスが既に存在する場合、意図的に上書きされるため、繰り返しの変換で古いプレビューが残ることはありません。

完全なコンバーター例

python tools/bitmap_converter/amt630a_bitmap_converter.py radar.gif radar.h \
  --name radar \
  --max-colors 16 \
  --max-bytes 8192 \
  --export-palette radar_palette.json \
  --preview radar_preview.png

APIリファレンス

初期化とグローバル設定

API説明
begin(sdaPin=21, sclPin=22, i2cClock=100000)Wire/I2Cを初期化し、AMTの状態を取得し、グローバルOSD設定を構成します。
setDisplaySize(width, height)ライブラリが使用する公称ディスプレイ境界を設定します。
setFontMode(mode)グローバルな LargeFont または SmallFont を選択します。
getFontMode()現在のフォントモードを返します。
getDisplayWidth(), getDisplayHeight()設定されたディスプレイの寸法を返します。

ウィンドウ管理

API説明
configureWindow(window, width, height, mode=TextMode)現在のセルジオメトリに変換されたピクセル寸法を使用して、テキスト/汎用ウィンドウを構成します。
configureBitmapWindow(window, bitmapHandle)ロードされたビットマップのタイルグリッドからビットマップウィンドウを構成します。
releaseWindow(window)設定されたウィンドウとそのIndex RAM割り当てを解放します。
isWindowConfigured(window)ウィンドウが構成されているかどうかをテストします。
getWindowMode(window)TextMode または BitmapMode を返します。
getWindowBitmap(window)ビットマップウィンドウに関連付けられたビットマップハンドルを返します。
setDisplayOrigin(window, x, y)初期/静的なピクセル位置を設定します。
moveWindow(window, x, y)位置のみの軽量更新。
getWindowX/Y/Width/Height()ウィンドウの位置と寸法を検査します。
getColumns(), getRows()セル/タイルの寸法を検査します。
getCharacterWidth/Height()ウィンドウのアクティブなセルジオメトリを検査します。
getWindowIndexStart/Cells()Index RAM割り当てを検査します。
getIndexRAMUsed/Free()共有512セルIndex RAMの使用状況を検査します。

描画

API説明
clearWindow(window)ウィンドウ内のすべてのセルをクリアします。
clearRegion(window,x,y,w,h)セルの矩形領域をクリアします。
fillRect(window,x,y,w,h,color)領域内のセルの背景を塗りつぶします。
setCell(...)1つのセルの生のグリフとテキスト属性を設定します。
writeGlyph(...)生のグリフIDを書き込みます。
writeString(...)前景/背景色付きのC文字列またはArduino String を書き込みます。
writeStringCentered(...)ウィンドウの行にテキストを中央揃えします。
getTextWidth(...)現在のモードでのテキストのピクセル幅を返します。
writeBar(...)セルベースの値バーを描画します。
updateDisplay([window])ダーティセルをフラッシュします。
forceUpdate([window])すべてのセルをハードウェアに強制します。

可視性とメンテナンス

API説明
setVisible(window, enabled)1つの構成済みウィンドウを表示/非表示にします。
isVisible(window)ライブラリの可視性状態を返します。
setOSDVisible(enabled)グローバルOSD可視性。
isOSDVisible()グローバル可視性状態を返します。
service()通常の例で使用される、可視性状態の定期的な調整。
setServiceInterval(ms)サービス間隔を変更します。
setFactoryOSDCoexistence(enabled)ライブラリの可視性を適用しながら、ファクトリー管理の可視性/点滅ビットを保持します。

バッチ更新と移動

API説明
beginBatchUpdate()1回の所有権間隔の下でレジスタ操作のグループを開始/ネストします。
endBatchUpdate()バッチを終了します。最も外側の呼び出しが所有権を復元します。
isBatchUpdateActive()バッチ状態をテストします。
moveWindow(...)変更された位置バイトのみを効率的に更新します。

カスタムグリフ / Font RAM

API説明
configureFontRAM(customGlyphCount)LargeFontカスタムグリフスロットを予約します。残りのFont RAMはビットマップに使用できます。
getCustomGlyphCapacity()予約されたカスタムグリフスロット数。
getCustomGlyphCount()ロードされたカスタムグリフの数。
loadCustomGlyph(slot, rows)16行のLargeFontカスタムグリフをロードします。
getCustomGlyphId(slot)予約済みスロットのハードウェアグリフIDを返します。
writeCustomGlyph(...)テキストウィンドウにロードされたカスタムグリフを描画します。

ビットマップリソース

API説明
loadBitmap(bitmap, handle, applyPalette=true)生成されたビットマップリソースを割り当て/書き込みます。
clearBitmaps()安全な場合にビットマップリソースのブックキーピングをクリアします。
getBitmapCount()ロードされたリソースの数。
isBitmapLoaded(handle)ビットマップハンドルを検証します。
getBitmapWidth/Height(handle)ソース画像の寸法。
getBitmapStorageBytes(handle)1つのリソースが使用するFont RAMストレージ。
getBitmapMemoryTotal/Used/Free()ビットマップ割り当て(16ビットワード単位)。
getBitmapMemoryTotalBytes/UsedBytes/FreeBytes()ビットマップ割り当て(バイト単位)。

ビットマップパレット

API説明
setBitmapPaletteColor(index,r,g,b)RGB888から1つのパレットエントリを設定します。
setBitmapPaletteColorRaw(index,bgr12)1つの生の12ビットAMTパレットエントリを設定します。
getBitmapPaletteColorRaw(index)ライブラリのパレット状態を読み取ります。
applyBitmapPalette(bitmap)生成されたビットマップに埋め込まれたパレットを適用します。
setBitmapPalette0Transparent(bool)パレットインデックス0の透明度を制御します。
isBitmapPalette0Transparent()透明度状態を検査します。
rgbToBitmapColor(r,g,b)RGB888を生のAMTビットマップカラーに変換します。

ブレンド、不透明度、明るさ

API説明
setBlendingEnabled(bool) / isBlendingEnabled()グローバルOSD/ビデオブレンドを有効化/検査します。
setOpacity(0..7) / getOpacity()グローバルOSD不透明度。
setBrightness(0..31) / getBrightness()グローバルOSD明るさ。

スケーリング

API説明
setWindowScale(window, scale)等しいX/Yスケール(1~4)を設定します。
setWindowScale(window, scaleX, scaleY)個別のX/Yスケール(1~4)を設定します。
getWindowScaleX/Y(window)現在のスケールを検査します。

点滅

API説明
configureBlink(window,x,y,w,h,rawRate)選択されたウィンドウ、1ベースの領域、およびレートを構成します。
setBlinkWindow(window)点滅ターゲットウィンドウを変更します。
setBlinkRegion(x,y,w,h)1ベースの点滅領域を変更します。
setBlinkRateRaw(rawRate)6ビットの生の点滅レートを設定します。
setBlinkEnabled(bool)点滅を有効化/無効化します。
getBlinkWindow/X/Y/Width/Height/RateRaw()点滅構成を検査します。
isBlinkEnabled()点滅有効状態を検査します。

ファクトリーメニュー制御

API説明
configureFactoryMenuControl(menuPin, plusPin, minusPin)3つのアクティブハイGPIOコントロールを外部アナログスイッチ用に構成します。
setFactoryMenuTiming(pressMs, gapMs)デフォルトのプレス/ギャップタイミングを設定します。
setFactoryMenuSequence(steps,count)カスタムボタンシーケンスをインストールします。
useDefaultFactoryMenuSequence()テスト済みの組み込みシーケンスを復元します。
enterFactoryMode()設定されたシーケンスを実行します。

エラー

次を使用します。

if (!display.someOperation()) {
  Serial.println(AMT630A_OSD::errorToString(display.getLastError()));
}

Error 列挙型には、初期化、ウィンドウ、Index RAM、グリフ、Font RAM、ビットマップ、パレット、スケール、I2C、割り当て、およびファクトリーメニューのエラーが含まれます。clearError() は格納されたエラー状態をクリアします。

例

例目的
LargeFontHUD5ウィンドウのLargeFont RobbyスタイルHUD。
SmallFontHUD5ウィンドウのSmallFontバージョンのHUD。
LargeFontCharacterSetBrowserシリアルコントロールで生のLargeFontグリフIDをブラウズします。
SmallFontCharacterSetBrowser検証済みのROM範囲から始まる生のSmallFontグリフIDをブラウズします。
EnterFactoryMode74HC4066を介してテスト済みの隠しファクトリーメニューシーケンスを自動化します。
LargeCustomGlyphLargeFontカスタムグリフをロードして表示します。
MultipleWindows独立して配置されたテキストウィンドウ。
AnimatedWindows移動するテキストウィンドウ。
MultipleWindowBatchTestバッチ更新の動作。
BitmapWindow生成されたビットマップとLargeFont ROMテキスト。
RobotBitmapTest付属の robot.h を使用した移動ビットマップ。
AnimatedBitmapsビットマップリソースを共有する複数の移動ウィンドウ。
MixedAnimatedWindowsテキストウィンドウとビットマップウィンドウの組み合わせ。
HousePaletteBitmaps1つの共有パレットを使用した複数のリソース。
AnimationPaletteDemo1パレット駆動のビットマップアニメーション。
AnimationPaletteDemo2透明な背景を持つレーダー風パレットアニメーション。
BitmapOpacityTestビットマップ/ビデオブレンドと不透明度。
FiveWindowAlphaTest5つのテキストウィンドウ全体でのグローバルブレンド。
BitmapScalingTestビットマップスケーリング。
FiveWindowScalingTest5つのテキストウィンドウ全体でのスケーリング。
BlinkDemoハードウェア点滅領域制御。

一部のビットマップ例では、独自の画像から生成されたヘッダーが意図的に必要とされるため、それらのソース固有のヘッダーはバンドルされていません。

Arduino Library Managerへの公開

このリポジトリはArduino 1.5ライブラリ形式でレイアウトされています:リポジトリのルートに library.properties と keywords.txt、src/ の下に公開ヘッダー/ソース、小文字の examples/ の下にスケッチがあります。ArduinoのLibrary Managerは、ルートの library.properties、準拠したリポジトリ、およびGitタグ/リリースを必要とします。初回公開には、リポジトリURLをArduinoのライブラリレジストリに送信する必要があります。登録されると、後続の準拠タグは自動的にインデックス化されます。

リポジトリには .github/workflows/arduino-lint.yml が含まれており、これはArduinoの公式リンターアクションを厳格なLibrary Manager提出モードで実行します。最初のGitHubタグを公開する前に、RELEASE_CHECKLIST.md を参照してください。

クレジット

AMT630A_OSDは、Mike OgrinzがOpenAIとの協力により、広範なハードウェア実験、レジスタ分析、ファームウェアリバースエンジニアリング、および反復的なライブラリテストを通じて開発しました。

隠しファクトリーメニューの調査と、ファクトリーモードがストックMCU/外部I2Cの競合を回避できるという仮説は、Mike Ogrinzによって考案されました。ファームウェア分析とテストプログラム開発は共同で行われました。

nocash のAMT630Aカスタムファームウェアに関する作業に特に感謝します。

バージョン履歴

CHANGELOG.md を参照してください。