コグノスケ

VScodeとAsciiDocとKrokiローカルサーバー

目次: Linux

AsciiDoc ExtensionはAsciiDocのプレビューはもちろんのこと、AsciiDoc文書に埋め込んだMermaidやPlantUMLのような図形作成用言語の画像もプレビュー可能です。

以前のバージョンではローカルにツールをインストールしてプレビュー画像を生成できました（2022年9月4日の日記参照）が、最近のバージョン（おそらく3.1.0以降？）はKroki（Krokiのサイト）による図形描画に変更されたようです。

AsciiDoc Extensionのデフォルト設定だとhttps://kroki.ioにMermaidやPlantUMLのソースコードを送って、画像を受け取る設定になっています。これで問題なければそのまま使用すれば良いですが、外部のサーバーにソースコードを送りたくない場合はローカルにKrokiサーバーを立ち上げることでローカルネットワーク環境で完結することもできます。素晴らしいですね。

Krokiローカルサーバーの設定

Krokiのローカルサーバー立ち上げについてはDockerが便利なようです。Dockerが良い方はそちらを検索してみてください。

今回はKrokiを単体で立ち上げてみます。……と言ってもKroki自体に特に難しいことはなく、公式サイト（Manual Install :: Kroki Documentation）の説明の通りにやればよいです。PlantUMLを表示させたければGraphvizとPlantUMLをインストールした上で、

$ which dot
/usr/bin/dot

$ which plantuml
/usr/bin/plantuml

GitHub ReleaseページからダウンロードしたKrokiのJARファイルを起動するだけでサーバーとして機能します。Krokiはサーバー機能を持っていて、動作テストにちょうど良いです。

$ java -jar kroki-standalone-server-v0.25.0.jar \
  -DKROKI_LISTEN=0.0.0.0:5000

KROKI_LISTENはどのポートで待ち受けるか？の設定です。PlantUML系の設定は特に何も追加しなくてもPlantUMLを認識していました。これはテスト用の簡易サーバー機能なので、本格的に運用する際はアプリケーションサーバーに登録したほうが良いと思います、その設定はまた今度。

VSCodeの設定

Krokiローカルサーバーを立ち上げたら、VSCodeを設定する必要があります。まずAsciiDoc Extensionの設定を開きます。

AsciiDoc Extensionの設定

Asciidoc > Preview: Asciidoctor Attributesの項目にある[Edit in setting.json]のリンクを開きます。

Asciidoctor Attributesの設定

設定の最後辺りに、

    "asciidoc.preview.asciidoctorAttributes": {
            "kroki-server-url": "http://192.168.1.1:5000"
    }

を追加するとローカルサーバーに切り替わるはずです。192.168.1.1の部分はKrokiのローカルサーバーを動作させているIPアドレスを指定します。

見た目が少し違う

ローカルサーバーにて画像生成すると見た目が少し変わります。おそらくですが、インターネット側のKrokiサーバーはデフォルトのデザインを変えていると思われます。下記のAsciidoc文書を入力として確かめます。

This is a sample of PlantUML diagram.

[plantuml]
----
@startuml
box "Box"
participant "App" as app
participant "Library" as lib
endbox

activate app
activate lib

app -> lib : Something()
@enduml
----

デフォルトつまりインターネット上のKrokiサーバーを使用する場合、このような結果になります。

kroki.ioの出力結果

ローカルサーバーを使用する場合、このような結果になります。グレーっぽいデザインから黄色のデザインに変わりました。

ローカルサーバーの出力結果

Krokiはkroki-standalone-server-v0.25.0.jarで、Krokiを動作させている環境はDebian Testingです。各モジュールのバージョンは、

• plantuml: 1.2020.2
• Graphviz: 2.42.2-8

です。

初めて作ったボード動作せず（手で直した）

目次: Arduino

以前（2024年3月24日の日記参照）発注して、全く動ないうえにNMOSが焼ける（2024年4月3日の日記参照）PCBを直してみました。

まずはミスったNMOS 8個を全部外しました。当初はNMOSをきれいに外して再利用できないか？と考えたんですが、ナメた考えだったことがすぐにわかりました。全然外れません、無理だこれ。

次善策としてNMOSの足を切り破壊しながら外しました。代わりのNMOSはOnSemi BSS138を新たに購入します（秋月で売ってる）。本当はOnSemi BSS123ですけど、高周波とか高圧電流とか厳しい信号ではないしBSS123でもBSS138でも大差ありません。

NMOSを外したら修正します。ミスした箇所はNMOSのピン配置ですから、辻褄が合うようにNMOSを付け直せば良いはずです。

PCB側が想定しているピン配置（間違い）

Drain  1 |      |
         | NMOS | 3 Source
Gate   2 |      |

NMOS側のピン配置（正しい）

Gate   1 |      |
         | NMOS | 3 Drain
Source 2 |      |

NMOSを裏向きにつけたらどうかとアドバイスも頂いたんですが、ちょうど左周りに60°回転させるとGate/Source/Drainがぴったり合いますので、回転させて付けることにしました。

SOT-23のピン配置は正三角形ではない（1-2間だけ若干狭い）ため、回転させると端子がはみ出してしまいます。私はハンダ付けが上手な訳でもなく、表面実装系の細かいやつは難しいのでハンダをちょっと増やしてごまかします。

ハンダ付け後のPCB

できました。斜めに付いてる違和感がすごいのと芋ハンダだらけで長持ちしなさそうです。そもそも手修理ボードは長期運用するつもりがないから今だけ動いてくれればとりあえずヨシ！！

