You are here: start » projects » wikibass

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:21] – [Install] 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 76: Line 76:
 </code> </code>
  
-Later you may invoke a script with+Later you may invoke the script with
 <code> <code>
-py script_name.py+py stm32.py
 </code> </code>
  
 ===Chrome=== ===Chrome===
  
-[[tools:selenium|Selenium]] depends on chrome.exe or chromium being installed.+[[tools:selenium|Selenium]] depends on chrome.exe on Windows or chromium on Linux.
  
 ==Debian== ==Debian==
Line 93: Line 93:
 ==Windows== ==Windows==
  
-[[https://www.google.com/intl/en_uk/chrome/|Visit]]+[[https://www.google.com/intl/en_uk/chrome/|Install]]
  
 ===STM32CubeMX === ===STM32CubeMX ===
Line 120: Line 120:
 </code> </code>
  
 +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 137: 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 +   - Parse XML board files 
-   * Scrape board schematics +   - Scrape board schematics 
-   * Scrape chip datasheets+   - Scrape chip datasheets
  
-The XML board files need to processed prior to scraping.+Step one to parse the XML board files must be performed first. 
 + 
 +You can analyse the script [[https://hg.kewl.org/pub/wikiBASS/file/tip/src/wikiBASS/stm32.py|here]].
  
 ==Debian== ==Debian==
  
-In Debian the scripts are run from within the virtual environment.+In Debian the script is run from within the virtual environment.
  
 <code> <code>
Line 155: Line 163:
 </code> </code>
  
-===Windows/WSL1==+==Windows/WSL1==
  
-For Windows and WSL1 the scripts are run from the installation+For Windows and WSL1 the script is run from the installation
 directory. directory.
  
Line 168: 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.