micrOS

micropython based smart edge IoT platform

#telnet #wifi #esp32 #tinypico #RaspberryPiPicoW(beta) #ota #GPIO #RTC/NTP #AP/STA #IRQ #async-tasks #cron

📲 💻 Communication over WiFi: Generic communication API
   ✉️ Expose upython module functions - telnet TCP/IP
⚙️ 📝 Device initialization from user config
🧩 Codeless end user experience via phone client
🚪 No external server or service required for client-device communication
   ⚠️ 🛡 Works on Local Network (WiFi-WLAN)
🛠 Easy to customize, create your own Load Modules:
   1. Write LM_<your_app>.py
   2. Copy (OTA/USB) python script to your device (drap&drop)
   3. Call any function from <your_app> module
🦾 Built-in scheduling (IRQs):
   - Time stamp based
   - Geolocation based utc + sunset, sunrise rest features
   - Simple periodic
   - Async task manager

🚀🎈Lightweight and high performance core system that leaves you space 😎

◉ Shortcuts:

micrOS Client Application link
micrOS Installer link
micrOS Tutorials link
micrOS System and features link
Pin mapping - GPIO link
micrOS Node configuration link
micrOS customization with LMs: link

Thingiverse 3D print projects: link
Youtube: link
Facebook page: link

micrOS Client Application

Installing micrOS with DevToolKit #ESP32

macOS / Windows / Linux to install any esp32 board

End-to-End solution for deployment, update, monitor and develop micrOS boards.

I would suggest to use micrOS GUI as a primary interface for micrOS development kit, but you can use cli as well if you prefer.

Note: The main purpose of the USB deployment scripts to install micropython on the board and put all micrOS resources from micrOs/toolkit/workspace/precompiled to the connected board.

1. Install python3.9

Link for python 3.9 download

Note: Allow extend system path with that python version (installation parameter)
On Windows: RUN AS ADMINISTARTOR

2. Install micrOS devToolKit GUI

On macOS

Open command line, press: commnd+space + type: terminal + press: enter

2.1. Download and install micrOS devToolKit python package:

python3 -m pip install --upgrade pip; python3 -m pip install git+https://github.com/BxNxM/micrOS.git

Note: macOS will drop a message to install git, please follow the install guide steps.
Use the same command abow to update micrOS devToolkit GUI
FYI: Manual git install on macOS xcode-select --install; git --version

On Windows:

2.1. Install git for devToolKit download

download git from here

Restart Windows after python install, because it's windows :)

2.2. Download and install micrOS devToolKit python package:

Open Windows PowerShell, press windows+R + type: powershell + press enter

Copy the following lines to the PowerShell and press enter.

python -m pip install --upgrade pip
python -m pip install git+https://github.com/BxNxM/micrOS.git

NOTE: Wait for the installation, it may take several minutes to finish.
Use the same command abow to update micrOS devToolkit GUI

3. Start micrOS devToolKit GUI

Copy the following command to the command line and press enter to start.

devToolKit.py

It will open a graphical user interface for micrOS device management, like usb deploy, update, OTA operations, test executions, etc...

Example

1. Select BOARD TYPE
2. Click on [Deploy (USB)] button -> presss YES

It will install your board via USB with default settings. Continue with micrOS Client app...

Note: At the first USB deployment, devToolKit will ask to install SerialUSB driver and it will open the driver installer as well, please follow the steps and install the necessary driver.

╔╗ ╔╗                  ╔═══╗╔╗ ╔╗╔═╗ ╔╗       ╔═══╗
║║ ║║                  ║╔══╝║║ ║║║║╚╗║║       ╚╗╔╗║
║╚═╝║╔══╗ ╔╗╔╗╔══╗     ║╚══╗║║ ║║║╔╗╚╝║    ╔═╗ ║║║║
║╔═╗║╚ ╗║ ║╚╝║║╔╗║     ║╔══╝║║ ║║║║╚╗║║    ╚═╝ ║║║║
║║ ║║║╚╝╚╗╚╗╔╝║║═╣    ╔╝╚╗  ║╚═╝║║║ ║║║    ╔═╗╔╝╚╝║
╚╝ ╚╝╚═══╝ ╚╝ ╚══╝    ╚══╝  ╚═══╝╚╝ ╚═╝    ╚═╝╚═══╝

