api

minima-global · Dec 30, 2020 · d8469c4 · d8469c4
1 parent c44b0f7
commit d8469c4
Show file tree

Hide file tree

Showing 36 changed files with 244 additions and 12 deletions.
diff --git a/docs/api/cmd.rst b/docs/api/cmd.rst
@@ -0,0 +1,5 @@
+###
+cmd
+###
+
+.. _apiCmd:
diff --git a/docs/api/file/copy.rst b/docs/api/file/copy.rst
@@ -0,0 +1,5 @@
+#########
+file.copy
+#########
+
+.. _apiFileCopy:
diff --git a/docs/api/file/delete.rst b/docs/api/file/delete.rst
@@ -0,0 +1,5 @@
+###########
+file.delete
+###########
+
+.. _apiFileDelete:
diff --git a/docs/api/file/list.rst b/docs/api/file/list.rst
@@ -0,0 +1,5 @@
+#########
+file.list
+#########
+
+.. _apiFileList:
diff --git a/docs/api/file/load.rst b/docs/api/file/load.rst
@@ -0,0 +1,5 @@
+#########
+file.load
+#########
+
+.. _apiFileLoad:
diff --git a/docs/api/file/loadHEX.rst b/docs/api/file/loadHEX.rst
@@ -0,0 +1,5 @@
+############
+file.loadHex
+############
+
+.. _apiFileLoadHex:
diff --git a/docs/api/file/move.rst b/docs/api/file/move.rst
@@ -0,0 +1,5 @@
+###########
+file.move
+###########
+
+.. _apiFileMove:
diff --git a/docs/api/file/save.rst b/docs/api/file/save.rst
@@ -0,0 +1,5 @@
+#########
+file.save
+#########
+
+.. _apiFileSave:
diff --git a/docs/api/file/saveHEX.rst b/docs/api/file/saveHEX.rst
@@ -0,0 +1,5 @@
+############
+file.saveHex
+############
+
+.. _apiFileSaveHex:
diff --git a/docs/api/form/getParams.rst b/docs/api/form/getParams.rst
@@ -0,0 +1,5 @@
+##############
+form.getParams
+##############
+
+.. _apiFormGetParams:
diff --git a/docs/api/form/params.rst b/docs/api/form/params.rst
@@ -0,0 +1,5 @@
+###########
+form.params
+###########
+
+.. _apiFormParams:
diff --git a/docs/api/init.rst b/docs/api/init.rst
@@ -1,7 +1,19 @@
 ####
-Init
+init
 ####
 
 .. _apiInit:
 
