<gh_stars>1-10
#!/usr/bin/env python3

# TODO from jump we need to check out_dir exists and we can create subdir for logs there [do we pass out_dir with args?]

# TODO how best to not clobber CSV output files

# TODO think through and implement where data in *general* gets saved and log file handling (rotation?)

# TODO can we write to Eric spreadsheet template directly?

# TODO improve initial prompt for go/no-go decision

# TODO all of the TSH commanding (set/get config is primary objective for now)

# TODO have TshAccelBuffer natively include some form of raw_data_from_socket and maybe selected signal proc. methods

# TODO implement new feature with ability to start somewhere besides +x and progress thru abbrev. sequence after that...
# TODO ...BUT this requires special initialization for position to *previous* rough home

# TODO add another buffer duration, so (1) for final output file (60sec), & new shorter one for (2) GSS angles/visits

# TODO fix the move_to code for robustness against not getting actual position to desired (motor on forcing)

# TODO add PGA and ELECT testing and output files

import os
import sys
import time
import datetime
import platform
import logging
import logging.config
import numpy as np
import multiprocessing

from tshcal.inputs import argparser
from tshcal.inputs import user_menu
from tshcal.commanding import tsh_commands
from tshcal.commanding import esp_commands
from tshcal.common import buffer
from tshcal.defaults import ROOT_DIR, DEFAULT_PORT
from tshcal.common.buffer import Tsh, raw_data_from_socket


def get_logger(log_file):
    """return logger object with both stream and file handlers, the latter using log_file"""

    # create logger
    logger = logging.getLogger('tshcal')
    logger.setLevel(logging.DEBUG)

    # create file handler which logs to DEBUG level
    fh = logging.FileHandler(log_file)
    fh.setLevel(logging.DEBUG)

    # # create console handler with a higher log level
    # ch = logging.StreamHandler()
    # ch.setLevel(logging.INFO)  # changed from ERROR to INFO

    # create formatter and add it to the handlers
    formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(module)s : %(lineno)d - %(message)s')
    fh.setFormatter(formatter)
    # ch.setFormatter(formatter)

    # add the handlers to the logger
    logger.addHandler(fh)
    # logger.addHandler(ch)

    return logger


def get_inputs(module_logger):
    """return arguments parsed from command line and make log entries"""

    # parse arguments
    module_logger.debug('parsing input arguments')
    args = argparser.parse_inputs()
    module_logger.info(str(args).replace('Namespace', 'Inputs: '))

    # adjust log level based on verbosity input args
    if args.quiet:
        module_logger.warning('Now switching to quiet for logging, that is, log level = WARNING.')
        level = logging.WARNING
    elif args.verbose:
        level = logging.DEBUG
    else:
        level = logging.INFO

    # switch to same level for all handlers
    module_logger.setLevel(level)
    for handler in module_logger.handlers:
        handler.setLevel(level)

    return args


def wait_for_start_time(s, mod_logger):
    """delay until start time, s, has been surpassed; log via mod_logger"""

    # TODO make more user-friendly; e.g. prompt/update every 10sec with time remaining to start & a chance to abort

    # FIXME below lines are development/debug "if False" mechanism used so I am not waiting during code development
    # ----- WHEN READY GET RID OF if False PRETEXT AND UNINDENT THE OTHER LINES OF CODE TO DEPLOY ACTUAL DELAY -----
    if False:
        now = datetime.datetime.now()
        if s <= now:
            raise RuntimeError('not enough delay in start time, use more of a delay until start time')

        while now < s:
            time.sleep(10)  # wait 10 seconds
            now = datetime.datetime.now()

        mod_logger.info('The calibration start time, %s, has been reached.  Begin calibrating now.' % s)
    # ----- WHEN READY GET RID OF if False PRETEXT AND UNINDENT THE OTHER LINES OF CODE TO DEPLOY ACTUAL DELAY -----

    mod_logger.info('Faking that the calibration start time, %s, has been reached.  Begin calibrating now.' % s)


def show_tsh_buffer_summary(tsh, sec=3, logger=None):
    """this does not much beyond demonstrate instantiation of TshAccelBuffer with logging"""

    # FIXME significant parts of this function are for quick demo purposes only, so scrub and fix

    logger.info('Capturing quick data summary from tsh...')

    # create data buffer
    buff = buffer.TshAccelBuffer(tsh, sec, logger=logger)
    raw_data_from_socket(tsh.ip, buff, port=DEFAULT_PORT)  # this populates 2nd arg, buff

    logger.debug('Done capturing quick data summary from tsh.')

    # FIXME should we do something smart about units?
    s = 'QUICK SUMMARY...Mean: X = {:.3f}, Y = {:.3f}, Z = {:.3f} [units]'.format(*np.mean(buff.xyz, axis=0))
    s += ' <-' * 17

    # show/log summary
    logger.info(s)


def main():
    """return status/exit code that results from running tshcal main application"""

    # create logger
    log_file = os.path.join(ROOT_DIR, 'logging', 'tshcal.log')
    module_logger = get_logger(log_file)
    module_logger.info('- STARTING MAIN TSHCAL APP - - - - - - - - - - - - - - - - - - - - - -')
    module_logger.debug('log_file = %s' % log_file)

    # get input arguments
    args = get_inputs(module_logger)

    # prompt user to follow along with logging in new terminal
    prompt_str = 'Start new log term w/ "tail -f %s" to see logging, then back to this cmd term for prompts.' % log_file
    accept_str = 'User indicated log file is being monitored in another terminal, so continue.'
    ans = user_menu.prompt_yes_no(prompt_str, accept_str)
    # if user chose zero to quit early, then do a graceful exit
    if ans == 0:
        module_logger.info('bye')
        sys.exit(-1)

    # TODO design tsh class that gives robustness (with commanding to set/get sample rate, gain, units, etc.)
    # create tsh object FIXME << this is a dummy for now
    tsh = Tsh(args.sensor, args.rate, args.gain)

    # FIXME for now, just squawk about not having Tsh class to handle get/set commanding or querying state
    module_logger.info('SKIPPING TSH SET/GET SINCE NO GOOD Tsh CLASS YET.')
    if False:
        # FIXME this indented block under "if False" should eventually get unindented to actually be employed

        # FIXME verify the tsh object we created given desired input args matches what's physically hooked up

        # set tsh parameters
        tsh_state_desired = tsh_commands.set_tsh_state(args)

        # get tsh parameters
        tsh_state_actual = tsh_commands.get_tsh_state()

        # verify tsh parameters
        if tsh_state_actual == tsh_state_desired:
            module_logger.debug('The tsh actual state matches our desired state.')
        else:
            # TODO give more info here -- what exactly does not match?
            raise AssertionError('The tsh actual state does NOT match our desired state.')

    # if OS allows, then we can do quick tsh data check (must be linux)
    pform = platform.platform()
    if pform.lower().startswith('linux'):

        module_logger.info('Perform quick tsh data test since OS detected is linux.')

        # FIXME this next multiprocessing feature does not work on mac os
        # create buffer to capture 2 seconds of TSH data and show user a summary of what we got (do as process for timeout)
        buff_sec = 2
        p = multiprocessing.Process(target=show_tsh_buffer_summary,
                                    args=(tsh, ),
                                    kwargs={'sec': buff_sec, 'logger': module_logger})
        p.start()

        # wait for double buff_sec or until process finishes
        p.join(buff_sec * 2)

        # if thread still active, that is, active for too long, then we log it and quit out
        if p.is_alive():
            timeout_msg = 'A %d-sec tsh data buffer still not filled after %d sec...' % (buff_sec, buff_sec * 2)
            timeout_msg += 'Too long, something went wrong...kill it!'
            module_logger.info(timeout_msg)

            p.terminate()
            p.join()

            module_logger.info('Why did it take %d seconds or more to fill a %d-second TSH buffer?' %
                               (buff_sec * 2, buff_sec))

            print('See log for early exit due to tsh buffer issue.')

            sys.exit(-2)

    else:
        module_logger.info('Skip quick tsh data test since OS is not Linux.')

    # FIXME Do we need to do anything prep/config for ESP here? (e.g. GENERAL MODE SELECTION or STATUS FUNCTIONS...
    # FIXME ...maybe from Table 3.5.1 of ESP301 User Guide or possibly something else)?  Will may have answered this?

    # FIXME before any motion begins, our safe trajectories ASSUME starting in home position; prompt user to verify home

    # FIXME Before delay timer, prompt user with enough info here to enable a go/no-go answer...
    # FIXME ... e.g. hit [Enter] if prompted-profile looks good OR give another keypress with chance to retry or...?
    # FIXME ** This should include whether or not debug/prompt-along-way is going to happen or not [auto- or semi-auto?]

    # offer enough prompt info for user to make go/no-go decision...but for now, just this crude prompt
    prompt_str = 'ESP rig at absolute home in all 3 axes (and other stuff initialized)?'
    accept_str = 'User indicated that ESP rig, TSH, cable clearance, config and all is a "go".'
    ans_go = user_menu.prompt_yes_no(prompt_str, accept_str)
    # if user chose zero to quit early, then do a graceful exit
    if ans_go == 0:
        module_logger.info('User aborted at go/no-go decision prompt.')
        sys.exit(-3)

    # FIXME our flow chart shows 2 delays, but no smarts here yet to verify enough time for TSH temperature settling

    # delay until start time to begin calibration
    wait_for_start_time(args.start, module_logger)

    # run calibration routine
    esp_commands.run_cal(tsh, args.outdir, plot=args.plot, debug=args.debug)

    # FIXME are there any commands we need to send to TSH at this point after running calibration?

    module_logger.info('- - - Calibration Complete - - - - - - - - - - - - - - - - - - - - - -')

    return 0  # return zero for success (typical Linux command line behavior)


if __name__ == '__main__':

    sys.exit(main())

#!/usr/bin/env python3

# TODO from jump we need to check out_dir exists and we can create subdir for logs there [do we pass out_dir with args?]

# TODO how best to not clobber CSV output files

# TODO think through and implement where data in *general* gets saved and log file handling (rotation?)

# TODO can we write to Eric spreadsheet template directly?

# TODO improve initial prompt for go/no-go decision

# TODO all of the TSH commanding (set/get config is primary objective for now)

# TODO have TshAccelBuffer natively include some form of raw_data_from_socket and maybe selected signal proc. methods

# TODO implement new feature with ability to start somewhere besides +x and progress thru abbrev. sequence after that...
# TODO ...BUT this requires special initialization for position to *previous* rough home

# TODO add another buffer duration, so (1) for final output file (60sec), & new shorter one for (2) GSS angles/visits

# TODO fix the move_to code for robustness against not getting actual position to desired (motor on forcing)

# TODO add PGA and ELECT testing and output files

import os
import sys
import time
import datetime
import platform
import logging
import logging.config
import numpy as np
import multiprocessing

from tshcal.inputs import argparser
from tshcal.inputs import user_menu
from tshcal.commanding import tsh_commands
from tshcal.commanding import esp_commands
from tshcal.common import buffer
from tshcal.defaults import ROOT_DIR, DEFAULT_PORT
from tshcal.common.buffer import Tsh, raw_data_from_socket


def get_logger(log_file):
    """return logger object with both stream and file handlers, the latter using log_file"""

    # create logger
    logger = logging.getLogger('tshcal')
    logger.setLevel(logging.DEBUG)

    # create file handler which logs to DEBUG level
    fh = logging.FileHandler(log_file)
    fh.setLevel(logging.DEBUG)

    # # create console handler with a higher log level
    # ch = logging.StreamHandler()
    # ch.setLevel(logging.INFO)  # changed from ERROR to INFO

    # create formatter and add it to the handlers
    formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(module)s : %(lineno)d - %(message)s')
    fh.setFormatter(formatter)
    # ch.setFormatter(formatter)

    # add the handlers to the logger
    logger.addHandler(fh)
    # logger.addHandler(ch)

    return logger


def get_inputs(module_logger):
    """return arguments parsed from command line and make log entries"""

    # parse arguments
    module_logger.debug('parsing input arguments')
    args = argparser.parse_inputs()
    module_logger.info(str(args).replace('Namespace', 'Inputs: '))

    # adjust log level based on verbosity input args
    if args.quiet:
        module_logger.warning('Now switching to quiet for logging, that is, log level = WARNING.')
        level = logging.WARNING
    elif args.verbose:
        level = logging.DEBUG
    else:
        level = logging.INFO

    # switch to same level for all handlers
    module_logger.setLevel(level)
    for handler in module_logger.handlers:
        handler.setLevel(level)

    return args


def wait_for_start_time(s, mod_logger):
    """delay until start time, s, has been surpassed; log via mod_logger"""

    # TODO make more user-friendly; e.g. prompt/update every 10sec with time remaining to start & a chance to abort

    # FIXME below lines are development/debug "if False" mechanism used so I am not waiting during code development
    # ----- WHEN READY GET RID OF if False PRETEXT AND UNINDENT THE OTHER LINES OF CODE TO DEPLOY ACTUAL DELAY -----
    if False:
        now = datetime.datetime.now()
        if s <= now:
            raise RuntimeError('not enough delay in start time, use more of a delay until start time')

        while now < s:
            time.sleep(10)  # wait 10 seconds
            now = datetime.datetime.now()

        mod_logger.info('The calibration start time, %s, has been reached.  Begin calibrating now.' % s)
    # ----- WHEN READY GET RID OF if False PRETEXT AND UNINDENT THE OTHER LINES OF CODE TO DEPLOY ACTUAL DELAY -----

    mod_logger.info('Faking that the calibration start time, %s, has been reached.  Begin calibrating now.' % s)


def show_tsh_buffer_summary(tsh, sec=3, logger=None):
    """this does not much beyond demonstrate instantiation of TshAccelBuffer with logging"""

    # FIXME significant parts of this function are for quick demo purposes only, so scrub and fix

    logger.info('Capturing quick data summary from tsh...')

    # create data buffer
    buff = buffer.TshAccelBuffer(tsh, sec, logger=logger)
    raw_data_from_socket(tsh.ip, buff, port=DEFAULT_PORT)  # this populates 2nd arg, buff

    logger.debug('Done capturing quick data summary from tsh.')

    # FIXME should we do something smart about units?
    s = 'QUICK SUMMARY...Mean: X = {:.3f}, Y = {:.3f}, Z = {:.3f} [units]'.format(*np.mean(buff.xyz, axis=0))
    s += ' <-' * 17

    # show/log summary
    logger.info(s)


def main():
    """return status/exit code that results from running tshcal main application"""

    # create logger
    log_file = os.path.join(ROOT_DIR, 'logging', 'tshcal.log')
    module_logger = get_logger(log_file)
    module_logger.info('- STARTING MAIN TSHCAL APP - - - - - - - - - - - - - - - - - - - - - -')
    module_logger.debug('log_file = %s' % log_file)

    # get input arguments
    args = get_inputs(module_logger)

    # prompt user to follow along with logging in new terminal
    prompt_str = 'Start new log term w/ "tail -f %s" to see logging, then back to this cmd term for prompts.' % log_file
    accept_str = 'User indicated log file is being monitored in another terminal, so continue.'
    ans = user_menu.prompt_yes_no(prompt_str, accept_str)
    # if user chose zero to quit early, then do a graceful exit
    if ans == 0:
        module_logger.info('bye')
        sys.exit(-1)

    # TODO design tsh class that gives robustness (with commanding to set/get sample rate, gain, units, etc.)
    # create tsh object FIXME << this is a dummy for now
    tsh = Tsh(args.sensor, args.rate, args.gain)

    # FIXME for now, just squawk about not having Tsh class to handle get/set commanding or querying state
    module_logger.info('SKIPPING TSH SET/GET SINCE NO GOOD Tsh CLASS YET.')
    if False:
        # FIXME this indented block under "if False" should eventually get unindented to actually be employed

        # FIXME verify the tsh object we created given desired input args matches what's physically hooked up

        # set tsh parameters
        tsh_state_desired = tsh_commands.set_tsh_state(args)

        # get tsh parameters
        tsh_state_actual = tsh_commands.get_tsh_state()

        # verify tsh parameters
        if tsh_state_actual == tsh_state_desired:
            module_logger.debug('The tsh actual state matches our desired state.')
        else:
            # TODO give more info here -- what exactly does not match?
            raise AssertionError('The tsh actual state does NOT match our desired state.')

    # if OS allows, then we can do quick tsh data check (must be linux)
    pform = platform.platform()
    if pform.lower().startswith('linux'):

        module_logger.info('Perform quick tsh data test since OS detected is linux.')

        # FIXME this next multiprocessing feature does not work on mac os
        # create buffer to capture 2 seconds of TSH data and show user a summary of what we got (do as process for timeout)
        buff_sec = 2
        p = multiprocessing.Process(target=show_tsh_buffer_summary,
                                    args=(tsh, ),
                                    kwargs={'sec': buff_sec, 'logger': module_logger})
        p.start()

        # wait for double buff_sec or until process finishes
        p.join(buff_sec * 2)

        # if thread still active, that is, active for too long, then we log it and quit out
        if p.is_alive():
            timeout_msg = 'A %d-sec tsh data buffer still not filled after %d sec...' % (buff_sec, buff_sec * 2)
            timeout_msg += 'Too long, something went wrong...kill it!'
            module_logger.info(timeout_msg)

            p.terminate()
            p.join()

            module_logger.info('Why did it take %d seconds or more to fill a %d-second TSH buffer?' %
                               (buff_sec * 2, buff_sec))

            print('See log for early exit due to tsh buffer issue.')

            sys.exit(-2)

    else:
        module_logger.info('Skip quick tsh data test since OS is not Linux.')

    # FIXME Do we need to do anything prep/config for ESP here? (e.g. GENERAL MODE SELECTION or STATUS FUNCTIONS...
    # FIXME ...maybe from Table 3.5.1 of ESP301 User Guide or possibly something else)?  Will may have answered this?

    # FIXME before any motion begins, our safe trajectories ASSUME starting in home position; prompt user to verify home

    # FIXME Before delay timer, prompt user with enough info here to enable a go/no-go answer...
    # FIXME ... e.g. hit [Enter] if prompted-profile looks good OR give another keypress with chance to retry or...?
    # FIXME ** This should include whether or not debug/prompt-along-way is going to happen or not [auto- or semi-auto?]

    # offer enough prompt info for user to make go/no-go decision...but for now, just this crude prompt
    prompt_str = 'ESP rig at absolute home in all 3 axes (and other stuff initialized)?'
    accept_str = 'User indicated that ESP rig, TSH, cable clearance, config and all is a "go".'
    ans_go = user_menu.prompt_yes_no(prompt_str, accept_str)
    # if user chose zero to quit early, then do a graceful exit
    if ans_go == 0:
        module_logger.info('User aborted at go/no-go decision prompt.')
        sys.exit(-3)

    # FIXME our flow chart shows 2 delays, but no smarts here yet to verify enough time for TSH temperature settling

    # delay until start time to begin calibration
    wait_for_start_time(args.start, module_logger)

    # run calibration routine
    esp_commands.run_cal(tsh, args.outdir, plot=args.plot, debug=args.debug)

    # FIXME are there any commands we need to send to TSH at this point after running calibration?

    module_logger.info('- - - Calibration Complete - - - - - - - - - - - - - - - - - - - - - -')

    return 0  # return zero for success (typical Linux command line behavior)


if __name__ == '__main__':

    sys.exit(main())