micrOS Projects

micrOS Video Tutorials

micrOS System, message-function visualization

Note: micrOS development kit contains command line interface for socket communication. Example: devToolKit.py --connect

micrOS Framework Features💡

🕯micrOS loader - starts micrOS or WEBREPL(update / recovery modes)
- OTA update - push update over wifi (webrepl automation) / monitor update and auto restart node
📄Config handling - user config - node_config.json
- ⏳Boot phase - preload Load Module(s)
  - For pinout and last state initialization - based on node_config boothook
  - Example values: rgb load_n_init; neopixel load_n_init
- 📡Network handling - based on node_config
  - STA / AP network modes, nwmd
  - NTP + UTC aka clock setup
    - API: ip-api.com
  - Static IP configuration, devip
  - dhcp hostname setup, devfid.local
- ⚙️Scheduling / External events - Interrupt callback - based on node_config
  - Time based
    - ⌛️simple LM task pool execution timirq & timirqcbf
      - Timer(0)
    - 🗓cron [time stump!LM task] pool execution cron & crontasks
      - Timer(1)
      - timestamp: WD:H:M:S!LM FUNC, ranges: 0-6:0-23:0-59:0-59!LM FUNC
        
        example: *:8:0:0!rgb rgb r=10 g=60 b=100; etc., it will set rgb color on analog rgb periphery at 8am every day.
      - tag: sunset / sunrise
        
        example: sunset!rgb rgb r=10 g=60 b=100; etc., it will set rgb color on analog rgb periphery at every sunset, every day.
        
        API: api.sunrise-sunset.org
  - 💣Event based
    - Set trigger event irqX
      - Trigger up/down/both irqX_trig
      - With LM callback function irqX_cbf
    - X = 1, 2, 3 or 4
⚙️**[L]oad [M]odule** aka application handling
- Lot of built-in functions (table below)
- Create your own module with 3 easy steps
  - Create a python file, naming convention: LM_<your_app_name>.py
    - Replace <your_app_name> for anything you prefer!
  - Write python functions, you can call any function from that module...
  - Upload modul with "drag&Drop" with help of devToolKit GUI devToolKit.py
📨Socket interpreter - wireless communication interface with the nodes
- System commands: help, version, reboot, webrepl, webrepl --update, etc.
  - After webrepl --update command the micrOS system reboots and waits for ota update in webrepl mode.
- Config handling SET/GET/DUMP - node_config.json
  - enter configuration mode: conf
  - exit configuration mode:noconf
  - Print out all parameters and values: dump
- LM - Load Module function execution (application modules)
  - Example: system info
🖇**[L]ogical [P]inout** handling - lookuptables for each board
- Predefined pinout modules for esp32, tinyPico
- Create your pinout based on LP_esp32.py, naming convencion: LP_<name>.py
- To activate your custom pinout set cstmpmap config parameter to <name>
📍Task manager aka Async LM jobs - Capable of execute [L]oad [M]odules in the background - Invoke with single execution & or loop execution && - Example: - In loop: system heartbeat && - Loop frequency conrol: system heartbeat &&1000, it will execute every sec - Single call: system heartbeat & - Delayed execution (ms): system heartbeat &1000, waits 1 sec before execution. - Stop task: task kill system.heartbeat - Show task live ouput: task show system.heartbeat

⌘ DevToolKit CLI feature:

Socket client python plugin - interactive - non interactive mode

Built in periphery support

#Sensors / inputes #Actuators / outputs

[CLICK] Show micrOS Load Module functions

Device Pinouts for wiring

Logical pin association handling

micrOS/source/LogicalPins.py

LogicalPin lookup tables:

tinypico
esp32
esp32s2
raspberryPicoW NO STABILE MICROPYTHON YET: micropython for rpw

Note: Good idea to use costant variable for pin map declaration, check the files for more info, These files are also precompiled automatically into byte steams -> .mpy

GENERAL CONTROLLER CONCEPT: microPLC

micrOS node configuration, parameters with description

Config keys	Default value and type	Reboot required	Description
`devfid`	`node01` `<str>`	Yes	Device friendly "unique" name - also used for AccessPoint nw mode (AP name)
`boostmd`	`True` `<bool>`	Yes	boost mode - set up cpu frequency low or high 8MHz-16Mhz-24MHz (depends on boards)
`staessid`	`your_wifi_name` `<str>`	Yes	Wifi router name (for default connection mode)
`stapwd`	`your_wifi_passwd` `<str>`	Yes	Wifi router password (for default connection mode)
`appwd`	`ADmin123` `<str>`	Yes	Device system password.: Used in AP password (access point mode) + webrepl password
`auth`	`False` `<bool>`	Yes	Enables socket password authentication, password: `appwd`. Passwordless functions: `hello`, `version`, `exit`. WARNING OTA upade not supported in this mode.
`utc`	`60` `<int>`	Yes	NTP-RTC - timezone setup (UTC in minute) - it is automatically calibrated in STA mode based on geolocation.
`boothook`	`n/a` `<str>`	Yes	Callback function(s) list for priority Load Module(s) execution in boot sequence [before network setup!]. Add LoadModule(s) here, separator `;`. Example: Set LED colors / Init custom module(s) / etc.
`aioqueue`	`4` `<int>`	Yes	Set asyc task queue limit, system overload protection
`timirq`	`False` `<bool>`	Yes	Timer(0) interrupt enabler - background "subprocess" emulation, timer based infinite loop for the LoadModule execution
`timirqcbf`	`n/a` `<str>`	Yes	if `timirq` enabled, calls the given Load Module(s), e.x.: `module function optional_parameter(s)`, task separator: `;`
`timirqseq`	`1000` `<int>`	Yes	Timer interrupt period in ms, default: `3000` ms (for `timirq` infinite loop timer value)
`cron`	`False` `<bool>`	Yes	Cron enabler, Timer(1) interrupt enabler - time based task scheduler.
`cronseq`	`3000` `<int>`	Yes	Cron (Timer(1)) interrupt period in ms, default: `3000` ms (for `cron` infinite loop timer value)
`crontasks`	`n/a` `<str>`	Yes	Cron scheduler input, task format: `WD:H:M:S!module function` e.g.: `1:8:0:0!system heartbeat`, task separator in case of multiple tasks: `;`. [WD:0-6, H:0-23, M:0-59, S:0-59] in case of each use: `` Note*: If the value was `n/a` default, then reboot required.
`irq1`	`False` `<bool>`	Yes	External event interrupt enabler - Triggers when desired signal state detected - button press happens / motion detection / etc
`irq1_cbf`	`n/a` `<str>`	Yes	`irq1` enabled, calls the given Load Modules, e.x.: `module function optional_parameter(s)` when external trigger happens
`irq1_trig`	`n/a` `<str>`	Yes	Sets trigger mode for external irq, signal phase detection, values `up` (default: `n/a`) or `down` or `both`.
`irq2`	`False` `<bool>`	Yes	External event interrupt enabler - Triggers when desired signal state detected - button press happens / motion detection / etc
`irq2_cb`f	`n/a` `<str>`	Yes	`irq2` enabled, calls the given Load Modules, e.x.: `module function optional_parameter(s)` when external trigger happens
`irq2_trig`	`n/a` `<str>`	Yes	Sets trigger mode for external irq, signal phase detection, values `up` (default: `n/a`) or `down` or `both`.
`irq3`	`False` `<bool>`	Yes	External event interrupt enabler - Triggers when desired signal state detected - button press happens / motion detection / etc
`irq3_cbf`	`n/a` `<str>`	Yes	`irq3` enabled, calls the given Load Modules, e.x.: `module function optional_parameter(s)` when external trigger happens
`irq3_trig`	`n/a` `<str>`	Yes	Sets trigger mode for external irq, signal phase detection, values `up` (default: `n/a`) or `down` or `both`.
`irq4`	`False` `<bool>`	Yes	External event interrupt enabler - Triggers when desired signal state detected - button press happens / motion detection / etc
`irq4_cbf`	`n/a` `<str>`	Yes	`irq4` enabled, calls the given Load Modules, e.x.: `module function optional_parameter(s)` when external trigger happens.
`irq4_trig`	`n/a` `<str>`	Yes	Sets trigger mode for external irq, signal phase detection, values `up` (default: `n/a`) or `down` or `both`.
`irq_prell_ms`	`300` `<int>`	Yes	"Prell": contact recurrence (hw property), for fake event filtering... :D Time window to ignore external IRQ events in ms.
`cstmpmap`	`n/a` `<str>`	Yes	Default (`n/a`), select pinmap automatically based on platform (`LP_<platform>`). Manual control / customization of application pins, syntax: `pin_map_name; pin name:pin number;` etc. [1][optional] `pin_map_name` [L]ogical[P]in represented as `LP_<pin_map_name>.py/.mpy` file on device. [2+][optinal] `dht:22` overwrite individual existing load module pin(s). Hint: `<module> pinmap()` to get app pins, example: `neopixel pinmap()`
`dbg`	`True` `<bool>`	Yes	Debug mode - enable micrOS system printout, server info, etc. + progress LED (heartbeat)
`soctout`	`100` `<int>`	Yes	Socket server connection timeout (because single process socket interface)
`socport`	`9008` `<int>`	Yes	Socket server service port (should not be changed due to client and API inconpatibility)
`devip`	`n/a` `<str>`	Yes(N/A)	Device IP address, (first stored IP in STA mode will be the device static IP on the network), you are able to provide specific static IP here.
`nwmd`	`n/a` `<str>`	N/A	Prefered network mode - `AP` or `STA`
`hwuid`	`n/a` `<str>`	N/A	USED BY SYSTEM (state storage) - hardware address - dev uid
`guimeta`	`n/a` `str`	No	USED BY micrOS Client (state storage) - stores - offloaded parameter type in config. Clinet widget meta data.

Note: Default empty value: n/a in case of string parameter. Note: Cron is only available on devices with Timer(1): esp32

Networking - automatic network modes

micrOS Customization

Aka How to write Load Modules

Create python file with the following naming convension: LM_your_app.py
You can create any function in this modul, these will be exposed by micrOS framework over tcp/ip so these can be accessable via phone client.
drag-n-drop LM file to micrOS devToolKit GUI
Select device
Press upload

LM_simple.py

def hello(name="Anonimus"):
	return "Hello {}!".format(name)
	
def add_two_numbers(a, b):
	return "{}+{} = {}".format(a, b, a+b)

LM_template.py

Function naming convesions for Load Modules.

from LogicalPins import physical_pin, pinmap_dump
from machine import Pin

def load_n_init():
	"""
	[RECOMMENDED]
	Function naming convension to create IO (Pin) objects
	- function to initialize IO peripheries

	physical_pin - to resolve pin on board by logical name (tag)
	"""
	
	pin_number = physical_pin('redgb')
	red = Pin(pin_number)
	return red


def lmdep():
   """
   [OPTIONAL] [IN CASE OF LM DEPENDENCY]
   Function to return Load Module dependencies (tuple)
   - example: if this module uses LM_rgb.py, you should
   				 return 'rgb'
   """
	return '<module_name>'


def pinmap():
	"""
	[OPTIONAL]
	Return list of pins
	Example:
		RoboArm $  rgb pinmap >json
		{"rgbue": 15, "rgreenb": 12, "redgb": 14}
	return: dict {pinkey: pinvalue}
	
	pinmap_dump - logical pinmap resolver based on LP_<device_tag>.py
	
	Example:
	return pinmap_dump(['redgb', 'rgreenb', 'rgbue'])
	"""
	return {}


def status(lmf=None):
	"""
	[OPTIONAL]
	Function naming convension for
	module state-machine return
	return: dict
	
	Example in case of RGB color state return
	return {'R': data[0], 'G': data[1], 'B': data[2], 'S': data[3]}
	"""
	return {'key': 'value'}


def help():
	"""
	[OPTIONAL]
	Return help message tuple
	"""
	return 'load_n_init', 'pinmap', 'status', 'lmdep'

System Architecture

Secure Core (OTA static modules): boot.py, micrOSloader.mpy, Network.mpy, ConfigHandler.mpy, Debug.mpy

RELESE NOTE