-`Minima.init` allows you to specify a callback that enables you to monitor Minima events.
+`Minima.init` must be called **FIRST**. It can be called alone, i.e. `Minima.init()`, or with a callback function that can be used to monitor (and act upon) all Minima events, e.g:
+
+::
+
+  Minima.init( function( msg ) {
+
+    console.log("Minima event", msg)
+
+    if ( msg.event == "connected" ) {
+
+      console.log("connected");
+    }
+  });
diff --git a/docs/api/log.rst b/docs/api/log.rst
@@ -0,0 +1,5 @@
+###
+log
+###
+
+.. _apiLog:
diff --git a/docs/api/minidapps/list.rst b/docs/api/minidapps/list.rst
@@ -0,0 +1,5 @@
+##############
+minidapps.list
+##############
+
+.. _apiMiniDappsList:
diff --git a/docs/api/minidapps/listen.rst b/docs/api/minidapps/listen.rst
@@ -0,0 +1,5 @@
+################
+minidapps.listen
+################
+
+.. _apiMiniDappsListen:
diff --git a/docs/api/minidapps/reply.rst b/docs/api/minidapps/reply.rst
@@ -0,0 +1,5 @@
+###############
+minidapps.reply
+###############
+
+.. _apiMiniDappsReply:
diff --git a/docs/api/minidapps/send.rst b/docs/api/minidapps/send.rst
@@ -0,0 +1,5 @@
+##############
+minidapps.send
+##############
+
+.. _apiMiniDappsSend:
diff --git a/docs/api/net/GET.rst b/docs/api/net/GET.rst
@@ -0,0 +1,5 @@
+#######
+net.GET
+#######
+
+.. _apiNetGet:
diff --git a/docs/api/net/POST.rst b/docs/api/net/POST.rst
@@ -0,0 +1,5 @@
+########
+net.POST
+########
+
+.. _apiNetPOST:
diff --git a/docs/api/net/broadcast.rst b/docs/api/net/broadcast.rst
@@ -0,0 +1,5 @@
+#############
+net.broadcast
+#############
+
+.. _apiNetBroadcast:
diff --git a/docs/api/net/connect.rst b/docs/api/net/connect.rst
@@ -0,0 +1,5 @@
+###########
+net.connect
+###########
+
+.. _apiNetConnect:
diff --git a/docs/api/net/disconnect.rst b/docs/api/net/disconnect.rst
@@ -0,0 +1,5 @@
+##############
+net.disconnect
+##############
+
+.. _apiNetDisconnect:
diff --git a/docs/api/net/info.rst b/docs/api/net/info.rst
@@ -0,0 +1,5 @@
+########
+net.info
+########
+
+.. _apiNetInfo:
diff --git a/docs/api/net/onInbound.rst b/docs/api/net/onInbound.rst
@@ -0,0 +1,5 @@
+#############
+net.onInbound
+#############
+
+.. _apiNetOnInbound:
diff --git a/docs/api/net/onOutbound.rst b/docs/api/net/onOutbound.rst
@@ -0,0 +1,5 @@
+##############
+net.onOutbound
+##############
+
+.. _apiNetOnOutbound:
diff --git a/docs/api/net/send.rst b/docs/api/net/send.rst
@@ -0,0 +1,5 @@
+########
+net.send
+########
+
+.. _apiNetSend:
diff --git a/docs/api/net/start.rst b/docs/api/net/start.rst
@@ -0,0 +1,5 @@
+#########
+net.start
+#########
+
+.. _apiNetStart:
diff --git a/docs/api/net/stats.rst b/docs/api/net/stats.rst
@@ -0,0 +1,5 @@
+#########
+net.stats
+#########
+
+.. _apiNetStats:
diff --git a/docs/api/net/stop.rst b/docs/api/net/stop.rst
@@ -0,0 +1,5 @@
+########
+net.stop
+########
+
+.. _apiNetStop:
diff --git a/docs/api/notify.rst b/docs/api/notify.rst
@@ -0,0 +1,5 @@
+######
+notify
+######
+
+.. _apiNotify:
diff --git a/docs/api/sql.rst b/docs/api/sql.rst
@@ -0,0 +1,5 @@
+###
+sql
+###
+
+.. _apiSql:
diff --git a/docs/api/util/checkAllResponses.rst b/docs/api/util/checkAllResponses.rst
@@ -0,0 +1,5 @@
+######################
+util.checkAllResponses
+######################
+
+.. _apiUtilCheckAllResponses:
diff --git a/docs/api/util/getBalance.rst b/docs/api/util/getBalance.rst
@@ -0,0 +1,5 @@
+###############
+util.getBalance
+###############
+
+.. _apiUtilGetBalance:
diff --git a/docs/api/util/getStateVariable.rst b/docs/api/util/getStateVariable.rst
@@ -0,0 +1,5 @@
+#####################
+util.getStateVariable
+#####################
+
+.. _apiUtilGetStateVariable:
diff --git a/docs/gettingStarted/initialise.rst b/docs/gettingStarted/initialise.rst
@@ -9,15 +9,12 @@ Example
 
 ::
 
-    Minima.init( function( msg ) {
+  Minima.init( function( msg ) {
 
-      console.log("minima event", msg)
+    console.log("Minima event", msg)
 
-      if ( msg.event == "connected" ) {
+    if ( msg.event == "connected" ) {
 
-        console.log("connected");
-
-      }
-    });
-
-`Minima.init` allows you to specify a callback that enables you to monitor Minima events.
+      console.log("connected");
+    }
+  });
diff --git a/docs/index.rst b/docs/index.rst
@@ -24,6 +24,64 @@ Contents
 
 .. toctree::
    :maxdepth: 2
-   :caption: API:
+   :caption: Top-level API:
 
    api/init.rst
+   api/notify.rst
+   api/log.rst
+   api/cmd.rst
+   api/sql.rst
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Utility API:
+
+   api/util/getBalance.rst
+   api/util/getStateVariable.rst
+   api/util/checkAllResponses.rst
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Form API:
+
+   api/form/getParams.rst
+   api/form/params.rst
+
+.. toctree::
+   :maxdepth: 2
+   :caption: File API:
+
+   api/file/saveHEX.rst
+   api/file/move.rst
+   api/file/copy.rst
+   api/file/save.rst
+   api/file/delete.rst
+   api/file/list.rst
+   api/file/loadHEX.rst
+   api/file/load.rst
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Net API:
+
+   api/net/POST.rst
+   api/net/start.rst
+   api/net/disconnect.rst
+   api/net/onOutbound.rst
+   api/net/GET.rst
+   api/net/connect.rst
+   api/net/onInbound.rst
+   api/net/stats.rst
+   api/net/broadcast.rst
+   api/net/stop.rst
+   api/net/send.rst
+   api/net/info.rst
+
+.. toctree::
+   :maxdepth: 2
+   :caption: MiniDapps API:
+
+   api/minidapps/listen.rst
+   api/minidapps/list.rst
+   api/minidapps/send.rst
+   api/minidapps/reply.rst