From 37d0b2b971344a904790dbe4118a81b044e2e410 Mon Sep 17 00:00:00 2001 From: Rob Bocchino Date: Wed, 4 Dec 2024 15:23:49 -0800 Subject: [PATCH] Revise User's Guide Update diagram links so they are correct for rendering on GitHub pages --- docs/fpp-spec.html | 2 +- docs/fpp-users-guide.html | 20 +++++++++---------- docs/users-guide/Defining-State-Machines.adoc | 18 ++++++++--------- .../diagrams/state-machine/README.adoc | 2 +- 4 files changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/fpp-spec.html b/docs/fpp-spec.html index ffb2b6dc0..3d8a4e179 100644 --- a/docs/fpp-spec.html +++ b/docs/fpp-spec.html @@ -10580,7 +10580,7 @@

22.4. Translation Tools

diff --git a/docs/fpp-users-guide.html b/docs/fpp-users-guide.html index 8791ea322..180e1b17c 100644 --- a/docs/fpp-users-guide.html +++ b/docs/fpp-users-guide.html @@ -3721,7 +3721,7 @@

9.2. States, Sig
-Device state machine +Device state machine
@@ -3922,7 +3922,7 @@

9.3.1. Actions i

-Device state machine with actions on transitions +Device state machine with actions on transitions
@@ -4047,7 +4047,7 @@

9.3.2. Entry and

-Device state machine with entry and exit actions +Device state machine with entry and exit actions
@@ -4249,7 +4249,7 @@

9

-Device state machine with a guarded transition +Device state machine with a guarded transition
@@ -4416,7 +4416,7 @@

9.4.

-Device state machine with a self transition +Device state machine with a self transition
@@ -4509,7 +4509,7 @@

-Device state machine with an internal transition +Device state machine with an internal transition
@@ -4633,7 +4633,7 @@

9.5. Choices

-Device state machine with a choice +Device state machine with a choice
@@ -4956,7 +4956,7 @@

9.6.1. Substates

-Device state machine with substates +Device state machine with substates
@@ -5183,7 +5183,7 @@

9.6.2. Inherite

-Device state machine with inherited transitions +Device state machine with inherited transitions
@@ -14754,7 +14754,7 @@

-Last updated 2024-11-19 21:51:12 -0800 +Last updated 2024-12-04 15:23:03 -0800

diff --git a/docs/users-guide/Defining-State-Machines.adoc b/docs/users-guide/Defining-State-Machines.adoc index df6487da6..517987e7e 100644 --- a/docs/users-guide/Defining-State-Machines.adoc +++ b/docs/users-guide/Defining-State-Machines.adoc @@ -157,7 +157,7 @@ state machine Device { Here is the example represented graphically, as a UML state machine: -image::diagrams/state-machine/Basic.png[Device state machine,200,align="center"] +image::users-guide/diagrams/state-machine/Basic.png[Device state machine,200,align="center"] This example defines a state machine `Device` that represents a device with on-off behavior. @@ -330,7 +330,7 @@ state machine Device { Here is the graphical representation: -image::diagrams/state-machine/ActionsInTransitions.png[Device state machine with actions on transitions,500,align="center"] +image::users-guide/diagrams/state-machine/ActionsInTransitions.png[Device state machine with actions on transitions,500,align="center"] In this example there are four actions: `initialAction1`, `initialAction2`, `offOnAction`, and `onOffAction`. @@ -441,7 +441,7 @@ state machine Device { Here is the graphical representation: -image::diagrams/state-machine/EntryAndExitActions.png[Device state machine with entry and exit actions,500,align="center"] +image::users-guide/diagrams/state-machine/EntryAndExitActions.png[Device state machine with entry and exit actions,500,align="center"] As with actions on transitions, each entry or exit specifier names a list of actions, and the actions are done in the order named. @@ -615,7 +615,7 @@ state machine Device { Here is the graphical representation: -image::diagrams/state-machine/GuardedTransitions.png[Device state machine with a guarded transition,400,align="center"] +image::users-guide/diagrams/state-machine/GuardedTransitions.png[Device state machine with a guarded transition,400,align="center"] In this example, there is one guard, `powerOnIsSafe`. The implementation of this function will return true @@ -764,7 +764,7 @@ state machine Device { Here is the graphical representation: -image::diagrams/state-machine/SelfTransitions.png[Device state machine with a self transition,400,align="center"] +image::users-guide/diagrams/state-machine/SelfTransitions.png[Device state machine with a self transition,400,align="center"] In this example, when the state machine is in the `ON` state and it receives a `cmdReset` signal, the following behavior occurs: @@ -843,7 +843,7 @@ state machine Device { Here is the graphical representation: -image::diagrams/state-machine/InternalTransitions.png[Device state machine with an internal transition,200,align="center"] +image::users-guide/diagrams/state-machine/InternalTransitions.png[Device state machine with an internal transition,200,align="center"] In this example, when the state machine is in state `ON` and it receives a `cmdReset` signal, it does the `reset` action and @@ -946,7 +946,7 @@ state machine Device { Here is the graphical representation: -image::diagrams/state-machine/Choices.png[Device state machine with a choice,450,align="center"] +image::users-guide/diagrams/state-machine/Choices.png[Device state machine with a choice,450,align="center"] This version of the `Device` state machine has three states: `ON`, `OFF`, and `ERROR`. @@ -1207,7 +1207,7 @@ state machine Device { Here is the graphical representation: -image::diagrams/state-machine/Substates.png[Device state machine with substates,500,align="center"] +image::users-guide/diagrams/state-machine/Substates.png[Device state machine with substates,500,align="center"] This state machine has four states: `ON`, `OFF`, `OFF.SAFE`, and `OFF.UNSAFE`. The last two states are substates of `OFF`. @@ -1386,7 +1386,7 @@ state machine Device { Here is the graphical representation: -image::diagrams/state-machine/InheritedTransitions.png[Device state machine with inherited transitions,600,align="center"] +image::users-guide/diagrams/state-machine/InheritedTransitions.png[Device state machine with inherited transitions,600,align="center"] Here we have rewritten the <