VERSION (TAG)	RELEASE INFO	MICROS CORE MEMORY USAGE	SUPPORTED DEVICE(S)	APP PROFILES	Load Modules	NOTE
v0.1.0-0	release_Info-0.1.0-0	13 - 28 % (1216-2544byte)	esp8266	App Profiles	LM manual	Stable Core with applications - first release
v0.4.0-0	release_Info-0.4.0-0	26 - 53 % (2512-5072byte)	esp8266	App Profiles	LM manual	micrOS multi device support with finalized core and so more. OTA update feature.
v0.4.0-0	release_Info-0.4.0-0	23 - 28 % (17250-20976byte)	esp32	App Profiles	LM manual	micrOS multi device support with finalized core and advanced task scheduler based on time, and and so more. OTA update feature.
v1.0.0-0	release_Info-1.0.0-0	15 - 23 % (10394-15488byte)	esp32	App Profiles	LM manual	Release of v1 micrOS, timer and event based irqs, cron task scheduling, realtime communication, multiple device support. OTA, etc.
v1.2.2-0	release_Info-1.2.2-0	10-25 %	esp32	App Profiles	LM manual	Public Release of v1 micrOS, timer and event based irqs, cron task scheduling, realtime communication, multiple device support. OTA update, thread from socket shell (beta) etc.
v light-1.3.0-0	-	-	esp8266	lightweight branch	-	remove esp8266 due to memory limitation - BUT still supported with limited functionalities on `lightweight` branch. Hint: Change branch on github and download zip file, then start micrOSDevToolKit dashboard GUI
v 1.5.0-1	release_Info-1.5.0-1	5-14% (6176-16192 byte)	esp32, tinyPico	App Profiles	LM manual	Advanced Timer IRQ based scheduling (cron & timirq), Geolocation based timing features, External IRQs with 4 channel (event filtering), finalized light controls, Device-Device comminucation support, etc.

Developer Quick guide

Erase device & Deploy micropython & Install micrOS

Go to micrOS repo, where the devToolKit.py located.

devToolKit.py --make

Note: Follow the steps :)

Search and Connect to the device

devToolKit.py -s -c

User commands

devToolKit.py -h

optional arguments:
  -h, --help            show this help message and exit

Base commands:
  -m, --make            Erase & Deploy & Precompile (micrOS) & Install (micrOS)
  -r, --update          Update/redeploy connected (usb) micrOS. - node config will be restored
  -s, --search_devices  Search devices on connected wifi network.
  -o, --OTA             OTA (OverTheArir update with webrepl)
  -c, --connect         Connect via socketclinet
  -p CONNECT_PARAMETERS, --connect_parameters CONNECT_PARAMETERS
                        Parameters for connection in non-interactivve mode.
  -a APPLICATIONS, --applications APPLICATIONS
                        List/Execute frontend applications. [list]
  -stat, --node_status  Show all available micrOS devices status data.
  -cl, --clean          Clean user connection data: device_conn_cache.json

Search devices

devToolKit.py --search_devices

or

devToolKit.py -s

List discovered devices with status updates

devToolKit.py -stat

or

devToolKit.py --node_status

Output:

       [ UID ]                [ FUID ]		[ IP ]		[ STATUS ]	[ VERSION ]	[COMM SEC]
__localhost__                 __simulator__     127.0.0.1	OFFLINE		<n/a>		n/a
micrf008d1d2ac30OS            BedLamp           192.168.1.78	ONLINE		1.4.0-1		0.787
micr7c9ebd07a6d0OS            LedGenisys        192.168.1.71	ONLINE		1.3.3-2		1.430
micr240ac4f679e8OS            Chillight         192.168.1.91	ONLINE		1.4.0-0		0.780
micr3c61052fa788OS            RoboArm           192.168.1.79	ONLINE		1.4.0-0		0.539
micr500291863428OS            TinyDevBoard      192.168.1.73	ONLINE		1.4.0-1		1.363

Other Developer commands

Development & Deployment & Connection:
  -f, --force_update    Force mode for -r/--update and -o/--OTA
  -e, --erase           Erase device
  -d, --deploy          Deploy micropython
  -i, --install         Install micrOS on micropython
  -l, --list_devs_n_bins
                        List connected devices & micropython binaries.
  -ls, --node_ls        List micrOS node filesystem content.
  -u, --connect_via_usb
                        Connect via serial port - usb
  -b, --backup_node_config
                        Backup usb connected node config.
  -sim, --simulate      start micrOS on your computer in simulated mode
  -cc, --cross_compile_micros
                        Cross Compile micrOS system [py -> mpy]
  -gw, --gateway        Start micrOS Gateway rest-api server
  -v, --version         Get micrOS version - repo + connected device.

Socket terminal example - non interactive

Identify device

