Commit 329871bf by zacharyc

Fixed example formatting a bit.


git-svn-id: https://bucket.mit.edu/svn/nilm/acquisition/ethstream@7464 ddd99763-3ecb-0310-9145-efcb8ce7c51f
parent f4f809ee
Showing with 27 additions and 27 deletions
char examplestring[] = "\n\ char examplestring[] = "\n\
\n\ \n\
Welcome to the NILM Ethstream examples.\n\ Welcome to the NILM Ethstream examples.\n\
\n\ \n\
For the most part, typing \"ethstream\" by itself will sample the first\n\ For the most part, typing \"ethstream\" by itself will sample the first\n\
two channels at 8 kHz on 10V range. Press CTRL-C to terminate sampling.\n\ two channels at 8 kHz on 10V range. Press CTRL-C to terminate sampling.\n\
...@@ -9,14 +9,14 @@ two channels at 8 kHz on 10V range. Press CTRL-C to terminate sampling.\n\ ...@@ -9,14 +9,14 @@ two channels at 8 kHz on 10V range. Press CTRL-C to terminate sampling.\n\
If you want a voltage and current measurement on the first phase of NILM\n\ If you want a voltage and current measurement on the first phase of NILM\n\
with default sample rate of 8 kHz and 10V range:\n\ with default sample rate of 8 kHz and 10V range:\n\
\n\ \n\
ethstream -C 0,3\n\ ethstream -C 0,3\n\
\n\ \n\
The device is configured so that channels 0 through 2 are voltages for\n\ The device is configured so that channels 0 through 2 are voltages for\n\
the three phases and channels 3-5 are for currents of the three phases\n\ the three phases and channels 3-5 are for currents of the three phases\n\
\n\ \n\
If you want only voltages at 16 kHz and 10V range:\n\ If you want only voltages at 16 kHz and 10V range:\n\
\n\ \n\
ethstream -n 3 -r 16000\n\ ethstream -n 3 -r 16000\n\
\n\ \n\
The -n option samples a number of channels starting at 0. The rate can be\n\ The -n option samples a number of channels starting at 0. The rate can be\n\
at least 16000 if 12 channels are sampled , but it can do more if\n\ at least 16000 if 12 channels are sampled , but it can do more if\n\
...@@ -30,42 +30,42 @@ permanent damage to NILM or NerdJack.\n\ ...@@ -30,42 +30,42 @@ permanent damage to NILM or NerdJack.\n\
\n\ \n\
If you need a higher accuracy but lower range measurement on the currents:\n\ If you need a higher accuracy but lower range measurement on the currents:\n\
\n\ \n\
ethstream -R 5,10 -C 3,4,5\n\ ethstream -R 5,10 -C 3,4,5\n\
\n\ \n\
The two numbers to the R command set the range to either 5V or 10V. Above,\n\ The two numbers to the R command set the range to either 5V or 10V. Above,\n\
we are setting channels 0-5 to 5 V range and channels 6-11 to 10 V range.\n\ we are setting channels 0-5 to 5 V range and channels 6-11 to 10 V range.\n\
Channels 6-11 are unconnected, but they can have range set independently.\n\ Channels 6-11 are unconnected, but they can have range set independently.\n\
The values here depend on the NILM box settings to the current transducers.\n\ The values here depend on the NILM box settings to the current transducers.\n\
The value read is the voltage seen by the NerdJack.\n\ The value read is the voltage seen by the NerdJack.\n\
\n\ \n\
All of the above examples output a digital number from 0 to 65535 with\n\ All of the above examples output a digital number from 0 to 65535 with\n\
65535 representing the highest range (5V or 10V). If you want conversion\n\ 65535 representing the highest range (5V or 10V). If you want conversion\n\
to volts for all six voltages and currents:\n\ to volts for all six voltages and currents:\n\
\n\ \n\
ethstream -c -C 0,3,1,4,2,5\n\ ethstream -c -C 0,3,1,4,2,5\n\
\n\ \n\
The channels will be output in the order given in the C command. This\n\ The channels will be output in the order given in the C command. This\n\
command will group the current and voltage data by phase.\n\ command will group the current and voltage data by phase.\n\
\n\ \n\
If you are supplying data from ethstream to another program, you might\n\ If you are supplying data from ethstream to another program, you might\n\
want to dump its output to a file and terminate after a certain number of\n\ want to dump its output to a file and terminate after a certain number of\n\
samples:\n\ samples:\n\
\n\ \n\
ethstream -n 6 -r 8000 - l 16000 > outfile.dat\n\ ethstream -n 6 -r 8000 - l 16000 > outfile.dat\n\
\n\ \n\
This will take 16000 samples at 8 kHz (2 seconds of acquisition) of all\n\ This will take 16000 samples at 8 kHz (2 seconds of acquisition) of all\n\
channels and write the data to outfile.dat. This can be directly read\n\ channels and write the data to outfile.dat. This can be directly read\n\
by a package like MATLAB.\n\ by a package like MATLAB.\n\
\n\ \n\
If there are multiple NerdJacks or you have changed the TCP/IP settings\n\ If there are multiple NerdJacks or you have changed the TCP/IP settings\n\
from default, you might have to specify which one you want to talk to:\n\ from default, you might have to specify which one you want to talk to:\n\
\n\ \n\
ethstream -a 192.168.1.210\n\ ethstream -a 192.168.1.210\n\
\n\ \n\
This will sample two channels at 8 kHz from the NerdJack at 192.168.1.210.\n\ This will sample two channels at 8 kHz from the NerdJack at 192.168.1.210.\n\
This is the default \"1\" setting on the NerdJack. If no address is\n\ This is the default \"1\" setting on the NerdJack. If no address is\n\
specified, ethstream connects first to 192.168.1.209. It then tries\n\ specified, ethstream connects first to 192.168.1.209. It then tries\n\
to autodetect the NerdJack. This should find the device if you are on\n\ to autodetect the NerdJack. This should find the device if you are on\n\
the same network, but it will get confused if there are multiple NerdJacks\n\ the same network, but it will get confused if there are multiple NerdJacks\n\
on the network.\n\ on the network.\n\
"; ";
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment