/ Adafruit_pIRKey / README.txt
README.txt
 1  Welcome to CircuitPython!
 2  #############################
 3  
 4  Visit the pIRkey M0 product page here for more info: 
 5                          https://adafruit.com/product/3364
 6  
 7  
 8  #############################
 9  
10  The pIRkey has a very tiny disk drive so we have disabled Mac OS X indexing
11  which could take up that valuable space. 
12  
13  So *please* do not remove the empty .fseventsd/no_log, .metadata_never_index 
14  or .Trashes files! 
15  
16  #############################
17  
18  The pre-loaded demo files show off what your pIRkey M0 can do with 
19  CircuitPython:
20    * The default 'main.py' will read infrared pulses and print them out
21  to the serial console/REPL
22    * "NEC print example.py" will decode common 'NEC protocol' remotes and
23  print out the 4-digit code to the console
24    * "NEC keyboard example.py" will read NEC protocol remotes and show how 
25  to trigger keyboard commands based on what codes are received. This example
26  is designed to be used with our simple low cost remote 
27                          https://www.adafruit.com/product/389
28  but is easily adapted  to other NEC remotes
29  
30  For more details on how to use and customize the pIRkey & CircuitPython, visit 
31  https://adafruit.com/product/3364 and check out all the tutorials we have!
32  
33  #############################
34  CircuitPython Quick Start:
35  
36  Changing the code is as easy as editing main.py in your favorite text editor. 
37  
38  Our recommended editor is Mu, which is great for simple projects, and comes
39  with a built in REPL serial viewer! It is available for Mac, Windows & Linux
40  https://learn.adafruit.com/welcome-to-circuitpython/installing-mu-editor
41  
42  After the file is saved, CircuitPython will automatically reload the latest 
43  code. Try this out by renaming 'main.py' to 'my backup.py' and then renaming 
44  'NEC print example.py' to main.py to load the different example sketch.
45  These sketches work best when you are also connected to the serial port / REPL
46  
47  Connecting to the serial port will give you access to sensor information, 
48  better error messages and an interactive CircuitPython (known as the REPL). 
49  On Windows we recommend Mu, Tera Term or PuTTY. 
50  On Mac OSX and Linux, use Mu or 'screen' can be used from a terminal.