devToolKit.py -c -p '--dev slim01 hello'
Load MicrOS device cache: /Users/bnm/Documents/NodeMcu/MicrOs/tools/device_conn_cache.json
Activate MicrOS device connection address
[i]         FUID        IP               UID
[0] Device: slim01 - 10.0.1.73 - 0x500x20x910x680xc0xf7
Device was found: slim01
hello:slim01:0x500x20x910x680xc0xf7

Get help

devToolKit.py -c -p '--dev BedLamp help'

[MICROS]   - built-in shell commands
   hello   - hello msg - for device identification
   version - returns micrOS version
   exit    - exit from shell socket prompt
   reboot  - system soft reboot (vm), hard reboot (hw): reboot -h
   webrepl - start webrepl, for file transfers use with --update
[CONF] Configure mode - built-in shell commands
  conf       - Enter conf mode
    dump       - Dump all data
    key        - Get value
    key value  - Set value
  noconf     - Exit conf mode
[TASK] postfix: &x - one-time,  &&x - periodic, x: wait ms [x min: 20ms]
  task list         - list tasks with <tag>s
  task kill <tag>   - stop task
  task show <tag>   - show task output
[EXEC] Command mode (LMs):
   help lm  - list ALL LoadModules
   cct
      help
   co2
      help
   dht22
        help
   intercon
           help
   robustness
             help
   system
         help

Embedded config handler

devToolKit.py -c -p '--dev BedLamp conf <a> dump'
  
  staessid  :        <your-wifi-passwd>
  devip     :        10.0.1.204
  version   :        1.11.0-1
  devfid    :        BedLamp
  cron      :        True
  cronseq   :        3000
  soctout   :        10
  irq2_cbf  :        n/a
  stapwd    :        <your-wifi-name>
  dbg       :        False
  irq2      :        False
  irq1      :        False
  irq1_cbf  :        n/a
  appwd     :        ADmin123
  irq2_trig :        n/a
  hwuid     :        micr7c9ebd623ff8OS
  crontasks :        sunset!cct toggle True;*:0:30:0!cct toggle False;*:5:0:0!cct toggle False
  timirq    :        True
  irq3      :        False
  irq3_cbf  :        n/a
  irq4      :        False
  irq4_cbf  :        n/a
  irq4_trig :        n/a
  nwmd      :        STA
  timirqcbf :        system ha_sta
  irq_prell_ms:      300
  boothook  :        cct load_n_init
  aioqueue  :        3
  auth      :        False
  timirqseq :        60000
  utc       :        60
  boostmd   :        True
  socport   :        9008
  irq3_trig :        n/a
  irq1_trig :        n/a
  guimeta   :        ...
  cstmpmap  :        n/a

Load Modules - User defined functions

devToolKit.py -c -p '--dev BedLamp system info'

CPU clock: 24 [MHz]
Mem usage: 60.75 %
FS usage: 13.48 %
upython: v1.19.1 on 2022-06-18
board: ESP32 module with ESP32
mac: 7c:9e:bd:62:3f:f8
uptime: 1 23:20:38

SocketClient

Config:

micrOS/toolkit/user_data/device_conn_cache.json

{
    "__devuid__": [
        "192.168.4.1",
        9008,
        "__device_on_AP__"
    ],
    "__localhost__": [
        "127.0.0.1",
        9008,
        "__simulator__"
    ],
    "micr500291863428OS": [
        "10.0.1.72",
        9008,
        "BedLamp"
    ]
}

Interactive mode

devToolKit.py -c 
or
devToolKit.py -connect

[i]         FUID        IP               UID
[0] Device: __device_on_AP__ - 192.168.4.1 - __devuid__
[1] Device: __simulator__ - 127.0.0.1 - __localhost__
[2] Device: BedLamp - 10.0.1.72 - micr500291863428OS

Choose a device index: 5
Device was selected: ['10.0.1.204', 9008, 'Cabinet']
BedLamp $ help
[MICROS]   - built-in shell commands
   hello   - hello msg - for device identification
   version - returns micrOS version
   exit    - exit from shell socket prompt
   reboot  - system soft reboot (vm), hard reboot (hw): reboot -h
   webrepl - start webrepl, for file transfers use with --update
[CONF] Configure mode - built-in shell commands
  conf       - Enter conf mode
    dump       - Dump all data
    key        - Get value
    key value  - Set value
  noconf     - Exit conf mode
