]> gitweb.ps.run Git - matrix_esp_thesis/commitdiff
update Readme
authorPatrick <patrick.schoenberger@posteo.de>
Tue, 14 Nov 2023 12:15:55 +0000 (13:15 +0100)
committerPatrick <patrick.schoenberger@posteo.de>
Tue, 14 Nov 2023 12:15:55 +0000 (13:15 +0100)
Readme.md

index 9475a9f20824f678c78f4fcbad87af7f0dc2e2c4..9e90f9a272711d93dab35fa880384468db1b15cd 100644 (file)
--- a/Readme.md
+++ b/Readme.md
@@ -27,6 +27,24 @@ To build the example for the ESP32 start an ESP-IDF shell in esp32/esp_project o
 - `idf.py flash`\r
 - `idf.py monitor`\r
 \r
+Examples for the ESP32 are in `esp32/esp_project/main`.\r
+There are currently two, SendEncrypted and Verify.\r
+The example can be set in `esp32/esp_project(_risc_v)/main/CMakeLists.txt` as the second argument after SRCS.\r
+\r
+Any code using the library should compile under ESP-IDF if the following code is added at the end of the file:\r
+```\r
+#include "wifi.h"\r
+\r
+void\r
+app_main(void)\r
+{\r
+    wifi_init(WIFI_SSID, WIFI_PASSWORD);\r
+\r
+    main();\r
+}\r
+\r
+```\r
+\r
 To use the library in an ESP-IDF project:\r
 - Add the matrix and olm components (can be found in `esp32/esp_project/components/`)\r
 - Add `wifi.c/.h` (can be found in `esp32/esp_project/main/`)\r
@@ -51,9 +69,9 @@ MatrixHttpInit(&client->hc, SERVER);
 MatrixClientSetUserId(client, USER_ID);\r
 \r
 MatrixClientLoginPassword(client,\r
-    "pscho",\r
-    "Wc23EbmB9G3faMq",\r
-    "Test1");\r
+    USERNAME,\r
+    PASSWORD,\r
+    DEVICE_NAME);\r
 \r
 MatrixClientDeleteDevice(client);\r
     \r
@@ -73,11 +91,10 @@ MatrixMegolmOutSession * megolmOutSession;
 MatrixClientNewMegolmOutSession(&client,\r
     ROOM_ID,\r
     &megolmOutSession);\r
-printf("megolm session id: %.10s... key: %.10s...\n", megolmOutSession->id, megolmOutSession->key);\r
 \r
 MatrixClientShareMegolmOutSession(&client,\r
     USER_ID,\r
-    "ULZZOKJBYN",\r
+    DEVICE_ID2,\r
     megolmOutSession);\r
 \r
 MatrixClientSendEventEncrypted(&client,\r