Leave mos only

Author: cpq

Makefile

@@ -1,32 +1,25 @@
+API = mongoose-os/api
+CATEGORIES ?= core cloud net drivers arduino rpc misc
+DEV ?= ../cesanta.com
+INC ?= ../mongoose-os/include
+HTMLDIR ?= ../website-miot/front/docs
+
+.PHONY: sidebar.html $(API)/core $(API)
+
+
 all: sidebar.html # apps
 
-APPSMD = quickstart/apps.md
-TMP = /tmp/.tmp.mos.yml
-apps:
-	curl -s https://api.github.com/orgs/mongoose-os-apps/repos?per_page=200 |\
-		perl -nle 'print $$1 if /"full_name": "(.*)"/' > /tmp/repos.txt
-	echo '# Example apps' > $(APPSMD)
-	echo '|  GitHub repo  | Description | Author |' >> $(APPSMD)
-	echo '|  ----  | ----------- | --- |' >> $(APPSMD)
-	sort /tmp/repos.txt | while read REPO ; do \
-		curl -s https://raw.githubusercontent.com/$$REPO/master/mos.yml > $(TMP); \
-		echo $$REPO ; \
-		echo "| [$${REPO#*/}](https://github.com/$$REPO) | $$(cat $(TMP) | perl -nle 'print $$1 if /^description: (.*)/') | $$(cat $(TMP) | perl -nle 'print $$1 if /^author: (.*)/') | " >> $(APPSMD) ;\
-		done
+list:
+	curl -s https://api.github.com/orgs/mongoose-os-libs/repos?per_page=200 |\
+		perl -nle 'print $$1 if /"full_name": "(.*)"/' > $@.txt
 
-API = mongoose-os/api
-.PHONY: sidebar.html $(API)/core $(API)
+sync: list
+	@for REPO in $$(cat list.txt) ; do test -d $$REPO && (cd $$REPO && git pull) || (mkdir -p $$(dirname $$REPO) ; cd $$(dirname $$REPO); git clone [email protected]:$$REPO.git); done
 
-CATEGORIES ?= core cloud net drivers arduino rpc misc
 clean-generated:
 	@for C in $(CATEGORIES) ; do rm -rf $(API)/$$C; mkdir $(API)/$$C; touch $(API)/$$C/index.md ; done
 
 
-LIBS ?= /tmp/libs
-LIBSINDEX ?= /tmp/libs.txt
-DEV ?= ../cesanta.com
-INC ?= ../mongoose-os/include
-
 $(API)/core: clean-generated
 	@echo '[]' > symbols.json
 	@(cd $(INC) && ls *.h) | while read F; do node tools/genapi.js $@/$$F.md cesanta/mongoose-os $(INC)/$$F >> $@/index.md; done
@@ -36,17 +29,8 @@ $(API)/core: clean-generated
 	@node tools/genapi.js $@/mg_str.h.md cesanta/mongoose-os $(DEV)/common/mg_str.h >> $@/index.md
 
 $(API):
