From 1e45d42e40e1ac2b724a4644966c14f74dc90d1a Mon Sep 17 00:00:00 2001
From: dgmccart <92180364+dgmccart@users.noreply.github.com>
Date: Tue, 14 Nov 2023 06:44:35 -0800
Subject: [PATCH] Tutorial on using JSON with Trigger objects (#9)

---
 docs/trig_json.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 62 insertions(+)
 create mode 100644 docs/trig_json.md

diff --git a/docs/trig_json.md b/docs/trig_json.md
new file mode 100644
index 00000000..554b2f09
--- /dev/null
+++ b/docs/trig_json.md
@@ -0,0 +1,62 @@
+# Saving and Loading Trigger Settings from a JSON file
+
+This tutorial will provide an example of saving and subsequently loading a `Trigger` object from a JSON file.
+
+## Initialize Runtime
+
+To start, we'll import `Acquire` and create a `Runtime` object, which coordinates the streaming process.
+
+```python
+import acquire
+runtime = acquire.Runtime()
+```
+
+## Create a Trigger Object
+
+`Trigger` objects have 4 attributes: edge, enable, line, and kind. In this example, will only adjust the edge attribute.
+
+```python
+# Instantiate a Trigger object
+trig = acquire.Trigger()
+
+# change the edge attribute from the default Rising to Falling
+trig.edge = acquire.TriggerEdge.Falling
+```
+
+## Save Properties to a JSON file
+We'll utilize the [json library](https://docs.python.org/3/library/json.html#) to write our `Trigger` to a JSON file to save for subsequent acquisition.
+
+```python
+import json
+
+# cast the properties to a dictionary
+trig = trig.dict()
+
+# convert the dictionary to json with "human-readable" formatting
+trig = json.dumps(trig, indent=4, sort_keys=True)
+
+# save the trigger to file "sample_trig.json" in the current directory
+with open("sample_trig.json", "w") as outfile:
+    outfile.write(trig)
+```
+
+## Example JSON file
+The resulting sample_trig.json file is below:
+
+```json
+{
+    "edge": "Falling",
+    "enable": false,
+    "kind": "Input",
+    "line": 0
+}
+```
+
+## Load Properties from a JSON file
+You can load the trigger attributes in the JSON file to a `Trigger` object as shown below:
+
+```python
+# Instantiate a `Trigger` object from the settings in sample_trig.json
+trig = acquire.Trigger(**json.load(open('sample_trig.json')))
+```
+