Graphviz.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# State Machine Diagrams from STMPY via Graphviz\n",
    "\n",
    "STMPY can automatically generate state machine diagrams, using the Graphviz program. To make it work, do the following:\n",
    "\n",
    "1. Install Graphviz from https://www.graphviz.org\n",
    "2. Install the Python support library via `pip install graphviz`\n",
    "\n",
    "The cell below builds a state machine in STMPY, then gets the Graphviz source code for a graph (in the `dot` format) and then prints it in the notebook.\n",
    "\n",
    "Note that the visualization currently does not support compound transitions, where the decision is defined within a Python method."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "from graphviz import Source\n",
    "\n",
    "from stmpy import Machine\n",
    "import stmpy\n",
    "\n",
    "t0 = {'source': 'initial',\n",
    "      'target': 'off'}\n",
    "\n",
    "t1 = {'trigger': 'switch',\n",
    "       'source': 'off',\n",
    "       'target': 's15',\n",
    "       'effect': 'switch_led(\"15\", True); start_timer'}\n",
    "\n",
    "t2 = {'trigger': 'switch',\n",
    "       'source': 's15',\n",
    "       'target': 's30',\n",
    "       'effect': 'switch_led(\"30\", True); start_timer'}\n",
    "\n",
    "t3 = {'trigger': 'switch',\n",
    "       'source': 's30',\n",
    "       'target': 's45',\n",
    "       'effect': 'switch_led(\"45\", True); start_timer'}\n",
    "\n",
    "t4 = {'trigger': 'switch',\n",
    "       'source': 's45',\n",
    "       'target': 's60',\n",
    "       'effect': 'switch_led(\"60\", True); start_timer'}\n",
    "\n",
    "t5 = {'trigger': 'switch',\n",
    "       'source': 's60',\n",
    "       'target': 'off',\n",
    "       'effect': 'switch_led(\"15\", False); switch_led(\"30\", False); switch_led(\"45\", False); switch_led(\"60\", False); stop_timer'}\n",
    "\n",
    "t6 = {'trigger': 't',\n",
    "       'source': 's60',\n",
    "       'target': 's45',\n",
    "       'effect': 'switch_led(\"60\", False); start_timer'}\n",
    "\n",
    "t7 = {'trigger': 't',\n",
    "       'source': 's45',\n",
    "       'target': 's30',\n",
    "       'effect': 'switch_led(\"45\", False); start_timer'}\n",
    "\n",
    "t8 = {'trigger': 't',\n",
    "       'source': 's30',\n",
    "       'target': 's15',\n",
    "       'effect': 'switch_led(\"30\", False); start_timer'}\n",
    "\n",
    "t9 = {'trigger': 't',\n",
    "       'source': 's15',\n",
    "       'target': 'off',\n",
    "       'effect': 'switch_led(\"15\", False)'}\n",
    "\n",
    "off = {'name': 'off',\n",
    "      'entry': 'switch_plug(False)',\n",
    "       'exit': 'switch_plug(True)'}\n",
    "\n",
    "stm_kitchen = Machine(name='stm_kitchen', transitions=[t0, t1, t2, t3, t4, t5, t6, t7, t8, t9], obj=None, states=[off])\n",
    "\n",
    "dot = stmpy.get_graphviz_dot(stm_kitchen)\n",
    "src = Source(dot)\n",
    "src"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "You can also export the graph to a file. Use then Graphiz' command line tools to generate a picture from it."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "with open(\"graph.gv\", \"w\") as file:\n",
    "    print(stmpy.get_graphviz_dot(stm_kitchen), file=file)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Compound Transitions\n",
    "\n",
    "To visualize compound transitions, just add the extra key 'targets' (notice the plural 's') to the declaration of the compound transition. This is a space-separated list of states that this transitions can potentially target, so that we can draw the graph."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "def function():\n",
    "    pass\n",
    "\n",
    "t0 = {'source': 'initial',\n",
    "      'function': function,\n",
    "      'targets': 'off s15'}\n",
    "\n",
    "t1 = {'trigger': 'switch',\n",
    "       'source': 'off',\n",
    "       'target': 's15',\n",
    "       'effect': 'switch_led(\"15\", True); start_timer'}\n",
    "\n",
    "t2 = {'trigger': 'switch',\n",
    "       'source': 's15',\n",
    "       'target': 's30',\n",
    "       'effect': 'switch_led(\"30\", True); start_timer'}\n",
    "\n",
    "t3 = {'trigger': 'switch',\n",
    "       'source': 's30',\n",
    "       'target': 's45',\n",
    "       'effect': 'switch_led(\"45\", True); start_timer'}\n",
    "\n",
    "t4 = {'trigger': 'switch',\n",
    "       'source': 's45',\n",
    "       'target': 's60',\n",
    "       'effect': 'switch_led(\"60\", True); start_timer'}\n",
    "\n",
    "t5 = {'trigger': 'switch',\n",
    "       'source': 's60',\n",
    "       'target': 'off',\n",
    "       'effect': 'switch_led(\"15\", False); switch_led(\"30\", False); switch_led(\"45\", False); switch_led(\"60\", False); stop_timer'}\n",
    "\n",
    "t6 = {'trigger': 't',\n",
    "       'source': 's60',\n",
    "       'target': 's45',\n",
    "       'effect': 'switch_led(\"60\", False); start_timer'}\n",
    "\n",
    "t7 = {'trigger': 't',\n",
    "       'source': 's45',\n",
    "       'target': 's30',\n",
    "       'effect': 'switch_led(\"45\", False); start_timer'}\n",
    "\n",
    "t8 = {'trigger': 't',\n",
    "       'source': 's30',\n",
    "       'target': 's15',\n",
    "       'effect': 'switch_led(\"30\", False); start_timer'}\n",
    "\n",
    "t9 = {'trigger': 't',\n",
    "       'source': 's15',\n",
    "       'target': 'off',\n",
    "       'effect': 'switch_led(\"15\", False)'}\n",
    "\n",
    "t10 = {'trigger': 't',\n",
    "       'source': 's15',\n",
    "       'targets': 's30 s45',\n",
    "       'function': function}\n",
    "\n",
    "off = {'name': 'off',\n",
    "      'entry': 'switch_plug(False)',\n",
    "       'exit': 'switch_plug(True)'}\n",
    "\n",
    "stm_kitchen = Machine(name='stm_kitchen', transitions=[t0, t1, t2, t3, t4, t5, t6, t7, t8, t9, t10], obj=None, states=[off])\n",
    "\n",
    "dot = stmpy.get_graphviz_dot(stm_kitchen)\n",
    "src = Source(dot)\n",
    "src"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.6.3"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}