Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
projects:wikibass [2025/02/27 19:31] – [Setup] darronprojects:wikibass [2025/02/28 11:28] (current) darron
Line 1: Line 1:
-====WikiBASS Wikibase demo====+====wikiBASS Wikibase demo====
  
 [[projects:wikibass#wikibass|wikiBASS]] is a [[tools:wikibase|Wikibase]] demo program that creates a [[:tools:wikibase|Wikibase]] of [[projects:wikibass#wikibass|wikiBASS]] is a [[tools:wikibase|Wikibase]] demo program that creates a [[:tools:wikibase|Wikibase]] of
 STM32 microcontroller development boards and their microcontrollers. STM32 microcontroller development boards and their microcontrollers.
  
-WikiBASS requires [[tools:stm32#stm32cubemx|STM32CubeMX]] to be installed in order to gather board information from its XML files. wikiBASS will also scrape added information with [[:tools:selenium|Selenium]] Chrome/chromium automation.+WikiBASS requires [[tools:stm32#stm32cubemx|STM32CubeMX]] to be installed in order to gather board information from its XML files. wikiBASS will also scrape additional information with [[:tools:selenium|Selenium]] Chrome/chromium automation.
  
 If you do not have access to a [[tools:wikibase|Wikibase]] server then install [[:tools:mediawiki|Mediawiki]] with the [[tools:wikibase|Wikibase]] extension. If you do not have access to a [[tools:wikibase|Wikibase]] server then install [[:tools:mediawiki|Mediawiki]] with the [[tools:wikibase|Wikibase]] extension.
Line 120: Line 120:
 </code> </code>
  
-STM32CUBEMX points to the installation directory which is probably as the above on Windows.+STM32CUBEMX points to the installation directory which is probably the above on Windows
 + 
 +The .env file must be found in the current directory to be used by the script when it is called. 
 + 
 +For Debian shells the environment variables can be placed within the 
 +login profile instead of the .env file.
 === Install ==== === Install ====
  
Line 138: Line 143:
 === Run === === Run ===
  
-Building the demo [[:tools:wikibase|Wikibase]] is comprised of three steps.+Building the demo [[:tools:wikibase|Wikibase]] is comprised of running the script three times to perform three distinct operations. 
 + 
 +   - Parse XML board files 
 +   - Scrape board schematics 
 +   - Scrape chip datasheets
  
-   * Parse XML board files +Step one to parse the XML board files must be performed first.
-   * Scrape board schematics +
-   * Scrape chip datasheets+
  
-The XML board files need to processed prior to scraping.+You can analyse the script [[https://hg.kewl.org/pub/wikiBASS/file/tip/src/wikiBASS/stm32.py|here]].
  
 ==Debian== ==Debian==
Line 169: Line 176:
 ===Demo=== ===Demo===
  
-Visit the demo [[https://mediawiki.kewl.org/wiki/Item:Q1|site]] to navigate the board root+Visit the demo [[https://mediawiki.kewl.org/wiki/Item:Q1|site]] to navigate the board root.