mirror of https://github.com/saymrwulf/xous-core.git synced 2026-11-04 04:27:34 +00:00

History

bunnie fda782663a bump version pins for xous change		2023-12-26 00:13:10 +08:00
..
locales	revert accidental overwrite of a translation file it mtxcli	2023-10-27 14:14:39 +08:00
src	Rename "Matrix chat" to "Matrix cli"	2023-07-29 06:54:11 +10:00
Cargo.toml	bump version pins for xous change	2023-12-26 00:13:10 +08:00
mtxcli-emulator.gif	Adds images of mtxcli	2022-10-29 17:39:42 -05:00
mtxcli-precursor.gif	Adds images of mtxcli	2022-10-29 17:39:42 -05:00
README.md	Updates for #287	2023-01-17 12:23:02 -06:00
xous-french.png	Adds images of mtxcli	2022-10-29 17:39:42 -05:00

README.md

mtxcli

This is a simple Matrix chat application.

Here you see mtxcli running in hosted mode:

cargo xtask run mtxcli

Background

This is a simple Matrix chat application based on the REPL framework and adapted from the Desktop project mtxcli

Setup

In order to simplify the mtxcli application as much as possible the following must be setup on a conventional device before using Betrusted (laptop, mobile phone).

Create a new Matrix user (if needed):
- https://matrix.org/faq/#how-do-i-get-an-account-and-get-started%3F
- https://matrix.org/docs/projects/try-matrix-now/
Find (or create) a new room to join for chatting:
- https://doc.matrix.tu-dresden.de/en/rooms/create/
- https://spec.matrix.org/latest/#room-structure
Join the room
Save the configuration in the pddb
- /set user @myname:matrix.org
- /set password MySecret
- /set room #my-chat-room

Commands

The following commands are available in mtxcli:

/help [cmd] -- shows help message for all commands (or one cmd if given)
/login -- logs in to the server (assumes user and password are set)
/logout -- logs out of the server
/get key -- shows value of key (from the PDDB)
/set key value -- sets value of key (in the PDDB)
/unset key -- removes key (from the PDDB)
/status -- shows status of the connection

Chatting

Any line not starting with a slash ('/') will be sent to the current room. New messages from the current room will be displayed.

mtxcli on the Precursor device

Here are some images of runing mtxcli on the Precursor. NOTE: this Precusor has the Pi HAT installed.

mtxcli in French

I recently added the French localization to Xous -- including translating all of mtxcli. For more about locales and Xous please see the locales README

Troubleshooting

Prequisites: it is essential that the PDDB is mounted and WiFi is connected before running mtxcli. You can verify these in Shellchat with net ping 1.1.1.1.

If you see the message WARNING: clock not set that is likely because the Precursor real time clock needs to be set (e.g. if the battery has been completely discharged). Please go to the menu Preferences | Set Timezone to set the time zone (and update the time via NTP).

If you see the message authentication failed it might be because the user and password variables are not set properly. Alternatively it could be because TLS certificate validation has failed because the clock has not been set (see above).

Acknowledgements

This app is supported in part by a grant from the NGI0 PET Fund, a fund established by NLnet with financial support from the European Commission's Next Generation Internet program.