Reworked API for map/mapi into map_float/map_int.

Signed-off-by: ubi de feo <[email protected]>

Author: ubidefeo

README.md

@@ -7,6 +7,7 @@ This module also wraps machine functions in easy-to-use methods.
 ## Installation
 
 ### mip (MicroPython Package Manager)
+
 This is the recommended method for boards which can connect to Internet.
 Run the following MicroPython script using your favourite editor:
 
@@ -43,7 +44,9 @@ connect(SSID, PWD)
 mip.install('github:arduino/arduino-runtime-mpy')
 
 ```
+
 ### mpremote mip
+
 You will need to have Python and `mpremote` installed on your system, [follow these instructions](https://docs.micropython.org/en/latest/reference/mpremote.html) to do so.
 
 Open a shell and run the following command:
@@ -53,8 +56,8 @@ mpremote mip install "github:arduino/arduino-runtime-mpy"
 ```
 
 ### Manual Installation
-Copy the folder `arduino` and its content into your board's `lib` folder using your preferred method.
 
+Copy the folder `arduino` and its content into your board's `lib` folder using your preferred method.
 
 ## Usage
 
@@ -219,10 +222,10 @@ delay(1000) # Delay the execution for 1 second
 
 Some utility methods are provided and are still in development:
 
-* `map(x, in_min, in_max, out_min, out_max)`
-  Remaps the value `x` from its input range to an output range
-* `mapi(x, in_min, in_max, out_min, out_max)`
-  same as `map` but always returns an integer
+* `map_float(x, in_min, in_max, out_min, out_max)`
+  Remaps the value `x` from its input range to an output range as a float
+* `map_int(x, in_min, in_max, out_min, out_max)`
+  same as `map_float` but always returns an integer
 * `random(low, high=None)`
   Returns a random number between `0` and `low` - 1 if no `high` is provided, otherwise a value between `low` and `high` - 1
 * `constrain(val, min_val, max_val)`
@@ -248,6 +251,6 @@ create_sketch('main')
 
 The method returns the Python file's full path.
 
-### copy_sketch(source_path = '', destination_path = '.', name = None, overwrite = False):
+### copy_sketch(source_path = '', destination_path = '.', name = None, overwrite = False)
 
-Wraps `create_sketch()` and provides a shortcut to copy a file to another path.
+Wraps `create_sketch()` and provides a shortcut to copy a file to another path.

arduino/arduino.py

@@ -15,11 +15,11 @@
 LOW = 0 # Voltage level LOW
 
 # UTILITY
-def map(x, in_min, in_max, out_min, out_max) -> int | float:
+def map_float(x, in_min, in_max, out_min, out_max) -> int | float:
   return (x - in_min) * (out_max - out_min) / (in_max - in_min) + out_min
 
-def mapi(x, in_min, in_max, out_min, out_max) -> int:
-  return int(map(x, in_min, in_max, out_min, out_max))
+def map_int(x, in_min, in_max, out_min, out_max) -> int:
+  return int(map_float(x, in_min, in_max, out_min, out_max))
 
 def random(low, high=None) -> int:
   if high == None:
@@ -63,7 +63,7 @@ def analogRead(_pin) -> int:
 
 def analog_write(_pin, _duty_cycle) -> None:
   p = PWM(Pin(_pin))
-  duty = mapi(_duty_cycle, 0, 255, 0, 65535)
+  duty = map_int(_duty_cycle, 0, 255, 0, 65535)
   p.duty_u16(floor(duty))
 
   if(_duty_cycle == 0):