updated ONU state transition doc
Change-Id: Ie4fa6ba1be492f3ffc9e74edbc472ddd12a16645
diff --git a/VERSION b/VERSION
index 2cfabea..2f80b8d 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-0.0.11
+0.0.12-dev
diff --git a/docs/source/onu-state-machine.rst b/docs/source/onu-state-machine.rst
index 2815a64..d55779c 100644
--- a/docs/source/onu-state-machine.rst
+++ b/docs/source/onu-state-machine.rst
@@ -84,6 +84,14 @@
- dhcp_started, dhcp_discovery_sent, dhcp_request_sent
- dhcp_failed
-
+ * - disable
+ - enabled, eap_response_success_received, auth_failed, dhcp_ack_received, dhcp_failed
+ - disabled
+ -
+ * - pon_disabled
+ - enabled, gem_port_added, eapol_flow_received, eap_response_success_received, auth_failed, dhcp_ack_received, dhcp_failed
+ - pon_disabled
+ -
In addition some transition can be forced via the API,
check the previous table to verify when you can trigger those actions and
@@ -100,14 +108,37 @@
- disable
- Emulates a device shutdown. Sends a ``DyingGaspInd`` and then an ``OnuIndication{OperState: 'down'}``
* - poweron
- - enable
- - Emulates a device power on. Sends a ``OnuDiscInd`` and then an ``OnuIndication{OperState: 'up'}``
+ - discover
+ - Emulates a device power on. Sends a ``OnuDiscInd``
* - auth_restart
- start_auth
- Forces the ONU to send a new ``EapStart`` packet.
* - dhcp_restart
- start_dhcp
- Forces the ONU to send a new ``DHCPDiscovery`` packet.
+ * - softReboot
+ - disable
+ - Emulates a device soft reboot. Sends ``LosIndication{status: 'on'}`` and then after reboot delay ``LosIndication{status: 'off'}``
+ * - hardReboot
+ - disable
+ - Emulates a device hard reboot. Sends a ``DyingGaspInd`` and ``OnuIndication{OperState: 'down'}`` and raise necessary alarmIndications and after reboot delay sends ``OnuDiscInd`` and clear alarm indications.
+ * - onuAlarms
+ - TBD
+ -
+
+.. list-table::
+ :widths: 15 15 70
+ :header-rows: 1
+
+ * - OpenOlt request
+ - Transitions To
+ - Notes
+ * - ActivateOnu
+ - enable
+ - VOLTHA assigns ID to ONU and then BBSim sends a ``OnuIndication{OperState: 'up'}``
+ * - DeleteOnu
+ - initialized
+ - Reset ONU-ID to zero and move ONU to initialized state so that its ready to poweron again when required
Below is a diagram of the state machine: