added support for datasheet fields

HashDefineElectronics · Sep 9, 2017 · f16c62a · f16c62a
1 parent 7abdd1f
commit f16c62a
Show file tree

Hide file tree

Showing 11 changed files with 32 additions and 7 deletions.
diff --git a/Doc/shortcode.md b/Doc/shortcode.md
@@ -34,12 +34,14 @@ These are the list of short code that are used in the template files.
     <!--ROW_PART_QTY-->            inserts the number of parts grouped together
     <!--ROW_PART_VALUE-->          inserts the part value
     <!--ROW_PART_FOOTPRINT-->      inserts the part footprint.
+    <!--ROW_PART_DATASHEET-->      inserts the part datasheet.
     <!--ROW_PART_FIELDS-->          inserts the generator parts fields
     <!--ROW_CLASS_ODD_EVEN_TAG-->    returns RowEvenTag on even rows or RowOddTag for odds rows.
     <!--HEADER_CLASS_REF_TAG-->         insert the tag for the part reference. HeadRefTag
     <!--HEADER_CLASS_QTY_TAG-->         insert the tag for the part qty. HeadQtyTag
     <!--HEADER_CLASS_VALUE_TAG-->         insert the tag for the part value. HeadValueTag
     <!--HEADER_CLASS_FOOTPRINT_TAG-->         insert the tag for the part footprint. HeadFootprintTag
+    <!--HEADER_CLASS_DATASHEET_TAG-->         insert the tag for the part datasheet. HeadDatasheetTag
 
 
 ### for fields.conf:

diff --git a/Example/example.xml b/Example/example.xml
@@ -125,6 +125,7 @@
   <components>
     <comp ref="C1">
       <value>C1210C106K5RACTU</value>
+      <datasheet>C1210C106K5RACTU.pdf</datasheet>
       <footprint>Capacitors:CAP_1210</footprint>
       <fields>
         <field name="Description">10uF, 50V, 1210, MLCC, X7R 10%</field>

diff --git a/KiCad_BOM_Wizard.js b/KiCad_BOM_Wizard.js
@@ -22,7 +22,7 @@
 *
 *   @author Ronald Sousa http://hashdefineelectronics.com/kicad-bom-wizard/
 *
-*   @version 0.0.10
+*   @version 0.0.11
 *
 *   @fileoverview This KiCad plugin can be used to create custom BOM files based on easy
 *   configurable templates files. The plugin is writing in JavaScript and has been