[TASK] postfix: &x - one-time,  &&x - periodic, x: wait ms [x min: 20ms]
  task list         - list tasks with <tag>s
  task kill <tag>   - stop task
  task show <tag>   - show task output
[EXEC] Command mode (LMs):
   help lm  - list ALL LoadModules
   cct
      help
   co2
      help
   dht22
        help
   intercon
           help
   robustness
             help
   system
         help
BedLamp $  exit
Bye!

Project structure

micrOS resources library

micrOS Core

micrOS/source/
      89	Common.py
     217	ConfigHandler.py
     117	Debug.py
      62	Hooks.py
      90	InterConnect.py
     258	InterpreterShell.py
     148	InterruptHandler.py
      48	LP_esp32.py
      47	LP_esp32s2.py
       3	LP_rp2.py
      56	LP_tinypico.py
     131	LogicalPins.py
     189	Network.py
     161	Scheduler.py
     242	SocketServer.py
     435	TaskManager.py
     191	Time.py
      24	TinyPLed.py
      19	main.py
      67	micrOS.py
     118	micrOSloader.py
       9	reset.py
SUM OF CODE LINES: 2721

micrOS Load Modules

micrOS/source/
      68	LM_L298N_DCmotor.py
      47	LM_L9110_DCmotor.py
     323	LM_VL53L0X.py
     299	LM_bme280.py
     225	LM_buzzer.py
      60	LM_catgame.py
     245	LM_cct.py
     122	LM_co2.py
      58	LM_dht11.py
      58	LM_dht22.py
     132	LM_dimmer.py
      70	LM_distance.py
      54	LM_ds18.py
      44	LM_esp32.py
     130	LM_genIO.py
      33	LM_i2c.py
      45	LM_intercon.py
      65	LM_light_sensor.py
     283	LM_neoeffects.py
     282	LM_neopixel.py
     211	LM_oled.py
     391	LM_oled_ui.py
      40	LM_pet_feeder.py
      39	LM_ph_sensor.py
     197	LM_presence.py
     263	LM_rgb.py
     255	LM_roboarm.py
      56	LM_robustness.py
     124	LM_servo.py
     133	LM_stepper.py
     223	LM_switch.py
     228	LM_system.py
      85	LM_tinyrgb.py
SUM OF CODE LINES: 4888

LM (Load Modules) - Application logic - accessable over socket server as a command

micrOS devToolkit resources

DevToolKit Dashboard apps

You can easly copy the Template_app.py, and create a new socket based app. Template_app.py

micrOS/toolkit/dashboard_apps
│   ├── AirQualityBME280_app.py
│   ├── AirQualityDHT22_CO2_app.py
│   ├── AnalogCCT_app.py
│   ├── AnalogRGB_app.py
│   ├── CatGame_app.py
│   ├── Dimmer_app.py
│   ├── GetVersion_app.py
│   ├── GetVersion_app.pyc
│   ├── NeopixelTest_app.py
│   ├── RoboArm_app.py
│   ├── SysCheck_app.py
│   ├── Template_app.py

Stored connection data and default node configs

micrOS/toolkit/user_data
│   ├── device_conn_cache.json        <- connection cache
│   └── node_config_archive
│       ├── BigRGB-node_config.json
│       ├── Chillight-node_config.json
│       ├── Kapcsolo230-node_config.json
│       ├── LampController-node_config.json
│       ├── MeasureNode-node_config.json
│       ├── MrGreen-node_config.json
│       ├── RingLamp-node_config.json
│       └── test-node_config.json

Virtaulenv for development and stored USB-Serial drivers

micrOS/env/
├── __init__.py
├── driver_cp210x
│   ├── CP210x_Universal_Windows_Driver
│   └── macOS_VCP_Driver
├── requirements.txt
└── venv
    ├── bin
    ├── include
    ├── lib
    └── pyvenv.cfg

Precompiled resources for easy install