-	@test -f $(LIBSINDEX) || curl -s https://api.github.com/orgs/mongoose-os-libs/repos?per_page=200 | perl -nle 'print $$1 if /"full_name": "(.*)"/' | sort > $(LIBSINDEX)
-	@mkdir -p $(LIBS)
-	@cat $(LIBSINDEX) | while read REPO ; \
-		do echo $$REPO; \
-		BR=$$(basename $$REPO); \
-		if test -d $(DEV)/mos_libs/$$BR; then \
-			R=$(DEV)/mos_libs/$$BR; \
-		else \
-			R=$(LIBS)/$$BR; \
-			test -d $$R && (cd $$R && git pull --quiet) || git clone --quiet https://github.com/$$REPO $$R; \
-		fi; \
+	@for REPO in mongoose-os-libs/* ; do \
+		echo $$REPO; BR=$$(basename $$REPO); R=$$REPO; \
 		CATEGORY=$$(perl -ne 'print $$1 if /docs:(.+?):(.+?)/' $$R/mos.yml); \
 		test -z "$$CATEGORY" && CATEGORY=misc && echo "  github.com/$$REPO is missing docs:tag!"; \
 		TITLE=$$(perl -ne 'print $$2 if /docs:(.+?):(.+?)\s*$$/' $$R/mos.yml); \
@@ -64,11 +48,7 @@ sidebar.html: $(API)/core $(API)
 	@node tools/gensidebar.js > $@
 
 
-HTMLDIR ?= ../website-miot/front/docs
 html:
 	rm -rf $(HTMLDIR)/*
 	@node tools/genhtml.js "$(HTMLDIR)" $$(find . -name \*.md)
 	cp sidebar.html $(HTMLDIR)/
-
-clean:
-	rm -rf $(LIBS) $(LIBSINDEX)

index.md

@@ -1,6 +1,3 @@
 - [Mongoose OS](mongoose-os)
-- [CCM communication module](ccm)
-- [Kiwi BLE gateway](kiwi)
-- [UART gateway](uart-gateway)
 
 

mongoose-os/api/index.md

@@ -3,5 +3,5 @@
 - [Networking](net)
 - [Drivers](drivers)
 - [Arduino compat](arduino)
-- [RPC remote management](rpc)
+- [RPC](rpc)
 - [Misc](misc)

mongoose-os/api/net/mqtt.md

@@ -136,6 +136,15 @@ bool mgos_mqtt_global_connect(void);
 > Normally MQTT will try to connect in the background, at certain interval.
 > This function will force immediate connection attempt.
 >  
+#### mgos_mqtt_global_disconnect
+
+```c
+void mgos_mqtt_global_disconnect(void);
+```
+> 
+> Disconnect from and/or stop trying to connect to MQTT server
+> until mgos_mqtt_global_connect() is called.
+>  
 #### mgos_mqtt_global_is_connected
 
 ```c
@@ -145,23 +154,23 @@ bool mgos_mqtt_global_is_connected(void);
 #### mgos_mqtt_pub
 
 ```c
-bool mgos_mqtt_pub(const char *topic, const void *message, size_t len, int qos,
-                   bool retain);
+uint16_t mgos_mqtt_pub(const char *topic, const void *message, size_t len,
+                       int qos, bool retain);
 ```
 > 
 > Publish message to the configured MQTT server, to the given MQTT topic.
-> Return value will be true if there is a connection to the server and the
-> message has been queued for sending. In case of QoS 1 return value does
-> not indicate that PUBACK has been received; there is currently no way to
-> check for that.
+> Return value will be the packet id (> 0) if there is a connection to the
+> server and the message has been queued for sending. In case no connection is
+> available, 0 is returned. In case of QoS 1 return value does not indicate
+> that PUBACK has been received; there is currently no way to check for that.
 >  
 #### mgos_mqtt_pubf
 
 ```c
-bool mgos_mqtt_pubf(const char *topic, int qos, bool retain,
-                    const char *json_fmt, ...);
-bool mgos_mqtt_pubv(const char *topic, int qos, bool retain,
-                    const char *json_fmt, va_list ap);
+uint16_t mgos_mqtt_pubf(const char *topic, int qos, bool retain,
+                        const char *json_fmt, ...);
+uint16_t mgos_mqtt_pubv(const char *topic, int qos, bool retain,
+                        const char *json_fmt, va_list ap);
 ```
 >  Variant of mgos_mqtt_pub for publishing a JSON-formatted string 
 #### (*sub_handler_t)

mongoose-os/api/rpc/rpc-gatts.md

@@ -25,33 +25,4 @@ Three attributes are defined:
  - `5f6d4f53-5f52-5043-5f72-785f63746c5f (_mOS_RPC_rx_ctl_)` - a read/notify attribute. It returns the length of the frame that device wishes to transmit as a big-endian 32-bit number. If this value is not zero, frame data will be returned in response to read requests of the data attribute. Read chunks will be up to MTU bytes in size. Client may subscribe to notifications on this attribute. Notification will be sent whenever a new frame is submitted for delivery and the notification body will contain length (the same value as returned by reading). Upon receiving notification client can proceed to read the data without reading `rx_ctl` again.
 
 
-## Lightning How To
-
-- Add `- origin: https://github.com/mongoose-os-libs/rpc-gatts` to your mos.yml libs
-- For this example we'll be doing a wifi.scan as that's very handy! Add `- origin: https://github.com/mongoose-os-libs/rpc-service-wifi` to your mos.yml libs as well.
-- Ensure your mos.yml config.schema has:
-```
-  - ["bt.enable", "b", true, {title: "Enable the BT service"}]
-  - ["bt.keep_enabled", "b", true, {title: "Keep the BT service enabled despite WIFI being up"}]
-  - ["bt.random_address", "b", false, {title: "Use a consistent BT MAC address"}]
-  - ["bt.dev_name", "MyDeviceName_??????"]
-```  
-- Rebuild/flash your app
-- Run a BLE scanner (ie Bluesee) to see your MyDeviceName_????? device. Connect to see the services. Look for the one with 5f52-5043 in the middle.
-- Select that service to open it. In Bluesee you'll have 3 characteristics per above docu. 
-- Figure out your RPC command, we'll use: `{"id":1999,"method":"Wifi.Scan"}`
-- We need to tell the service ahead of time how many hex bytes we'll be sending. We need to convert ascii to hex, trim the extra spaces and then count the bytes. Fun!
-- Enter your RPC command into this ascii to hex converter: https://www.rapidtables.com/convert/number/ascii-to-hex.html
-- It'll give you a space separated hex output: `7b 22 69 64 22 3a 31 39 39 39 2c 22 6d 65 74 68 6f 64 22 3a 22 57 69 66 69 2e 53 63 61 6e 22 7d`
-- Trim the spaces with http://www.unit-conversion.info/texttools/replace-text/
-- Count the new hex string with: https://mothereff.in/byte-counter
-- Halve the string count, as two hex characters equal one byte of data. With the text above, 64 / 2 = 32.
-- Convert 32 to the large 32 bit number the system is expecting. Note: It's little endian, not big endian. Use this converter: https://www.scadacore.com/tools/programming-calculators/online-hex-converter/ . Put the 32 in the input, then copy/paste the 'UINT32 - Little Endian (DCBA)' result and trim spaces:00000020 
-- Enter that `00000020` into the write only characteristic that has `5043-5F74` in the middle. Press write. In the console you'll see a log entry like: `mgos_rpc_channel_ga:296 0x3ffe1d24 expected_flen 32 res 0`
-- On the middle read only characteristic with `5043-5F72` in the middle, click subscribe. The number will change to let us know when data is available (and how long the hex string is)
-- On the read/write characteristic with `5043-5F53` in the middle, toggle the hex button so it says Ascii
-- Paste in our ascii command: `{"id":1999,"method":"Wifi.Scan"}`
-- You'll see the middle read only characteristic will have changed to let us know data is ready
-- Click 'read' on the top read/write characteristic we just entered the scan command into. It'll start pulling the data of the scan results! You can click it multiple times to scroll through the data till the end.
-- You can repeat the request by clicking the write only characteristic to send it our command length, then paste our command again, and click write.
  ----- 

sidebar.html

@@ -1,6 +1,4 @@
 <ul class="tree" style="">
-<div class="tree-toggler"><i class="fa fa-fw fa-caret-right"></i>&nbsp;<b>Mongoose OS</b>
-<ul class="tree" style="display:none;">
 <div class="tree-toggler"><i class="fa fa-fw fa-caret-right"></i>&nbsp;<b>Quick Start</b>
 <ul class="tree" style="display:none;">
 <li><a href="/docs/mongoose-os/quickstart/setup.md">Quick Start</a></li>
@@ -148,7 +146,7 @@
 <li><a href="/docs/mongoose-os/api/arduino/arduino-wire.md">Wire</a></li>
 </ul>
 </div>
-<div class="tree-toggler"><i class="fa fa-fw fa-caret-right"></i>&nbsp;<b>RPC remote management</b>
+<div class="tree-toggler"><i class="fa fa-fw fa-caret-right"></i>&nbsp;<b>RPC</b>
 <ul class="tree" style="display:none;">
 <li><a href="/docs/mongoose-os/api/rpc/rpc-common.md">RPC core</a></li>
 <li><a href="/docs/mongoose-os/api/rpc/rpc-loopback.md">RPC loopback</a></li>
@@ -190,21 +188,3 @@
 </ul>
 </div>
 </ul>
-</div>
-<div class="tree-toggler"><i class="fa fa-fw fa-caret-right"></i>&nbsp;<b>CCM communication module</b>
-<ul class="tree" style="display:none;">
-<li><a href="/docs/ccm/intro.md">User guide</a></li>
-<li><a href="/docs/ccm/licensing.md">Licensing</a></li>
-</ul>
-</div>
-<div class="tree-toggler"><i class="fa fa-fw fa-caret-right"></i>&nbsp;<b>Kiwi BLE gateway</b>
-<ul class="tree" style="display:none;">
-<li><a href="/docs/kiwi/intro.md">User guide</a></li>
-</ul>
-</div>
-<div class="tree-toggler"><i class="fa fa-fw fa-caret-right"></i>&nbsp;<b>UART gateway</b>
-<ul class="tree" style="display:none;">
-<li><a href="/docs/uart-gateway/intro.md">User guide</a></li>
-</ul>
-</div>
-</ul>

symbols.json

@@ -5567,6 +5567,12 @@
     "doc": "\n```c\nbool mgos_mqtt_global_connect(void);\n```\n> \n> Attempt MQTT connection now (if enabled and not already connected).\n> Normally MQTT will try to connect in the background, at certain interval.\n> This function will force immediate connection attempt.\n>  \n",
     "lang": "c"
   },
+  {
+    "name": "mgos_mqtt_global_disconnect",
+    "file": "[mgos_mqtt.h](https://github.com/mongoose-os-libs/mqtt/tree/master/include/mgos_mqtt.h)",
+    "doc": "\n```c\nvoid mgos_mqtt_global_disconnect(void);\n```\n> \n> Disconnect from and/or stop trying to connect to MQTT server\n> until mgos_mqtt_global_connect() is called.\n>  \n",
+    "lang": "c"
+  },
   {
     "name": "mgos_mqtt_global_is_connected",
     "file": "[mgos_mqtt.h](https://github.com/mongoose-os-libs/mqtt/tree/master/include/mgos_mqtt.h)",
@@ -5576,13 +5582,13 @@
   {
     "name": "mgos_mqtt_pub",
     "file": "[mgos_mqtt.h](https://github.com/mongoose-os-libs/mqtt/tree/master/include/mgos_mqtt.h)",
-    "doc": "\n```c\nbool mgos_mqtt_pub(const char *topic, const void *message, size_t len, int qos,\n                   bool retain);\n```\n> \n> Publish message to the configured MQTT server, to the given MQTT topic.\n> Return value will be true if there is a connection to the server and the\n> message has been queued for sending. In case of QoS 1 return value does\n> not indicate that PUBACK has been received; there is currently no way to\n> check for that.\n>  \n",
+    "doc": "\n```c\nuint16_t mgos_mqtt_pub(const char *topic, const void *message, size_t len,\n                       int qos, bool retain);\n```\n> \n> Publish message to the configured MQTT server, to the given MQTT topic.\n> Return value will be the packet id (> 0) if there is a connection to the\n> server and the message has been queued for sending. In case no connection is\n> available, 0 is returned. In case of QoS 1 return value does not indicate\n> that PUBACK has been received; there is currently no way to check for that.\n>  \n",
     "lang": "c"
   },
   {
     "name": "mgos_mqtt_pubf",
     "file": "[mgos_mqtt.h](https://github.com/mongoose-os-libs/mqtt/tree/master/include/mgos_mqtt.h)",
-    "doc": "\n```c\nbool mgos_mqtt_pubf(const char *topic, int qos, bool retain,\n                    const char *json_fmt, ...);\nbool mgos_mqtt_pubv(const char *topic, int qos, bool retain,\n                    const char *json_fmt, va_list ap);\n```\n>  Variant of mgos_mqtt_pub for publishing a JSON-formatted string \n",
+    "doc": "\n```c\nuint16_t mgos_mqtt_pubf(const char *topic, int qos, bool retain,\n                        const char *json_fmt, ...);\nuint16_t mgos_mqtt_pubv(const char *topic, int qos, bool retain,\n                        const char *json_fmt, va_list ap);\n```\n>  Variant of mgos_mqtt_pub for publishing a JSON-formatted string \n",
     "lang": "c"
   },
   {

tools/genapi.js

@@ -84,7 +84,7 @@ if (repoName == 'cesanta/mongoose-os') {
   const jsBase = jsmap[hBase];
   if (jsBase) {
     jsLink = `[${jsBase}](${mjsURL}/tree/master/fs/${jsBase})`;
-    jsFile = `/tmp/libs/mjs/fs/${jsBase}`;
+    jsFile = `mongoose-os-libs/mjs/fs/${jsBase}`;
   }
 } else if (repoName == 'cesanta/frozen') {
   const cBase = hBase.replace(/.h$/, '.c');

tools/gensidebar.js

@@ -8,7 +8,7 @@ const f = (dir, depth) => {
   md.split('\n').forEach((line) => {
     const m = line.match(/\[(.+)\]\((.+)\)/);
     if (!m) return;
-    const link = dir.replace(/^./, '/docs');
+    const link = '/docs/' + dir;  // dir.replace(/^./, '/docs');
     if (m[2].match(/.md$/)) {
       a.push(`<li><a href="${link}/${m[2]}">${m[1]}</a></li>`);
     } else {
@@ -22,4 +22,4 @@ const f = (dir, depth) => {
   a.push('</ul>');
   return a;
 };
-console.log(f('.', 0, '').join('\n'));
+console.log(f('mongoose-os', 0, '').join('\n'));