From 80d3367238059623de0f0106956caf184ba6f616 Mon Sep 17 00:00:00 2001
From: Romain Bazile <gromain.baz@gmail.com>
Date: Thu, 20 May 2021 00:33:34 +0200
Subject: [PATCH] doc: update segmenter message

(cherry picked from commit fd6aa3ce727a5de7e70a06898c57c20941c7e6fb)
---
 docs/mqtt_messages.md | 23 +++++++++++++++++++++--
 1 file changed, 21 insertions(+), 2 deletions(-)

diff --git a/docs/mqtt_messages.md b/docs/mqtt_messages.md
index 9b51c06..bb46b64 100644
--- a/docs/mqtt_messages.md
+++ b/docs/mqtt_messages.md
@@ -99,11 +99,23 @@ A camera settings message can also be received here. The fields `iso` and `shutt
 This topic controls the segmentation process. The message is a JSON object:
 ```json
 {
-  "action": "segment"
+  "action": "segment",
+  "path": "/path/to/segment",
+  "settings": {
+    "force": False,
+    "recursive": True,
+    "ecotaxa": True,
+    "keep": True
+  }
 }
 ```
 
 `action` can also be `stop`.
+The `action` element is the only element required. If no `path` is supplied, the whole images repository is segmented recursively (this is very long!).
+`force` is going to overcome the presence of the file `done` that is here to prevent for resegmenting a folder already segmented.
+`recursive` will force parsing all folders below `path`.
+`ecotaxa` activates the export of an ecotaxa compatible archive.
+`keep` allows to remove or keep the roi (when you do an ecotaxa export, no effects otherwise, the roi are kept).
 
 - Receive only
 
@@ -172,4 +184,11 @@ Status of the segmentation. It's a JSON object with:
 }
 ```
 
-#### `status/segmenter/metric`
\ No newline at end of file
+#### `status/segmenter/metric`
+```json
+{
+  "name": "01_13_28_232066_0",
+  "metadata": {
+      "label": 0, "width": 29, "height": 80, ....
+}
+```
\ No newline at end of file