Benutzer-Werkzeuge

Webseiten-Werkzeuge


wizard:firmware-update-definition

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen Revision Vorhergehende Überarbeitung
Nächste Überarbeitung
Vorhergehende Überarbeitung
wizard:firmware-update-definition [2019/10/04 22:46]
RS200 [Fiktives Beispiel für die StepControl]
wizard:firmware-update-definition [2020/03/29 15:45] (aktuell)
akuhtz [Default-Labels]
Zeile 25: Zeile 25:
  
 Im ''<​FirmwareDefinition>''​-Tag wird die Struktur der Firmware angegeben. Dabei werden unterschiedliche Node-Typen unterstützt:​ Im ''<​FirmwareDefinition>''​-Tag wird die Struktur der Firmware angegeben. Dabei werden unterschiedliche Node-Typen unterstützt:​
-  * DeviceNode: Äusserer Node-Typ der die Firmware-Files eines Node zusammenfasst. Hier //​können// ​VID und PID sowie ein Kommentar angegeben werden.+  * DeviceNode: Äusserer Node-Typ der die Firmware-Files eines Node zusammenfasst. Hier sollten die Hersteller Id (VID), falls notwendig die erweiterte Hersteller Id (EVID), die Produkt Id (PIDsowie optional ​ein Kommentar angegeben werden.
   * FirmwareNode:​ Node-Typ der ein Firmware-File (hex) definiert. Hier muss die Destination des Hex-File, der Text sowie der Filename des HEX-File innerhalb des Archiv (Zip-File) angegeben werden.   * FirmwareNode:​ Node-Typ der ein Firmware-File (hex) definiert. Hier muss die Destination des Hex-File, der Text sowie der Filename des HEX-File innerhalb des Archiv (Zip-File) angegeben werden.
   * SimpleNode: Dieser Node-Typ kann verwendet werden um eine oder mehrere zusätzliche Abstraktions-Ebenen zu definieren.   * SimpleNode: Dieser Node-Typ kann verwendet werden um eine oder mehrere zusätzliche Abstraktions-Ebenen zu definieren.
Zeile 32: Zeile 32:
 <code xml> <code xml>
    <​FirmwareDefinition>​    <​FirmwareDefinition>​
-      <Node xsi:​type="​DeviceNode">​+      <Node xsi:​type="​DeviceNode" Comment="​Kommentar"​ VID="​13"​ EVID="​258"​ PID="​132">
          <​Nodetext Lang="​de-DE"​ Text="​Beispiel Firmware"/>​          <​Nodetext Lang="​de-DE"​ Text="​Beispiel Firmware"/>​
          <​Nodetext Lang="​en-EN"​ Text="​Sample Firmware"/>​          <​Nodetext Lang="​en-EN"​ Text="​Sample Firmware"/>​
