Scxml converter

README.md

@@ -34,8 +34,15 @@ Normally a state machine is predefined by users. But advanced machine intelligen
 * By using NSM and DAR the transition logic of a state machine is totally decoupled from user action logic of an application; and by decoupling the transition logic from the user action logic, the framework improves the flexibility and reusability of a state machine.
 * With the State Machine Runtime Dynamic feature, the framework constructs a fundamental basis for the advanced machine learning and machine intelligence.
 
-# Build
+# Main Features
+## Dynamic State Machine
+Support create/change state machine at runtime.
+## Dynamic Sub State Machine
+Support attach sub state machine at runtime.
+## Parallel State Machine 
+To be supported in future.
 
+# Build
 * Go to project root directory
 * Run ./build.sh
 * After build is successfully done:
@@ -55,5 +62,26 @@ Normally a state machine is predefined by users. But advanced machine intelligen
 * Run ./build-ut.sh
 * After build is successfully done, the ut applicatioin will be generated at ./ut_build/bin/imachine_ut, and can run it to check the UT result.
 
-
-
+# SCXML Converter
+By using the scxml-to-cpp converter, the standard SCXML state machine representation can be converted to C++ classes, which can  then fit into the IMachine framework.
+##### Tags supported according to the SCXML standard:
+###### Core Constructs:
+- <scxml>
+- <state>
+- <transiton> (targetless transition not supported)
+- <event>
+- <initial>
+- <final> (Only one final not supported)
+
+#####  Tags **NOT** supported according to the SCXML standard:
+###### Core Constructs:
+- <parallel> (to be supported in future)
+- <history> (to be supported in future)
+- <onentry> (intentionally not to be supported based on design)
+- <onexit> (intentionally not to be supported based on design)
+
+###### Executable Content (intentionally not to be supported based on design)
+###### Data Model and Data Manipulation (intentionally not to be supported based on design)
+###### External Communications (Not considered for now)
+#### How to use
+python <repo_root>/tools/scxml_converter/scxml2cpp.py -h

tools/scxml_converter/car.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<scxml xmlns="http://www.w3.org/2005/07/scxml" version="1.0">
+    <state id="stopped">
+        <transition event="start" target="running"/>
+    </state>
+    <state id="running">
+        <state id="lowSpeed">
+            <transition event="speedUp" target="highSpeed"/>
+        </state>
+        <state id="highSpeed">
+            <transition event="speedLow" target="lowSpeed"/>
+            <transition event="error" target="final_2"/>
+        </state>
+        <transition event="stop" target="stopped"/>
+        <transition event="error" target="final_1"/>
+        <final id="final_2"></final>
+    </state>
+    <final id="final_1"></final>
+</scxml>