Merge pull request #8 from arduino/dev

Dev

Author: ubidefeo

.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+*.mpy

README.md

@@ -74,16 +74,18 @@ analog_write('A3', 64)
 Will generate a modulated signal on the specified Pin.
 Can be used to control small motors with low current needs as well as servo motors.
 
-#### IMPORTANT
-
-The numeric value for PIN_NUMBER is usually the processor's GPIO number, while values enclosed in quotes are "named pins" and are platform/implementation specific, not guaranteed to be valid.
-A `ValueError` exception with label "invalid pin" is thrown if the pin number or ID is not valid.
+> [!IMPORTANT]  
+> The numeric value for PIN_NUMBER is usually the processor's GPIO number, while values enclosed in quotes are "named pins" and are platform/implementation specific, not guaranteed to be valid. A `ValueError` exception with label "invalid pin" is thrown if the pin number or ID is not valid.
 
 ### delay(MILLISECONDS)
 
 Will halt the execution of your program for the amount of _milliseconds_ specified in the parameter.
 It is to be considered a code-blocking command.
 
+```Python
+delay(1000) # Delay the execution for 1 second
+```
+
 ## Usage
 
 The structure of an Arduino MicroPython program will look as follows:
@@ -137,7 +139,7 @@ Is run indefinitely until the program stops.
 
 ### cleanup()
 
-Is run _once_ when the program stops.
+Is run _once_ when the program stops. This happen either when the user manually stops the execution of the program or if an error in the user code is thrown.
 It should contain code such as resetting the value of variables, stopping timers, causing threads to stop running.
 
 A `cleanup()` enchanced version of our initial program would look like this
@@ -158,6 +160,9 @@ def cleanup():
 start(setup, loop)
 ```
 
+> [!NOTE]
+> `cleanup()` does not get called when the program stops because the hardware button on the board was pressed.
+
 ## Utilities
 
 Some utility methods are provided and are still in development:
@@ -175,9 +180,11 @@ Some utility methods are provided and are still in development:
 
 ## Convenience and scaffolding methods
 
-### create_sketch(SKETCH_NAME, PATH)
+### create_sketch(sketch_name = None, destination_path = '.', overwrite = False, source = None)
 
 Will create a new Python file (`.py`) with the specified name at the provided path.
+By default if a file with the same name is found, it will append a timestamp, but overwrite can be forced to True.
+Providing a source path it will use that file's content, effectively copying the code from one file to the newly created one.
 Example:
 
 ```Python