diff --git a/Lib/component.js b/Lib/component.js
@@ -75,7 +75,7 @@ function SearchUniquePartIndex (source, searchTerm, listOfGroups) {
     // reset the filed test flag. this will ensure that we check the next part that might have all the matching fields
     var FieldsTestResult = true
     // part value matches
-    if (searchTerm.Value === source[Index].Value && searchTerm.Footprint === source[Index].Footprint) {
+    if (searchTerm.Value === source[Index].Value && searchTerm.Footprint === source[Index].Footprint && searchTerm.Datasheet === source[Index].Datasheet) {
       for (var FieldIndex = 0; FieldIndex < listOfGroups.length; FieldIndex++) {
         // If either one is true
         if (listOfGroups[ FieldIndex ] in searchTerm.Fields || listOfGroups[ FieldIndex ] in source[Index].Fields) {
@@ -116,6 +116,7 @@ function ExtractAndSortComponents (config) {
 
   // Get the list of groups we are going to use
   Components.inputData.export.components[0].comp.forEach(function (Part) {
+
     if (Part.fields) {
       Part.fields.forEach(function (value) {
         value.field.forEach(function (value) {
@@ -147,7 +148,14 @@ function ExtractAndSortComponents (config) {
       FootprintValue = Part.footprint[0]
     }
 
-    var TempPart = {Value: Part.value[0], Count: 1, Ref: [], Fields: TempFieldHolder, Footprint: FootprintValue, RefPrefix: Part.$.ref.replace(/[0-9]/g, '')}
+    var DatasheetValue = ''
+
+    // get the component footprint if its not been defined or left empty
+    if (typeof Part.datasheet !== 'undefined' && typeof Part.datasheet[0] !== 'undefined') {
+      DatasheetValue = Part.datasheet[0]
+    }
+
+    var TempPart = {Value: Part.value[0], Count: 1, Ref: [], Fields: TempFieldHolder, Datasheet: DatasheetValue, Footprint: FootprintValue, RefPrefix: Part.$.ref.replace(/[0-9]/g, '')}
 
     PartIndex = SearchUniquePartIndex(Components.UniquePartList, TempPart, Components.sortMeta.fields)
 
@@ -235,6 +243,11 @@ function ApplaySort(config) {
           CompareA = partA.Footprint
           CompareB = partB.Footprint
           break
+          case 'datasheet':
+            IsNumber = false
+            CompareA = partA.Datasheet
+            CompareB = partB.Datasheet
+            break
         default:
         return 0 // leave unsorted
       }

diff --git a/Lib/configuration.js b/Lib/configuration.js
@@ -52,7 +52,7 @@ var Config = {
     landscape: false,
     marginsType : 0
   },
-  sort : {by: 'ref', ascending: true}  // possible ref, qty, value, value_num, footprint
+  sort : {by: 'ref', ascending: true}  // possible ref, qty, value, value_num, footprint, datasheet
 }
 
 /**

diff --git a/Lib/export.js b/Lib/export.js
@@ -64,6 +64,9 @@ function GenerateTable (component, template) {
       } else if (ListOfheaders[HeaderIndex].indexOf('FOOTPRINT-->') !== -1) {
         HeaderTemp += template.header.replace(/<!--HEADER_ROW-->/g, 'Footprint')
         HeaderTemp = HeaderTemp.replace(/<!--HEADER_CLASS_FOOTPRINT_TAG-->/g, 'HeadFootprintTag')
+      } else if (ListOfheaders[HeaderIndex].indexOf('DATASHEET-->') !== -1) {
+        HeaderTemp += template.header.replace(/<!--HEADER_ROW-->/g, 'Datasheet')
+        HeaderTemp = HeaderTemp.replace(/<!--HEADER_CLASS_DATASHEET_TAG-->/g, 'HeadDatasheetTag')
       } else if (ListOfheaders[HeaderIndex].indexOf('FIELDS-->') !== -1) {
         // this will help us place the fileds header
         HeaderTemp += '<!--FIELDS_HEADER_PLACEHOLDER-->'
@@ -77,6 +80,7 @@ function GenerateTable (component, template) {
       HeaderTemp = HeaderTemp.replace(/<!--HEADER_CLASS_QTY_TAG-->/g, '')
       HeaderTemp = HeaderTemp.replace(/<!--HEADER_CLASS_VALUE_TAG-->/g, '')
       HeaderTemp = HeaderTemp.replace(/<!--HEADER_CLASS_FOOTPRINT_TAG-->/g, '')
+      HeaderTemp = HeaderTemp.replace(/<!--HEADER_CLASS_DATASHEET_TAG-->/g, '')
       HeaderTemp = HeaderTemp.replace(/<!--HEADER_CLASS_FIELDS-->/g, '')
     }
   }
@@ -89,6 +93,7 @@ function GenerateTable (component, template) {
     TempFieldHeader = TempFieldHeader.replace(/<!--HEADER_CLASS_QTY_TAG-->/g, '')
     TempFieldHeader = TempFieldHeader.replace(/<!--HEADER_CLASS_VALUE_TAG-->/g, '')
     TempFieldHeader = TempFieldHeader.replace(/<!--HEADER_CLASS_FOOTPRINT_TAG-->/g, '')
+    TempFieldHeader = TempFieldHeader.replace(/<!--HEADER_CLASS_DATASHEET_TAG-->/g, '')
     TempFieldHeader = TempFieldHeader.replace(/<!--HEADER_CLASS_FIELDS-->/g, 'HeadField_' + component.sortMeta.fields[ FieldIndex ].replace(' ','_'))
   }
 
@@ -124,11 +129,13 @@ function GenerateTable (component, template) {
       TempRow = TempRow.replace(/<!--ROW_PART_QTY-->/g, component.GroupedList[GroupdName][Item].Count)
       TempRow = TempRow.replace(/<!--ROW_PART_VALUE-->/g, component.GroupedList[GroupdName][Item].Value)
       TempRow = TempRow.replace(/<!--ROW_PART_FOOTPRINT-->/g, component.GroupedList[GroupdName][Item].Footprint)
+      TempRow = TempRow.replace(/<!--ROW_PART_DATASHEET-->/g, component.GroupedList[GroupdName][Item].Datasheet)
 
       TempRow = TempRow.replace(/<!--HEADER_CLASS_REF_TAG-->/g, 'HeadRefTag')
       TempRow = TempRow.replace(/<!--HEADER_CLASS_QTY_TAG-->/g, 'HeadQtyTag')
       TempRow = TempRow.replace(/<!--HEADER_CLASS_VALUE_TAG-->/g, 'HeadValueTag')
       TempRow = TempRow.replace(/<!--HEADER_CLASS_FOOTPRINT_TAG-->/g, 'HeadFootprintTag')
+      TempRow = TempRow.replace(/<!--HEADER_CLASS_DATASHEET_TAG-->/g, 'HeadDatasheetTag')
 
       var FieldsTemp = ''
 

diff --git a/Template/CSV/row.conf b/Template/CSV/row.conf
@@ -1 +1 @@
-<!--ROW_PART_REF-->,<!--ROW_PART_QTY-->,<!--ROW_PART_VALUE-->,<!--ROW_PART_FOOTPRINT--><!--ROW_PART_FIELDS-->
+<!--ROW_PART_REF-->,<!--ROW_PART_QTY-->,<!--ROW_PART_VALUE-->,<!--ROW_PART_FOOTPRINT-->,<!--ROW_PART_DATASHEET--><!--ROW_PART_FIELDS-->
diff --git a/Template/HTML/headers.conf b/Template/HTML/headers.conf
@@ -1 +1 @@
-<div class='Head <!--HEADER_CLASS_REF_TAG--><!--HEADER_CLASS_QTY_TAG--><!--HEADER_CLASS_VALUE_TAG--><!--HEADER_CLASS_FOOTPRINT_TAG-->'><!--HEADER_ROW--></div>
+<div class='Head <!--HEADER_CLASS_REF_TAG--><!--HEADER_CLASS_QTY_TAG--><!--HEADER_CLASS_VALUE_TAG--><!--HEADER_CLASS_FOOTPRINT_TAG--><!--HEADER_CLASS_DATASHEET_TAG-->'><!--HEADER_ROW--></div>
diff --git a/Template/HTML/row.conf b/Template/HTML/row.conf
@@ -3,5 +3,6 @@
     <div class="column <!--HEADER_CLASS_QTY_TAG-->"><!--ROW_PART_QTY--></div>
     <div class="column <!--HEADER_CLASS_VALUE_TAG-->"><!--ROW_PART_VALUE--></div>
     <div class="column <!--HEADER_CLASS_FOOTPRINT_TAG-->"><!--ROW_PART_FOOTPRINT--></div>
+    <div class="column <!--HEADER_CLASS_DATASHEET_TAG-->"><!--ROW_PART_DATASHEET--></div>
     <!--ROW_PART_FIELDS-->
 </div>
diff --git a/Template/HTML_PDF/headers.conf b/Template/HTML_PDF/headers.conf
@@ -1 +1 @@
-<th class='Head <!--HEADER_CLASS_REF_TAG--><!--HEADER_CLASS_QTY_TAG--><!--HEADER_CLASS_VALUE_TAG--><!--HEADER_CLASS_FOOTPRINT_TAG--><!--HEADER_CLASS_FIELDS-->'><!--HEADER_ROW--></th>
+<th class='Head <!--HEADER_CLASS_REF_TAG--><!--HEADER_CLASS_QTY_TAG--><!--HEADER_CLASS_VALUE_TAG--><!--HEADER_CLASS_FOOTPRINT_TAG--><!--HEADER_CLASS_DATASHEET_TAG--><!--HEADER_CLASS_FIELDS-->'><!--HEADER_ROW--></th>
diff --git a/Template/HTML_PDF/row.conf b/Template/HTML_PDF/row.conf
@@ -3,5 +3,6 @@
     <td class="<!--HEADER_CLASS_QTY_TAG-->"><!--ROW_PART_QTY--></td>
     <td class="<!--HEADER_CLASS_VALUE_TAG-->"><!--ROW_PART_VALUE--></td>
     <td class="<!--HEADER_CLASS_FOOTPRINT_TAG-->"><!--ROW_PART_FOOTPRINT--></td>
+    <td class="<!--HEADER_CLASS_DATASHEET_TAG-->"><!--ROW_PART_DATASHEET--></td>
     <!--ROW_PART_FIELDS-->
 </tr>