[options] Options: --compiler, -c Compiler ID (Mandatory unless --tool (-t) is used) --create-dir, -d Create a new directory named after the configuration for the output Default: false --help, -h Display this message. Default: false --list-plugins Display the list of available plugins Default: false --options additional options for ThingML tools. --output, -o Optional output directory - by default current directory is used --source, -s A thingml file to compile (should include at least one configuration) --tool, -t Tool ID (Mandatory unless --compiler (-c) is used) Compiler Id must belong to the following list: ?? sintefboard - Generates C++ based in code for Arduino. ?? posixmt - Generates C code for Linux or other Posix runtime environments (GCC compiler). ?? java - Generates plain Java code. ?? arduino - Generates C/C++ code for Arduino or other AVR microcontrollers (AVR-GCC compiler). ?? UML - Generates UML diagrams in PlantUML ?? browser - Generates Javascript code that can run in common Web Browsers. ?? nodejsMT - Generates Multi-Process Javascript code (one nodejs process per instance) for the NodeJS platform. ?? nodejs - Generates Javascript code for the NodeJS platform. ?? posix - Generates C/C++ code for Linux or other Posix runtime environments (GCC compiler). ?? debugGUI - Generates html/js mock-up for other a ThingML external connector Tool Id must belong to the following list: ?? testconfigurationgen - Generates test configuration for things annnotated with @test "input # output". ``` ## 🔷 FAQ ### 🔹 Where can ThingML code run? *Nowhere*! Or almost *everywhere*, from microcontrollers to the cloud! A ThingML file *per se* is a design-time specification of the structure (components) and behavior (state machines) of a reactive system. It cannot be directly executed. A ThingML file can however be compiled (or transformed) to Java/JavaScript/C/Arduino source code, which can in turn be compiled and executed on a platform. Code generated from ThingML has been successfully executed on a large number of platforms: PC Windows/Linux, Raspberry Pi 1, 2 and 3, Intel Edison, Arduino Uno/Mega/Yun/Mini, ESP8266/ESP32, Trinket, Teensy, and probably others. ### 🔹 How to express *this* or *that* in ThingML? A set of tutorials is available [here](https://github.com/HEADS-project/training/tree/master/1.ThingML_Basics). The tutorials describe the most common features of ThingML. In addition, [an extensive set of tests](testing/src/test/resources/tests/General) describes pretty much all the concepts available. Have a look there is you wonder how to express something. Should this information be insufficient, have a look below. ### 🔹 How is ThingML formalized? The ThingML language is formalized into an EMF-based metamodel. The textual syntax is formalized as an [XText grammar](language/thingml/src/org/thingml/xtext/ThingML.xtext). ### 🔹 All that code is wonderful, but I need some Science... 📚 ThingML is backed by a set of scientific publications (PDFs can easily be found on *e.g.* Google Scholar): - **Model-Based Software Engineering to Tame the IoT Jungle** Brice Morin, Nicolas Harrand and Franck Fleurey In *IEEE Software, Special Issue on Internet of Things*, 2017. - **ThingML, A Language and Code Generation Framework for Heterogeneous Targets** N. Harrand, F. Fleurey, B. Morin and K.E. Husa In *MODELS’16: ACM/IEEE 19th International Conference on Model Driven Engineering Languages and Systems. Practice and Innovation track*. St Malo, France, October 2-7, 2016 - **MDE to Manage Communications with and between Resource-Constrained Systems** F. Fleurey, B. Morin, A. Solberg and O. Barais. In *MODELS’11: ACM/IEEE 14th International Conference on Model Driven Engineering Languages and Systems*. Wellington, New Zealand, October 2011. ThingML has also been used together with other approaches: - **Agile Development of Home Automation System with ThingML** A. Vasilevskiy, B. Morin, Ø. Haugen and P. Evensen. In *INDIN’16: 14th IEEE International Conference on Industrial Informatics*. Poitiers, France, July 18-21, 2016 - **A Generative Middleware for Heterogeneous and Distributed Services** B. Morin, F. Fleurey, K.E. Husa, and O. Barais. In *CBSE’16: 19th International ACM Sigsoft Symposium on Component-Based Software Engineering*. Venice, Italy, April 5-8, 2016 ### 🔹 How to embed ThingML in my toolchain? > This currently does not work. Pending a solution to Issue #241 Embed the command-line inteface JAR [described previously in this readme](#-compile-thingml-from-the-sources) in your classpath. You can also include ThingML as a Maven dependency in your project: ```xml org.thingml compilers.registry 2.0.0-SNAPSHOT ... thingml-snapshot thingml-snapshot http://maven.thingml.org/thingml-snapshot/ thingml-release thingml-release http://maven.thingml.org/thingml-release/ ``` ### 🔹 The code generated by ThingML for Java/JS/C/Arduino does not exactly fit my needs Rather than being monolithic blobs, compilers are implemented in a modular way around a set of extension points defined in the [ThingML Code Generation Framework](compilers/README.md). ### 🔹 Why can't I generate Python/Lua/Ruby/*you-name-it*? Well, it is up to you to implement a compiler for whatever language that is not supported by default. What are you waiting for? ### 🔹 How can I programatically process ThingML models? ```java File myFile = new File("source.thingml"); ThingMLModel myModel = ThingMLCompiler.loadModel(myFile); //Do something ThingMLCompiler.saveAsThingML(myModel, "target.thingml"); //or ThingMLCompiler.saveAsXMI(myModel, "target.xmi"); ``` >Protip1: Make sure you have a good understanding of the [ThingML metamodel](#-how-is-thingml-formalized) >Protip2: Have a look at the [helper functions](language/thingml/src/org/thingml/xtext/helpers) which simplify some typical treatments > Models saved this way will contain all the imports that the original file refered to in one big file > This feature might currently be broken as we migrated to XText. ## 🔷 More