Zeile 45: Zeile 45:
 Mit dem Attribute ''​DestinationNumber''​ wird der Zielspeicherbereich auf dem Knoten festgelegt ( 0 = Flash, 1 = EEPROM.). Details dazu sind auf [[http://​www.bidib.org/​protokoll/​bidib_fw_update.html#​T443|bidib.org]] zu finden.\\ Mit dem Attribute ''​DestinationNumber''​ wird der Zielspeicherbereich auf dem Knoten festgelegt ( 0 = Flash, 1 = EEPROM.). Details dazu sind auf [[http://​www.bidib.org/​protokoll/​bidib_fw_update.html#​T443|bidib.org]] zu finden.\\
 \\ \\
-Es besteht auch die Möglichkeit eine CV-Defintions ​anzugeben, welche dann im //​firmware.zip//​ mitgeliefert werden muss:+Es besteht auch die Möglichkeit eine CV-Definition ​anzugeben, welche dann im //​firmware.zip//​ mitgeliefert werden muss:
 <code xml> <code xml>
    <​FirmwareDefinition>​    <​FirmwareDefinition>​
-      <Node xsi:​type="​DeviceNode">​+      <Node xsi:​type="​DeviceNode" Comment="​Kommentar"​ VID="​13"​ EVID="​258"​ PID="​xyz">
          <​Nodetext Lang="​de-DE"​ Text="​Beispiel Firmware"/>​          <​Nodetext Lang="​de-DE"​ Text="​Beispiel Firmware"/>​
          <​Nodetext Lang="​en-EN"​ Text="​Sample Firmware"/>​          <​Nodetext Lang="​en-EN"​ Text="​Sample Firmware"/>​
Zeile 55: Zeile 55:
          </​Node>​          </​Node>​
          ...          ...
 +         <​CvFilename>​BiDiBCV-13-xyz.xml</​CvFilename>​
       </​Node>​       </​Node>​
-      <​CvFilename>​BiDiBCV-13-xyz.xml</​CvFilename>​ 
    </​FirmwareDefinition>​    </​FirmwareDefinition>​
 </​code>​ </​code>​
Zeile 67: Zeile 67:
       Description="​Firmware Definition for StepControl !!!Minimum-Beispiel!!!"/>​       Description="​Firmware Definition for StepControl !!!Minimum-Beispiel!!!"/>​
    <​FirmwareDefinition>​    <​FirmwareDefinition>​
-      <Node xsi:​type="​DeviceNode">​+      <Node xsi:​type="​DeviceNode" Comment="​Kommentar"​ VID="​13"​ EVID="​258"​ PID="​201">
          <​Nodetext Lang="​de-DE"​ Text="​Beispiel Firmware"/>​          <​Nodetext Lang="​de-DE"​ Text="​Beispiel Firmware"/>​
          <​Nodetext Lang="​en-EN"​ Text="​Sample Firmware"/>​          <​Nodetext Lang="​en-EN"​ Text="​Sample Firmware"/>​
Zeile 74: Zeile 74:
          </​Node>​          </​Node>​
          ...          ...
 +         <​CvFilename>​BiDiBCV-13-201.xml</​CvFilename>​
       </​Node>​       </​Node>​
-      <​CvFilename>​BiDiBCV-13-201.xml</​CvFilename>​ 
    </​FirmwareDefinition>​    </​FirmwareDefinition>​
 </​code>​ </​code>​
  
 +===== Version, Status und Node-Images =====
 +
 +Ab dem Wizard-1.12.2 werden die ''<​FirmwareDefinition>''​ in den CV-Dateien mit den Attributen ''​Version''​ und ''​Status''​ versehen importiert. Wenn ''​Version''​ angegeben ist, wird auf das Parsen der Filenamen zur Ermittlung der Version verzichtet. //​Optional//​ können noch die Protokollversion ''​ProtocolVersion''​ sowie die aktuelle minimal Version ''​RequiredMinVersion''​ angegeben werden.
  
-Ab dem Wizard-1.12.2 werden die ''<​FirmwareDefinition>''​ in den CV-Dateien mit den Attributen ''​Version''​ und ''​Status''​ versehen importiert. Wenn ''​Version''​ angegeben ist, wird auf das Parsen der Filenamen zur Ermittlung der Version verzichtet. Optional können noch die Protokollversion ''​ProtocolVersion''​ sowie die aktuelle minimal Version ''​RequiredMinVersion''​ angegeben werden. 
 Als weitere Änderung muss der ''​CvFilename''​ jetzt unter dem ''​DeviceNode''​ angegeben werden. Als weitere Änderung muss der ''​CvFilename''​ jetzt unter dem ''​DeviceNode''​ angegeben werden.
 +
 +Neu besteht auch die Möglichkeit ein Bild der Baugruppe im Firmware-ZIP mitzuliefern. Dazu muss das Element ''​NodeImages''​ wie im Beispiel unten unter dem ''​DeviceNode''​ angegeben werden.
 +
 <code xml> <code xml>
    <​Version Version="​0.1"​ Lastupdate="​20190920"​ Author="​BiDiB.org"​ Pid="​132"​ Vendor="​013" ​    <​Version Version="​0.1"​ Lastupdate="​20190920"​ Author="​BiDiB.org"​ Pid="​132"​ Vendor="​013" ​
Zeile 87: Zeile 92:
  
    <​FirmwareDefinition Version="​2.06.00"​ Status="​beta"​ ProtocolVersion="​0.7"​ RequiredMinVersion="​2.01.00"​ >    <​FirmwareDefinition Version="​2.06.00"​ Status="​beta"​ ProtocolVersion="​0.7"​ RequiredMinVersion="​2.01.00"​ >
-      <Node xsi:​type="​DeviceNode"​ Comment="​BiDiB-IF2"​ VID="​013"​ PID="​132">​+      <Node xsi:​type="​DeviceNode"​ Comment="​BiDiB-IF2"​ VID="​013" EVID="​258" PID="​132">​
          <​Nodetext Lang="​de-DE"​ Text="​Beispiel Firmware"/>​          <​Nodetext Lang="​de-DE"​ Text="​Beispiel Firmware"/>​
          <​Nodetext Lang="​en-EN"​ Text="​Sample Firmware"/>​          <​Nodetext Lang="​en-EN"​ Text="​Sample Firmware"/>​
Zeile 95: Zeile 100:
          ...          ...
          <​CvFilename>​BiDiBCV-13-132.xml</​CvFilename>​          <​CvFilename>​BiDiBCV-13-132.xml</​CvFilename>​
 +         <​NodeImages>​
 +             <​Image>​bidib-13-132.png</​Image>​
 +         </​NodeImages>​
       </​Node>​       </​Node>​
    </​FirmwareDefinition>​    </​FirmwareDefinition>​
 </​code>​ </​code>​
 +
 +:!: Alle referenzierten Dateien wie //​NodeImage//​ oder //​CV-Defintions-File//​ müssen im Firmware-ZIP enthalten sein.
 +
 +
 +===== Default-Labels =====
 +
 +Die Default-Labels können im ''​firmware.xml''​ angegeben werden. Sie müssen an der letzten Stelle der Daten innerhalb der ''​FirmwareDefinition''​ eingefügt werden. Beim Laden des Firmware-Archiv erscheint dann im Wizard der Hinweis, ob die Default-Labels importiert werden sollen.
 +
 +<code xml>
 +<​Firmware ...>
 +   ...
 +   <​FirmwareDefinition Version="​2.06.00"​ Status="​beta"​ ProtocolVersion="​0.7"​ RequiredMinVersion="​2.01.00"​ >
 +      ...
 +      <!-- other parts -->
 +      ...
 +      <​DefaultLabels>​
 +         <​DefaultLabelsFile Lang="​de-DE"​ Filename="​bidib-default-names-13-138-de.xml"​ />
 +         <​DefaultLabelsFile Lang="​en-EN"​ Filename="​bidib-default-names-13-138-en.xml"​ />
 +      </​DefaultLabels>​
 +        ​
 +   </​FirmwareDefinition>​
 +</​Firmware>​
 +</​code>​
 +
 +:!: Alle referenzierten Dateien wie die //​DefaultLabelsFile//​s müssen im Firmware-ZIP enthalten sein.
  
 ==== Darstellung im Wizard ==== ==== Darstellung im Wizard ====
Zeile 125: Zeile 158:
       Description="​Firmware Definition for StepControl !!!Minimum-Beispiel!!!"/>​       Description="​Firmware Definition for StepControl !!!Minimum-Beispiel!!!"/>​
    <​FirmwareDefinition Version="​1.04.00"​ Status="​stable"​ ProtocolVersion="​0.7"​ RequiredMinVersion="​1.01.00">​    <​FirmwareDefinition Version="​1.04.00"​ Status="​stable"​ ProtocolVersion="​0.7"​ RequiredMinVersion="​1.01.00">​
-      <Node xsi:​type="​DeviceNode"​ VID="​013"​ PID="​201"​ >+      <Node xsi:​type="​DeviceNode"​ VID="​013" EVID="​258" PID="​201"​ >
          <​Nodetext Lang="​de-DE"​ Text="​StepControl:​ Komplette Installation"/>​          <​Nodetext Lang="​de-DE"​ Text="​StepControl:​ Komplette Installation"/>​
          <​Nodetext Lang="​en-EN"​ Text="​StepControl:​ complete installation"/>​          <​Nodetext Lang="​en-EN"​ Text="​StepControl:​ complete installation"/>​
Zeile 158: Zeile 191:
          </​Node>​          </​Node>​
       </​Node>​       </​Node>​
-      <Node xsi:​type="​DeviceNode"​ VID="​013"​ PID="​201"​ >+      <Node xsi:​type="​DeviceNode"​ VID="​013" EVID="​258" PID="​201"​ >
          <​Nodetext Lang="​de-DE"​ Text="​StepControl:​ Update Installation"/>​          <​Nodetext Lang="​de-DE"​ Text="​StepControl:​ Update Installation"/>​
          <​Nodetext Lang="​en-EN"​ Text="​StepControl:​ update installation"/>​          <​Nodetext Lang="​en-EN"​ Text="​StepControl:​ update installation"/>​
wizard/firmware-update-definition.1570221991.txt.gz · Zuletzt geändert: 2019/10/04 22:46 von RS200