micrOS/toolkit/workspace/precompiled
    │   ├── BgJob.mpy
    │   ├── Common.mpy
    │   ├── ConfigHandler.mpy
    │   ├── Debug.mpy
    │   ├── Hooks.mpy
    │   ├── InterConnect.mpy
    │   ├── InterpreterCore.mpy
    │   ├── InterpreterShell.mpy
    │   ├── InterruptHandler.mpy
    │   ├── LM_L298N_DCmotor.mpy
    │   ├── LM_L9110_DCmotor.py
    │   ├── LM_VL53L0X.py
    │   ├── LM_bme280.mpy
    │   ├── LM_buzzer.mpy
    │   ├── LM_catgame.py
    │   ├── LM_cct.mpy
    │   ├── LM_co2.mpy
    │   ├── LM_dht11.mpy
    │   ├── LM_dht22.mpy
    │   ├── LM_dimmer.mpy
    │   ├── LM_distance_HCSR04.py
    │   ├── LM_ds18.mpy
    │   ├── LM_esp32.py
    │   ├── LM_genIO.mpy
    │   ├── LM_i2c.py
    │   ├── LM_intercon.mpy
    │   ├── LM_light_sensor.mpy
    │   ├── LM_neoeffects.mpy
    │   ├── LM_neopixel.mpy
    │   ├── LM_oled.mpy
    │   ├── LM_oled_ui.mpy
    │   ├── LM_pet_feeder.py
    │   ├── LM_ph_sensor.py
    │   ├── LM_rgb.mpy
    │   ├── LM_roboarm.mpy
    │   ├── LM_robustness.py
    │   ├── LM_servo.mpy
    │   ├── LM_stepper.mpy
    │   ├── LM_switch.mpy
    │   ├── LM_system.mpy
    │   ├── LM_tinyrgb.mpy
    │   ├── LP_esp32.mpy
    │   ├── LP_tinypico.mpy
    │   ├── LogicalPins.mpy
    │   ├── Network.mpy
    │   ├── Scheduler.mpy
    │   ├── SocketServer.mpy
    │   ├── Time.mpy
    │   ├── TinyPLed.mpy
    │   ├── boot.py
    │   ├── micrOS.mpy
    │   ├── micrOSloader.mpy
    │   └── reset.mpy

Note: From the micrOS/source/ by default the LMs are not compiling, to extend complied LM list add LM explicitly to the following file:

micrOs/toolkit/LM_to_compile.dat

HINTS

Save screen console buffer (output) Press ctrl + A : and type hardcopy -h <filename>
Create callgraph: pycallgraph
Convert PNG/JPG-s to GIF: convert -delay 60 ./*.png mygif.gif
micrOS core source code lines:

core_files=($(ls -1 | grep '.py' | grep -v 'LM_')); all_line_codes=0; for coref in ${core_files[@]}; do content_lines_cnt=$(cat $coref | grep -v -e '^$' | wc -l); all_line_codes=$((all_line_codes+content_lines_cnt)); echo -e "$content_lines_cnt\t$coref"; done; echo -e "SUM OF CODE LINES: $all_line_codes"

micrOS Load Module-s (application-s) source code lines:

core_files=($(ls -1 | grep '.py' | grep 'LM_')); all_line_codes=0; for coref in ${core_files[@]}; do content_lines_cnt=$(cat $coref | grep -v -e '^$' | wc -l); all_line_codes=$((all_line_codes+content_lines_cnt)); echo -e "$content_lines_cnt\t$coref"; done; echo -e "SUM OF CODE LINES: $all_line_codes"

micrOS gateway - Linux service template

Create service: micrOS gateway service
create micros-gw.service file:

[Unit]
Description=micrOS gateway REST API service
After=network-online.target

[Service]
ExecStart=/bin/bash <micrOS repo root>/magic.bash gateway
WorkingDirectory=<micrOS repo root>
StandardOutput=inherit
StandardError=inherit
Restart=always
User=<raspbian user>

[Install]
WantedBy=multi-user.target

start service: sudo systemctl start micros_gw.service
enable serice at bootup: sudo systemctl enable micros_gw.service
show service state: sudo systemctl status micros_gw.service

GIT

Add git tag: git tag -a vX.Y.Z-K -m "tag message"
Publish tags: git push origin --tags
Pretty git view: git log --pretty=oneline
File change list: git diff --name-only fbb4875609a3c0ee088b6a118ebf9f8a500be0fd HEAD | grep 'mpy-MicrOS'
GitHub embed youtube link: https://github.com/itskeshav/Add-youtube-link-in-Readme.md

git push -u origin master

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

BxNxM / micrOS

Programming Languages

Labels

Projects that are alternatives of or similar to micrOS