From 6bcc42e779b743100fefc36b1d507028ece13b5f Mon Sep 17 00:00:00 2001 From: Eddy Pedroni Date: Mon, 23 May 2022 19:13:51 +0200 Subject: Added documentation, update python requirements --- architecture.drawio | 1 + doc.html | 3094 +++++++++++++++++++++++++++++++++++++++++++++++ python-requirements.txt | 3 +- specifications.md | 44 - 4 files changed, 3096 insertions(+), 46 deletions(-) create mode 100644 architecture.drawio create mode 100644 doc.html delete mode 100644 specifications.md diff --git a/architecture.drawio b/architecture.drawio new file mode 100644 index 0000000..15b4e8b --- /dev/null +++ b/architecture.drawio @@ -0,0 +1 @@ +7Vptc9o4EP41zPQ+JOMXbOBjgCRtL51mQu6auy8dYQusiWy5skigv/4kW8K2ZMAlUDJzzGQIWq3Wq315VlrccUfx8paCNPpCQog7jhUuO+644zh93+efgrAqCJ7nFoQ5RWFBskvCBP2EkmhJ6gKFMKsxMkIwQ2mdGJAkgQGr0QCl5LXONiO4/tQUzKFBmAQAm9RvKGSRpNr+oJz4CNE8ko/uO71iIgaKWe4ki0BIXisk97rjjighrPgWL0cQC9spuxTrbjbMrhWjMGFtFsyjv+Pr79/gw5/pv9G0N/l+93lxIaW8ALyQG+44PubyhqlQma2kHfwfC6HnMAZ0jpKOe8VnrXTJPzkx362gXzCSFnPdyhyDS3YBMJrLdQFXGNJSJv82l//zJ6MKAcRc4BCbo09CxgwEcE2uL6lJ5EZB+lOm1KAowtcsQBiTLCAprIiY6gs4LdVpERV2U2Gstmhv3u1edsZwxiqG3iS7ScHjPC/nhSBbUHgVpxixRQg/oIT9UayaYQJYk+Ur6+6fH8n986ZFJ9nKw5dJm02cUMMbCn8sYBKs9tXTqWnovEDKEEe/qyJdx3lCD2XyjgvNhoRz8YcILJvxROGUGUmYxG7bkeMbECMsUP8jxC9QSBXpwWIsmNbPruKXAiOuA1xWSBLPbiGJIaMrzqJmVZWQxcXpy/FrCdXrShJVUNp2JRHI8jBfyy4RlH+RIPoLgOqcAdUE1JtFEjBEkluYQAoYoWdUbZ3oGWRfk0p2vxAefxuQVPDOZhuY36J29XO7rjVA6jgjhUcnU6hWjt6DQioZSn1gsoh/vzr/w/rQ9U5eH9yG+qDZGCbhlbi58NEUk+CZ2yIEWQRDaRg+f5ObdWwVo6plKwakZJGE+SprmzkzsqAB3KJyV167eJBBtvsuAcPajcp0TsX4ti/tTCEGDL3UL11Nxpfi7kmePcrRrqc5WvdfsUm5qnpJ0gR5esToggorGILyWFjvcf/w6BrhMRlPbMuynq6NOMleUYxBAlV+yRm7kpDyZOAOm/M2iBAO78CKLIRfMwaCZzUaRoSin1wsUOHEp6lKYsevcUzEShlnFIo6fa/izNZIX8CyxngHMiYJAcEYpBmarrdR4NqQMEbiXWHcHhW6mo9du2egwjowq6jgHwsUvAZQyKtFAekZBwHIDP+LY2DuF0qe4YhgfqxyxwkpAoIDhEbSQLo5IrIUBCiZ3+U8425JeZBm6NbxPUJhCJMcbBhgoHCd8FMqMiS3kzfkf9xyI+vS63hjUfI8cXRTY/4n2CkbkYTvBaDcsfx6w15hxhpdvjV1dseBui347dyu+A7udn93LcAo913hY9WAsvdycMxdhWHp0Ufh8PGFbXjdNb3uNngYgynE9yRD4jDDabTg1Tx/Kud6Tjvn9o/k24Hh28/jie9bluHiM4wfBsa7fe/EMK4UMnB8JhsziJvkjOJbE33QOgzeC4rbTT30M4wfxrunhnHbPJAbzn1v9zVp5J33NbmTU9zXugOvfgT3NBFt72s9p14EnIEm6Mj3NceEfHtbgJA0x9mK17V4yMuz4g4RiEkSPkaiuVOr3HZXEaqhxT2pjg88VyMyJwnA1yV1F7ZMZYnWQpFHIF09rfXlg3/EzKXjqfF4WWUdr9RoidhTzmpZthwXS23PkeNyqRhUV95Dirh/xMHnjRnhtG1hdFumhIw+1fJQUXyQ3FifEfWm1S/nhr9D0LFzwyyM59wwcuOCJ4etJYfvvsfkGLyD5Oi5Wu+m6+yXHF7fvtRrkPd708Mx0mN098lIkMN2xPu9+qY9x+yI200dcR07DveDqdkR/yszr0kmTmjgUDtybTxVlRXJq6bc1nR7Q2o5bY9ibQvPEc5ifb3eOHvWm4Feb3RBx04o86x+B6b8xsJvXRiLH8jPnZeDgIh+6G5qoK+dX/tZTV2nDo8im1roJAuK5kvldxS/w1UubJF3Z+YFx6YG3blD05xmb2nRNIaHd7ToOHfaj+jehpeuGt17rB6NeuPWyH39HbkHmKXcOPCDfENu/S5I8bV8bcZYccaEgwdNv13Q7NG25cPyrericFG+mu5e/wc= \ No newline at end of file diff --git a/doc.html b/doc.html new file mode 100644 index 0000000..cde9f36 --- /dev/null +++ b/doc.html @@ -0,0 +1,3094 @@ + + + + + + + + + + + + + + + + + + + + +My TiddlyWiki + +— a non-linear personal web notebook + + + + + + + + + + + + +
+ +
+ + + + + + + + + + + + + + diff --git a/python-requirements.txt b/python-requirements.txt index be4b9eb..43c0f36 100644 --- a/python-requirements.txt +++ b/python-requirements.txt @@ -1,2 +1 @@ -pyusb -python-usbtmc +serial-interface diff --git a/specifications.md b/specifications.md deleted file mode 100644 index 6919894..0000000 --- a/specifications.md +++ /dev/null @@ -1,44 +0,0 @@ -# Use Cases - -## Presets - -Useful presets are stored persistently (JSON or YAML) and recalled with a single command. Preset configuration is applied to both function generator and oscilloscope. The intention is to quickly restore a state that can then be used for manual tests. - -## Screen capture - -Capture screen, dump to PNG. File name can be parameterised including special codes for date, time and incrementing counter. - -## Frequency response measurement - -With a single command, a frequency response sweep is performed. - -Parameters: -* Frequency range (from, to in Hz) -* Measurement steps - * Linear or logarithmic? -* Signal generator channel -* Oscilloscope channel(s) - -Data is stored in an array of tuples (freq, [measurements]). - -Output options: -* CSV -* SVG plot? -* PNG plot? -* HTML report containing test parameters, data, plot, etc - -## Repeated measurement mode - -1. User specifies a set of actions to be taken on each round - * Record measurement on a specific channel - * Screen capture - * Frequency response sweep -2. System goes to measurement mode: whenever a specific key (enter) is pressed, all actions are taken - * System provides feedback when ready to accept new input -3. User exits measurement mode by pressing a special key (q) -4. Optionally, acquired data is handled. Options: - * Save to CSV - * Print to console - * Pass as argument to user callback - - -- cgit v1.2.3