Skip to content

sparkfun/Keyword_File_Generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Keyword File Genertor

This Python 3 script will generate an Arduino Keyword File from a header file. All that's needed is the following library CppHeaderParser. Run the script from the command line following the instructions below will create a keywords file like the one pictured.

Keyword Success!

Installing Required Library

  • CppHeaderParser : pip install CppHeaderParser

Instructions

To generate your "keywords.txt" file, give the path of the Arduino Library after the call to the keywords python script. There are three methods to do this:

  • Method One

This method requires that the Arduino Library is in the default Github repo installation location: "C:\Users\YourUsername\Documents\Github\Arduino Library". Give the name of the Arduino Library Folder after the call to the script as shown below. Method 1

  • Method Two

The next method is to pull the script into Arduino Library itself (not source ("src") file) and call it without any arguments. Method 2

  • Method Three

Give the entire path to the Arduino Library: Method 3

After running the script you'll get a readout that looks like the following: Script Succes

About

No description or website provided.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages