Source code for acq400_stream2

#!/usr/bin/env python

"""
This is a script intended to connect to a UUT and stream data from port 4210.

The data that has been streamed is not demuxed and so if it is to be used then it has to be demuxed first.
Something like:

    >>> data = numpy.fromfile("0000", dtype="<datatype>")
    >>> plt.plot(data[::<number of channels>])
    >>> plt.show()

usage::
    acq400_stream.py [-h] [--filesize FILESIZE] [--totaldata TOTALDATA]
                        [--root ROOT] [--runtime RUNTIME] [--verbose VERBOSE]
                        uuts [uuts ...]

acq400 stream

positional arguments:
  uuts                  uuts

optional arguments:
  -h, --help            show this help message and exit
  --filesize FILESIZE   Size of file to store in KB. If filesize > total data
                        then no data will be stored.
  --totaldata TOTALDATA
                        Total amount of data to store in KB
  --root ROOT           Location to save files
  --runtime RUNTIME     How long to stream data for
  --verbose VERBOSE     Prints status messages as the stream is running


Some usage examples are included below:

1: Acquire files of size 1024kb up to a total of 4096kb:


    >>> python acq400_stream2.py --verbose=1 --filesize=1M --totaldata=4M <module ip or name>

2: Acquire a single file of size 4096kb:


    >>> python acq400_stream2.py --verbose=1 --filesize=4M --totaldata=4M <module ip or name>

3: Acquire files of size 1024 for 10 seconds:


    >>> python acq400_stream2.py --verbose=1 --filesize=1M --runtime=10 <module ip or name>

4: Acquire data for 5 seconds and write the data all to a single file:


    >>> python acq400_stream2.py --verbose=1 --filesize=9999M --runtime=5 <module ip or name>

"""


import acq400_hapi
import os
import time
import argparse
import socket
import sys
import shutil
from builtins import input


def remove_stale_data(args):
    if os.path.exists(args.root + args.uuts[0]):
        answer = input("Stale data detected. Delete all contents in " + args.root + str(args.uuts[0]) + "? y/n ")
        if answer == "y":
            shutil.rmtree(args.root + args.uuts[0])
        else:
            pass


def make_data_dir(directory, verbose):
    try:
        os.makedirs(directory)
    except Exception:
        if verbose:
            print("Tried to create dir but dir already exists")
        pass


def run_stream(args):
    remove_stale_data(args)
    data_len_so_far = 0
    RXBUF_LEN = 4096
    cycle = 1
    root = args.root + args.uuts[0] + "/" + "{:06d}".format(cycle)
    file_num = 0

    skt = socket.socket()
    skt.connect((args.uuts[0], 4210))
    make_data_dir(root, args.verbose)
    start_time = time.time()
    data_length = 0
    if args.filesize > args.totaldata:
        args.filesize = args.totaldata

    data_file = None

    while time.time() < (start_time + args.runtime) and data_len_so_far < args.totaldata:

        bytestogo = args.filesize - data_length
        rxbuf_len = RXBUF_LEN if bytestogo > RXBUF_LEN else bytestogo

        data = skt.recv(rxbuf_len)

        data_length += len(data)
        data_len_so_far += len(data)
        if file_num > 99:
            file_num = 0
            cycle += 1
            root = args.root + args.uuts[0] + "/" + "{:06d}".format(cycle)
            make_data_dir(root, args.verbose)
        if data_file == None:
            data_file = open("{}/{:04d}".format(root, file_num), "wb")
        data_file.write(data)

        if args.verbose == 1:
            print("New data file written.")
            print("Data Transferred: ", data_len_so_far, "KB")
            print("Streaming time remaining: ", -1 * (time.time() - (start_time + args.runtime)))
            print("\n" * 2)

        if data_length >= args.filesize:
            file_num += 1
            data_length = 0
            data_file.close()
            data_file = None


def run_main():
    parser = argparse.ArgumentParser(description='acq400 stream')
    parser.add_argument('-filesize', '--filesize', default=0x100000, action=acq400_hapi.intSIAction, decimal=False)
    parser.add_argument('-totaldata', '--totaldata', default=sys.maxsize, action=acq400_hapi.intSIAction, decimal = False)
    parser.add_argument('--root', default="", type=str, help="Location to save files. Default dir is UUT name.")
    parser.add_argument('--runtime', default=sys.maxsize, type=int, help="How long to stream data for")
    parser.add_argument('--verbose', default=0, type=int, help='Prints status messages as the stream is running')
    parser.add_argument('uuts', nargs='+', help="uuts")
    run_stream(parser.parse_args())


if __name__ == '__main__':
    run_main()