Script Helper Utility

[JavaWiz]

After moving to v5, I noticed some of the NScriptHelper utility output was in xml format, which was difficult to parse in batch cmd files.  

I wrote a small python utility to make several of the calls easier to use in scripts (cmd, bash, ...).  Sharing in case anyone else finds it useful... 

• It is not compatible with Python2, must be Python3
  
• the -h command line switch will display a help page of options (see below)
  

EDIT: Added the Python script (missed in 1st post)

Code:

c:\Users\Public\NPVR-data\scripts\Utilities>python3 -m NPvrHelper -h
usage: NPvrHelper.py [-h] [-v] [--server SERVER] [--pin PIN] [--status] [--pending] [--isrecording] [--isinuse]

NextPVR Helper

optional arguments:
  -h, --help       show this help message and exit
  -v, --verbose    Enable debug logging.
  --server SERVER  Target NextPVR Server[:port] (default localhost:8866)
  --pin PIN        NextPVR security PIN
  --status         List tuner(s) status
  --pending        List pending recordings
  --isrecording    List in-process recordings
  --isinuse        List tuner in use status

example of commands:

Code:

c:\Users\Public\NPVR-data\scripts\Utilities>python3 -m NPvrHelper --server Nirvana --status
21 - HDHomeRun 1318E35A-0
      \\NAS-Office\PVR\TVShows\Ghost in the Shell (2017)\Ghost.in.the.Shell.(2017).ts
22 - HDHomeRun 1318E35A-1
23 - HDHomeRun 1318E35A-2
      LIVE&e:\adamico\Videos\Captures\live-ESPN-5280-1.ts


c:\Users\Public\NPVR-data\scripts\Utilities>python3 -m NPvrHelper --server Nirvana --isrecording
HDHomeRun 1318E35A-0 - RECORDING: Ghost.in.the.Shell.(2017)


c:\Users\Public\NPVR-data\scripts\Utilities>python3 -m NPvrHelper --server Nirvana --isinuse
HDHomeRun 1318E35A-0 - IS In Use
HDHomeRun 1318E35A-1 - NOT In Use
HDHomeRun 1318E35A-2 - IS In Use


c:\Users\Public\NPVR-data\scripts\Utilities>python3 -m NPvrHelper --server Nirvana --pending
04/25/20 10:53AM -> 12:15PM [SYFY  ] Ghost in the Shell
04/26/20 08:00PM -> 09:00PM [WCWJDT] Batwoman: S01E17 - A Narrow Escape
04/27/20 08:00PM -> 09:01PM [WFOX  ] 9-1-1: S03E16 - The One That Got Away
04/27/20 10:00PM -> 11:14PM [AMC   ] Dispatches From Elsewhere: S01E10 - The Boy
04/29/20 09:01PM -> 10:00PM [WJAX  ] SEAL Team: S03E19 - In the Blind
04/30/20 10:00PM -> 11:00PM [WTLV  ] Blindspot: S05E01 - I Came to Sleigh
05/01/20 08:00PM -> 09:00PM [WTLV  ] The Blacklist: S07E17 - Brothers
05/01/20 08:00PM -> 09:00PM [WJAX  ] MacGyver: S04E12 - Loyalty + Family + Rogue + Hellfire
05/03/20 08:00PM -> 09:00PM [WCWJDT] Batwoman: S01E18 - If You Believe in Me, I'll Believe in You
05/04/20 08:00PM -> 09:01PM [WFOX  ] 9-1-1: S03E17 - Powerless
05/06/20 10:00PM -> 11:00PM [WJAX  ] SEAL Team: S03E20 - No Choice in Duty
05/07/20 09:00PM -> 10:00PM [WTLV  ] Blindspot: S05E02 - We Didn't Start the Fire
05/08/20 08:00PM -> 09:00PM [WTLV  ] The Blacklist: S07E18 - Roy Cain
05/08/20 08:00PM -> 09:00PM [WJAX  ] MacGyver: S04E13 - Save + The + Dam + World

[JavaWiz]

Updated script

• added return codes for each function, in a cmd file, this provides the ability to check %ERRORLEVEL% rather than having to parse the output of the command.
  
•     ie if you call with --isinuse, will return False (0) if no tuners are in use, or True (1) if at least 1 tuner in use.
  
• better error handling
  
• cosmetic output changes.
  

[Graham]

I wrote a small python utility to make several of the calls easier to use in scripts (cmd, bash, ...).  Sharing in case anyone else finds it useful... 

There is now this ... https://github.com/sub3/NextPVR/wiki/nscripthelper

You might want to put a description of your scripts at the end of the nscripthelper page or as a new page.