@@ -186,5 +193,8 @@ create_sketch('my_arduino_sketch', 'tmp')
 create_sketch('main')
 ```
 
-If the destination `.py` file exists, a timestamp in _microseconds_ will be appended to the name.
 The method returns the Python file's full path.
+
+### dcopy_sketch(source_path = '', destination_path = '.', name = None, overwrite = False):
+
+Wraps create_sketch() and provides a shortcut to copy a file onto another file

arduino/arduino.py

@@ -82,21 +82,26 @@ def delay(_ms):
 
 
 # HELPERS
-def create_sketch(sketch_name = None, path = '.', overwrite = False):
+
+def get_template():
+  return '/'.join(__file__.split('/')[:-1]) + '/template.tpl'
+
+
+def create_sketch(sketch_name = None, destination_path = '.', overwrite = False, source_path = None):
 
   if sketch_name is None:
     sketch_name = 'main'
-  new_sketch_path = f'{path}/{sketch_name}.py'
+  new_sketch_path = f'{destination_path}/{sketch_name}.py'
   try:
     open(new_sketch_path, 'r')
     if not overwrite:
       sketch_name = f'{sketch_name}_{ticks_us()}'
   except OSError:
     pass
 
-  template_path = '/'.join(__file__.split('/')[:-1]) + '/template.py'
+  template_path = get_template() if source is None else source
   template_sketch = open(template_path, 'r')
-  new_sketch_path = f'{path}/{sketch_name}.py'
+  new_sketch_path = f'{destination_path}/{sketch_name}.py'
 
   with open(new_sketch_path, 'w') as f:
     sketch_line = None
@@ -107,6 +112,10 @@ def create_sketch(sketch_name = None, path = '.', overwrite = False):
   template_sketch.close()
   return new_sketch_path
 
+def copy_sketch(source_path = '', destination_path = '.', name = None, overwrite = False):
+  name = name or 'main'
+  return create_sketch(sketch_name = name, destination_path = destination_path, overwrite = overwrite, source_path = source_path)
+
 # the following methods are just for testing
 # will produce output when this module is run as __main__
 def preload():

arduino/template.py

@@ -0,0 +1,19 @@
+# Code generated by Arduino Runtime for MicroPython
+from arduino import *
+
+def setup():
+  # your initialization code goes here
+  # this code only runs once at start
+  print('setup')
+
+def loop():
+  # code that needs to run repeatedly goes here
+  print('loop')
+  delay(1000)
+
+def cleanup():
+  # code to cleanup or reset things when the program stops goes here
+  print('cleanup')
+
+# start your program
+start(setup, loop, cleanup)

arduino/template.tpl

@@ -17,9 +17,9 @@ def setup():
 
 def loop():
   print('loopy loop')
-  digitalWrite(led, HIGH)
+  digital_write(led, HIGH)
   delay(500)
-  digitalWrite(led, LOW)
+  digital_write(led, LOW)
   delay(500)
 
 start(setup, loop)

examples/arduino_basic.py

@@ -34,9 +34,9 @@ def blink_me(_timer):
 	print('blink')
 	led_builtin_state = not led_builtin_state
 	if led_builtin_state:
-		digitalWrite(led_builtin, HIGH)
+		digital_write(led_builtin, HIGH)
 	else:
-		digitalWrite(led_builtin, LOW)
+		digital_write(led_builtin, LOW)
 
 def timed_message(_timer):
   print('hello')
@@ -47,16 +47,16 @@ def setup():
   message_timer.init(period = 2000, mode = Timer.PERIODIC, callback = timed_message)
 
 def loop():
-  if digitalRead(button):
-    digitalWrite(led_red, LOW)
+  if digital_read(button):
+    digital_write(led_red, LOW)
   else:
-    digitalWrite(led_red, HIGH)  
+    digital_write(led_red, HIGH)  
 
 def cleanup():
   print("*** cleaning up ***")
   blink_timer.deinit()
   message_timer.deinit()
-  digitalWrite(led_builtin, LOW)
-  digitalWrite(led_red, HIGH)
+  digital_write(led_builtin, LOW)
+  digital_write(led_red, HIGH)
 
 start(setup, loop, cleanup)

examples/nano_esp32_advanced.py

@@ -19,38 +19,97 @@ LIBDIR="lib"
 #   File "<stdin>", line 2, in <module>
 # OSError: [Errno 17] EEXIST
 
-echo "Creating $LIBDIR on board"
-mpremote mkdir "${LIBDIR}"
-echo "Creating $LIBDIR/$PKGDIR on board"
-mpremote mkdir "/${LIBDIR}/${PKGDIR}"
+# Check if a directory exists
+# Returns 0 if directory exists, 1 if it does not
+function directory_exists {
+  # Run mpremote and capture the error message
+  error=$(mpremote fs ls $1)
+
+  # Return error if error message contains "OSError: [Errno 2] ENOENT"
+  if [[ $error == *"OSError: [Errno 2] ENOENT"* ]]; then
+      return 1
+  else
+      return 0
+  fi
+}
+
+# Copies a file to the board using mpremote
+# Only produces output if an error occurs
+function copy_file {
+  echo "Copying $1 to $2"
+  # Run mpremote and capture the error message
+  error=$(mpremote cp $1 $2)
+
+  # Print error message if return code is not 0
+  if [ $? -ne 0 ]; then
+    echo "Error: $error"
+  fi
+}
+
+# Deletes a file from the board using mpremote
+# Only produces output if an error occurs
+function delete_file {
+  echo "Deleting $1"
+  # Run mpremote and capture the error message
+  error=$(mpremote rm $1)
+
+  # Print error message if return code is not 0
+  if [ $? -ne 0 ]; then
+    echo "Error: $error"
+  fi
+}
+
+echo "Installing Arduino Runtime for MicroPython"
+
+# If directories do not exist, create them
+if ! directory_exists "/${LIBDIR}"; then
+  echo "Creating $LIBDIR on board"
+  mpremote mkdir "${LIBDIR}"
+fi
+
+if ! directory_exists "/${LIBDIR}/${PKGDIR}"; then
+  echo "Creating $LIBDIR/$PKGDIR on board"
+  mpremote mkdir "/${LIBDIR}/${PKGDIR}"
+fi
+
 
 ext="py"
 if [ "$1" = "mpy" ]; then
   ext=$1
-  echo "* * *"
   echo ".py files will be compiled to .mpy"
-  echo "* * *"
 fi
 
-for py in $SRCDIR/*; do
-    f_name=`basename $py`
-    if [ "$ext" = "mpy" ]; then
+existing_files=$(mpremote fs ls ":/${LIBDIR}/${PKGDIR}")
+
+for filename in $SRCDIR/*; do
+    f_name=`basename $filename`
+    source_extension="${f_name##*.}"
+    destination_extension=$source_extension
+
+    if [[ "$ext" == "mpy" && "$source_extension" == "py" ]]; then
       echo "Compiling $SRCDIR/$f_name to $SRCDIR/${f_name%.*}.$ext"
       mpy-cross "$SRCDIR/$f_name"
+      destination_extension=$ext
     fi
 
-    echo "Deleting files from board"
-    mpremote rm ":/${LIBDIR}/$PKGDIR/${f_name%.*}.py"
-    mpremote rm ":/${LIBDIR}/$PKGDIR/${f_name%.*}.mpy"
+    # Make sure previous versions of the given file are deleted.
+    if [[ $existing_files == *"${f_name%.*}.$source_extension"* ]]; then
+      delete_file ":/${LIBDIR}/$PKGDIR/${f_name%.*}.$source_extension"
+    fi
+
+    # Check if source file has a .py extension and if a .mpy file exists on the board
+    if [ "$source_extension" = "py" ] && [[ $existing_files == *"${f_name%.*}.mpy"* ]]; then
+      delete_file ":/${LIBDIR}/$PKGDIR/${f_name%.*}.mpy"
+    fi
 
-    echo "Copying $SRCDIR/${f_name%.*}.$ext to :/${LIBDIR}/$PKGDIR/${f_name%.*}.$ext"
-    mpremote cp $SRCDIR/${f_name%.*}.$ext ":/${LIBDIR}/$PKGDIR/${f_name%.*}.$ext" 
+    # Copy either the .py or .mpy file to the board depending on the chosen option
+    copy_file $SRCDIR/${f_name%.*}.$destination_extension ":/${LIBDIR}/$PKGDIR/${f_name%.*}.$destination_extension"
 done
 
 if [ "$ext" = "mpy" ]; then
   echo "cleaning up mpy files"
   rm $SRCDIR/*.mpy
 fi
 
-echo "resetting target board"
+echo "Done. Resetting target board ..."
 mpremote reset