#!/usr/bin/env python3 # TODO from jump we need to check out_dir exists and we can create subdir for logs there [do we pass out_dir with args?] # TODO how best to not clobber CSV output files # TODO think through and implement where data in *general* gets saved and log file handling (rotation?) # TODO can we write to Eric spreadsheet template directly? # TODO improve initial prompt for go/no-go decision # TODO all of the TSH commanding (set/get config is primary objective for now) # TODO have TshAccelBuffer natively include some form of raw_data_from_socket and maybe selected signal proc. methods # TODO implement new feature with ability to start somewhere besides +x and progress thru abbrev. sequence after that... # TODO ...BUT this requires special initialization for position to *previous* rough home # TODO add another buffer duration, so (1) for final output file (60sec), & new shorter one for (2) GSS angles/visits # TODO fix the move_to code for robustness against not getting actual position to desired (motor on forcing) # TODO add PGA and ELECT testing and output files return logger object with both stream and file handlers, the latter using log_file # create logger # create file handler which logs to DEBUG level # # create console handler with a higher log level # ch = logging.StreamHandler() # ch.setLevel(logging.INFO)  # changed from ERROR to INFO # create formatter and add it to the handlers # ch.setFormatter(formatter) # add the handlers to the logger # logger.addHandler(ch) return arguments parsed from command line and make log entries # parse arguments # adjust log level based on verbosity input args # switch to same level for all handlers delay until start time, s, has been surpassed; log via mod_logger # TODO make more user-friendly; e.g. prompt/update every 10sec with time remaining to start & a chance to abort # FIXME below lines are development/debug "if False" mechanism used so I am not waiting during code development # ----- WHEN READY GET RID OF if False PRETEXT AND UNINDENT THE OTHER LINES OF CODE TO DEPLOY ACTUAL DELAY ----- # wait 10 seconds # ----- WHEN READY GET RID OF if False PRETEXT AND UNINDENT THE OTHER LINES OF CODE TO DEPLOY ACTUAL DELAY ----- this does not much beyond demonstrate instantiation of TshAccelBuffer with logging # FIXME significant parts of this function are for quick demo purposes only, so scrub and fix # create data buffer # this populates 2nd arg, buff # FIXME should we do something smart about units? # show/log summary return status/exit code that results from running tshcal main application # create logger # get input arguments # prompt user to follow along with logging in new terminal # if user chose zero to quit early, then do a graceful exit # TODO design tsh class that gives robustness (with commanding to set/get sample rate, gain, units, etc.) # create tsh object FIXME << this is a dummy for now # FIXME for now, just squawk about not having Tsh class to handle get/set commanding or querying state # FIXME this indented block under "if False" should eventually get unindented to actually be employed # FIXME verify the tsh object we created given desired input args matches what's physically hooked up # set tsh parameters # get tsh parameters # verify tsh parameters # TODO give more info here -- what exactly does not match? # if OS allows, then we can do quick tsh data check (must be linux) # FIXME this next multiprocessing feature does not work on mac os # create buffer to capture 2 seconds of TSH data and show user a summary of what we got (do as process for timeout) # wait for double buff_sec or until process finishes # if thread still active, that is, active for too long, then we log it and quit out # FIXME Do we need to do anything prep/config for ESP here? (e.g. GENERAL MODE SELECTION or STATUS FUNCTIONS... # FIXME ...maybe from Table 3.5.1 of ESP301 User Guide or possibly something else)?  Will may have answered this? # FIXME before any motion begins, our safe trajectories ASSUME starting in home position; prompt user to verify home # FIXME Before delay timer, prompt user with enough info here to enable a go/no-go answer... # FIXME ... e.g. hit [Enter] if prompted-profile looks good OR give another keypress with chance to retry or...? # FIXME ** This should include whether or not debug/prompt-along-way is going to happen or not [auto- or semi-auto?] # offer enough prompt info for user to make go/no-go decision...but for now, just this crude prompt # if user chose zero to quit early, then do a graceful exit # FIXME our flow chart shows 2 delays, but no smarts here yet to verify enough time for TSH temperature settling # delay until start time to begin calibration # run calibration routine # FIXME are there any commands we need to send to TSH at this point after running calibration? # return zero for success (typical Linux command line behavior)