Lidt af et sidespring

Dette indlæg har ikke direkte noget at gøre med modeltog. Jeg har valgt at skrive det alligevel da det trods alt har noget at gøre med mit model tog projekt.

Som jeg skrev i sidste blog indlæg har jeg valg at lave mit hardware open source - og det kan nu findes på GitHub. Indtil videre har alt dokumentation været her på min blog. En blog er god til at beskrive et projekt forløb. Det er ikke det bedste format til at dokumenterer resultatet af et projekt. Enten skal man læse en masse forskellige indlæg for at få overblikket, eller også skal hvert indlæg indeholde en mase information der allerede har været beskrevet tidligere.

For at lave en ordenlig dokumentation er det nødventigt at have tegninger af kredsløbet. Her på bloggen er det ikke et stort problem. Når jeg skriver et blog indlæg eksporterer jeg bare til SVG fra KiCad, konverterer til PNG (da man vist har glemt at supportere SVG her på sporskiftet ) og uploader.

Det betyder billederne ikke er den nyeste version - men en blog er jo netop et indlæg der skrives på et specifikt tidspunkt i forløbet, så det er helt fint.

Men til dokumentation er det ikke så godt. Der skal tegningerne vise den nyeste version til enhver tid.

Der er et par løsninger:

• Exporter en SVG fil og upload (commit) til GitHub sammen med den nyeste version af et Schematic.
  Let og enkelt... og der er igen chance for at jeg husker at gøre det. 
• Have en server der holder øge med Github checkins og opdaterer tegningen.
  Bedre, men man har stadig SVG filen i GitHub repositoriet - selv om det bare er en eksport af en anden fil der allerede er i GitHub.
• Have en server der kan genere SVG filen "on demand" ud fra det der er checket ind i GitHub.
  Dette er den løsning jeg valgte.

Desværre lider KiCad af samme problem som vi ser med programmer til at lave sporplaner - De kan alle sammen eksportere til diverse grafik formater (JPG til dem der ikke ved bedre, PNG til dem der forstår billedformater, SVG til perfektionister  :p ). Men det kan typisk ikke automatiseres. Derfor kan Lars ikke få sporskiftet til automatisk at vise et billede af sporplanen, hvis det, for eksempel, er en WinTrack fil der er uploaded.

KiCad har heldigvis et ret simpelt fil format. Så efter at lede lidt efter noget der allerede var lavet gik jeg igang selv - og resultatet er også på GitHub:

KiCadDoxer.

Er der andre her der roder med KiCad til elektronik så kan i bare bruge den. Der er en del mangler (se Issues) men sig bare til hvis der er noget specifikt der mangler - så kan det let prioriteres.

Så nu har jeg en readme fil der dokumenterer min DCC generator. "Nogen" bør nok læse lidt korrektur - vi for se om "nogen" får tid til det.