初めて作ったボード動作せず（燃えた）

目次: Arduino

以前（2024年3月24日の日記参照）発注したPCBが届いたので、動かしてみたら全く動きませんでした。動かないどころか通電したら通常は0.07Aくらいのはずなのに1.5A近い大電流が流れ続け、しばらくしたらNMOSが焼けて煙が出ました。1万円（部品配置込みで$67）のゴミが爆誕……。

PCのUSBを電源にしてM5Stamp C3も繋いでいたので、PCやM5Stampが壊れる可能性もありました。M5Stampはめちゃくちゃ熱くなっていましたが、幸いなことにどちらも壊れずに済みました。M5Stampは強い子ですね。

ミスした箇所を調べると、どうやらKiCadのNMOSのピン配置と、部品で使ったNMOS（Onsemi BSS-123）のピン配置が違うのが原因のようです。

KiCadのNMOS(形状SOT-23)のピン配置

Onsemi BSS-123のピン配置

KiCadは1番ピンがドレイン、BSS-123は1番ピンがゲートなのでゲートとソース/ドレインを逆接続した回路になってしまったということです。Vcc 3.3VとGPIOが短絡していて、GPIOをGNDに繋いだり、GPIOをOutput Lowレベルにすると電源とGNDがショートする危険な状態になっていました。そりゃあNMOSも焼けますよね。これは気づかなかったなあ……。

KiCadが動かなくなったのでビルド

目次: Arduino

Debian Testingなマシンをapt-get upgradeしたところKiCadが動かなくなりました。正確に言うとアプリ自体は動作しますがフットプリントライブラリをロードするとエラーになります。

フットプリントのロードエラー

検索のために先頭のエラーメッセージのみ転記しておきます。

フットプリントのロード中にエラーが発生しました:
KiCad は現在使っているバージョンより新しいバージョンで作られたこのファイルを開くことができません。
このファイルを開くためには KiCad を 2024年01月08日 以降のバージョンにアップグレードする必要があります。
エラー文字列全文:
予期される 'locked, placed, tedit, tstamp, at, descr, tags, path, autoplace_cost90, autoplace_cost180, solder_mask_margin, solder_paste_margin, solder_paste_ratio, clearance, zone_connect, thermal_gap, attr, fp_text, fp_arc, fp_circle, fp_curve, fp_line, fp_poly, fp_rect, pad, zone, group, generator, version or model' ソース '/usr/share/kicad/footprints//Connector_HDMI.pretty/HDMI_A_Kycon_KDMIX-SL1-NS-WS-B15_VerticalRightAngle.kicad_mod', 行 4, オフセット 3.

パッケージを見るとKiCad（kicad）のバージョンが7.0.11なのに、フットプリントライブラリ（kicad-footprints）だけ8.0.1になっています。変ですねえ。

$ dpkg -l | egrep 'kicad |kicad-footprints '

ii  kicad                          7.0.11+dfsg-1        amd64        Electronic schematic and PCB design software
ii  kicad-footprints               8.0.1-1              all          Footprint symbols for KiCad's Pcbnew

放っておいてもそのうち是正されると思いますが、良い機会なのでKiCadを自分でビルドしてみたいと思います。

KiCadのビルド方法

Ubuntu 22.04でのビルド方法を示します。

$ apt-get install git cmake gcc g++ ninja-build

$ apt-get install libglew-dev libcurl4-openssl-dev libcairo2-dev \
    libboost-dev libboost-locale-dev libboost-test-dev libboost-filesystem-dev \
    libharfbuzz-dev libprotobuf-dev protobuf-compiler swig \
    libpython3-dev python3-wxgtk4.0 libgtk-3-dev \
    libglm-dev libgit2-dev libngspice0-dev \
    libocct-draw-dev libocct-ocaf-dev libocct-visualization-dev \
    libocct-data-exchange-dev \
    wx3.0-headers libwxgtk3.0-gtk3-dev unixodbc-dev libsecret-1-dev

$ git clone https://gitlab.com/kicad/code/kicad
$ git reset --hard 7.0.1
$ git clone https://gitlab.com/kicad/libraries/kicad-footprints
$ git reset --hard 7.0.1
$ git clone https://gitlab.com/kicad/libraries/kicad-symbols
$ git reset --hard 7.0.1
$ git clone https://gitlab.com/kicad/libraries/kicad-packages3D
$ git reset --hard 7.0.1

$ cd kicad
$ cmake -G Ninja ./ -B build -DCMAKE_INSTALL_PREFIX="/path/to/kicad/___"
$ ninja -C build
$ ninja -C build install


#### footprintライブラリをインストール先のshare/kicad/footprintsにコピーする
#### フットプリントエディターで正しく部品がロードできればOK

$ cd ../
$ cp -a kicad-footprints /path/to/kicad/___/share/kicad/footprints


#### symbolsライブラリをインストール先のshare/kicad/symbolsにコピーする
#### シンボルエディターで正しく部品がロードできればOK

$ cd ../
$ cp -a kicad-symbols /path/to/kicad/___/share/kicad/symbols


#### symbolsライブラリをインストール先のshare/kicad/3dmodelsにコピーする
#### 3Dビューアーで部品が表示されればOK

$ cd ../
$ cp -a kicad-packages3D /path/to/kicad/___/share/kicad/3dmodels

Debian Testingの場合はKiCad 7.0.11を使うとよいです。wx3.0ではなくwx3.2であることと、一部パッケージ名が違う場合があります。