hummy.tv Wiki - User contributions [en]

FlexView

2025-03-28T15:42:27Z

MymsMan: /* Acknowledgements */

[[file:Flexview.png|left||Icon]]
= FlexView - A flexible way to manage your recordings =
== Overview ==
FlexView is intended to offer an alternative to the traditional webif to
allow you to view an manage your recording inventory in whatever way suits
you.

__TOC__

As the name suggests the emphasis is on maximum flexibility, you can:
* Choose the which pieces of information are displayed.
* Choose the display order
* Change the display size.
* Change the display format (more flexibility to come)
* Sort and filter on nearly all attributes
* Allow table to grow to accommodate data or fix table size
* Hide the directory tree
* Refresh individual folder
* Display multiple folders simultaneously
* Save your preferred display options for re-use
* Switch between saved formats
* Use all of the Browse context menu commands (plus a few more)

FlexView does not change the contents of your disk (unlike FlatView) so it
does not change the on TV, using remote control, view of recordings

== Usage scenarios ==
[[file:FVex1.jpg|Fixed size table, single directory (Movies) selected]]

Fixed size table, single directory (Movies) selected, showing tooltip

[[file:FVex2.jpg|Default configuration with ABC directory and sub-folders selected]]

Default configuration with ABC directory and sub-folders selected

[[file:FVex3.jpg|Directory tree hidden, using Column Chooser to add thumbnail image column ]]

Directory tree hidden, using Column Chooser to add thumbnail image column

[[file:FVex4.jpg|]File list with thumbnails shown and filtered to show only New (unwatched) files]]

File list with thumbnails shown and filtered to show only New (unwatched) files

== How To ==
;Resize columns
:Hover over line between column headers until resize handle appears, drag handle to resize column
;Move columns
:Drag column header to desired position or use column chooser dialog to move columns
;Sort columns
:Click on column header, click again to reverse sort directions
;Filter columns
:Use the filter toolbar beneath the column header
:Many columns display a pull down list to select options
:Other columns allow for text entry, the comparison operator can be changed by clicking on the operator to the left of the entry field.
:If filtering on file size enter the number in bytes e.g. 1000000 for 1 MB
:If filtering on directory size enter the number in kilobytes e.g. 1000 for 1 MB
:If filtering on time fields (duration, scheduled duration or resume point) enter the number in seconds e.g. 600 for 10 Mins, 3600 for 1 Hour
:If filtering of date-time fields use the Date Picker or enter the date in dd mon yy hh:mm format e.g. 02 Feb 25 22:00
;Save configuration
:Adjust visible columns, size & positions as desired, select directories to be displayed, Click Save button and type name for the configuration.
:Note. You can overwrite the supplied configurations but this is not recommended.
;Restore supplied configuration
:If you delete or make unwanted changes to supplied configurations
:Delete unwanted configurations (Load button) and then force reinstall the flexview package on Diag panel

== Installation ==
FlexView is in the "development and advanced packages" section of the
catalogue so to see and install the package select "Show development and
advanced packages?" in the "Advanced settings" section of the Settings
page.

== Settings ==
None currently on Settings page.

New configurations are created by selecting directories to be expanded
and/or displayed in the tree view and by changing column display options
then using the Save button to save the new configuration.

Saved configurations are saved in /mod/etc/fvConfiq_name.json they can be
editted, with care, to adjust configuration values
that can't currently be changed via the UI.

== Limitations ==
* TVDB information is not shown.
* MP3/MP4/JPEG attributes are not shown
* No interface for changing date formats and some other parameters.

== Debugging ==
FlexView writes a few lines to the /mod/tmp/flexview.log but the vast
majority of output is written to the browser console log viewable by
pressing F12 on a web page.

== Under the covers ==
FlexView is based on the jqgrid jquery plugin.
The directory and file information is delivered in JSON format with the
majority of the formatting taking place in the browser

== Change History ==
{|border=2
| '''Date'''||'''Version'''||'''Description'''
|-
|2016-03-21 ||flexview 0.1.1-0 || Initial public version
|-
|2025-03-08 ||flexview 0.1.2 || Bug fixes, filtering now dynamic
|}

== Future Enhancements ==
Possible future enhancements - please suggest more
* Include TVDB information
* Drag and drop for moving recordings
* Multiselect filters
* Save filters/sort in configuration
* ...

== Acknowledgements ==
;af123:For providing the icon and changes to webif needed to enable FlexView to work.
;prpr:For bug fixes and assisance
;guriddo:jqgrid plugin http://guriddo.net
;everbody else:Who has assisted through the forums

FlexView

2025-03-28T15:40:09Z

MymsMan: /* How To */

[[file:Flexview.png|left||Icon]]
= FlexView - A flexible way to manage your recordings =
== Overview ==
FlexView is intended to offer an alternative to the traditional webif to
allow you to view an manage your recording inventory in whatever way suits
you.

__TOC__

As the name suggests the emphasis is on maximum flexibility, you can:
* Choose the which pieces of information are displayed.
* Choose the display order
* Change the display size.
* Change the display format (more flexibility to come)
* Sort and filter on nearly all attributes
* Allow table to grow to accommodate data or fix table size
* Hide the directory tree
* Refresh individual folder
* Display multiple folders simultaneously
* Save your preferred display options for re-use
* Switch between saved formats
* Use all of the Browse context menu commands (plus a few more)

FlexView does not change the contents of your disk (unlike FlatView) so it
does not change the on TV, using remote control, view of recordings

== Usage scenarios ==
[[file:FVex1.jpg|Fixed size table, single directory (Movies) selected]]

Fixed size table, single directory (Movies) selected, showing tooltip

[[file:FVex2.jpg|Default configuration with ABC directory and sub-folders selected]]

Default configuration with ABC directory and sub-folders selected

[[file:FVex3.jpg|Directory tree hidden, using Column Chooser to add thumbnail image column ]]

Directory tree hidden, using Column Chooser to add thumbnail image column

[[file:FVex4.jpg|]File list with thumbnails shown and filtered to show only New (unwatched) files]]

File list with thumbnails shown and filtered to show only New (unwatched) files

== How To ==
;Resize columns
:Hover over line between column headers until resize handle appears, drag handle to resize column
;Move columns
:Drag column header to desired position or use column chooser dialog to move columns
;Sort columns
:Click on column header, click again to reverse sort directions
;Filter columns
:Use the filter toolbar beneath the column header
:Many columns display a pull down list to select options
:Other columns allow for text entry, the comparison operator can be changed by clicking on the operator to the left of the entry field.
:If filtering on file size enter the number in bytes e.g. 1000000 for 1 MB
:If filtering on directory size enter the number in kilobytes e.g. 1000 for 1 MB
:If filtering on time fields (duration, scheduled duration or resume point) enter the number in seconds e.g. 600 for 10 Mins, 3600 for 1 Hour
:If filtering of date-time fields use the Date Picker or enter the date in dd mon yy hh:mm format e.g. 02 Feb 25 22:00
;Save configuration
:Adjust visible columns, size & positions as desired, select directories to be displayed, Click Save button and type name for the configuration.
:Note. You can overwrite the supplied configurations but this is not recommended.
;Restore supplied configuration
:If you delete or make unwanted changes to supplied configurations
:Delete unwanted configurations (Load button) and then force reinstall the flexview package on Diag panel

== Installation ==
FlexView is in the "development and advanced packages" section of the
catalogue so to see and install the package select "Show development and
advanced packages?" in the "Advanced settings" section of the Settings
page.

== Settings ==
None currently on Settings page.

New configurations are created by selecting directories to be expanded
and/or displayed in the tree view and by changing column display options
then using the Save button to save the new configuration.

Saved configurations are saved in /mod/etc/fvConfiq_name.json they can be
editted, with care, to adjust configuration values
that can't currently be changed via the UI.

== Limitations ==
* TVDB information is not shown.
* MP3/MP4/JPEG attributes are not shown
* No interface for changing date formats and some other parameters.

== Debugging ==
FlexView writes a few lines to the /mod/tmp/flexview.log but the vast
majority of output is written to the browser console log viewable by
pressing F12 on a web page.

== Under the covers ==
FlexView is based on the jqgrid jquery plugin.
The directory and file information is delivered in JSON format with the
majority of the formatting taking place in the browser

== Change History ==
{|border=2
| '''Date'''||'''Version'''||'''Description'''
|-
|2016-03-21 ||flexview 0.1.1-0 || Initial public version
|-
|2025-03-08 ||flexview 0.1.2 || Bug fixes, filtering now dynamic
|}

== Future Enhancements ==
Possible future enhancements - please suggest more
* Include TVDB information
* Drag and drop for moving recordings
* Multiselect filters
* Save filters/sort in configuration
* ...

== Acknowledgements ==
;af123:For providing the icon and changes to webif needed to enable FlexView to work.
;guriddo:jqgrid plugin http://guriddo.net
;everbody else:Who has assisted through the forums

FlexView

2025-03-28T15:27:28Z

MymsMan: /* How To */

[[file:Flexview.png|left||Icon]]
= FlexView - A flexible way to manage your recordings =
== Overview ==
FlexView is intended to offer an alternative to the traditional webif to
allow you to view an manage your recording inventory in whatever way suits
you.

__TOC__

As the name suggests the emphasis is on maximum flexibility, you can:
* Choose the which pieces of information are displayed.
* Choose the display order
* Change the display size.
* Change the display format (more flexibility to come)
* Sort and filter on nearly all attributes
* Allow table to grow to accommodate data or fix table size
* Hide the directory tree
* Refresh individual folder
* Display multiple folders simultaneously
* Save your preferred display options for re-use
* Switch between saved formats
* Use all of the Browse context menu commands (plus a few more)

FlexView does not change the contents of your disk (unlike FlatView) so it
does not change the on TV, using remote control, view of recordings

== Usage scenarios ==
[[file:FVex1.jpg|Fixed size table, single directory (Movies) selected]]

Fixed size table, single directory (Movies) selected, showing tooltip

[[file:FVex2.jpg|Default configuration with ABC directory and sub-folders selected]]

Default configuration with ABC directory and sub-folders selected

[[file:FVex3.jpg|Directory tree hidden, using Column Chooser to add thumbnail image column ]]

Directory tree hidden, using Column Chooser to add thumbnail image column

[[file:FVex4.jpg|]File list with thumbnails shown and filtered to show only New (unwatched) files]]

File list with thumbnails shown and filtered to show only New (unwatched) files

== How To ==
;Resize columns
:Hover over line between column headers until resize handle appears, drag handle to resize column
;Move columns
:Drag column header to desired position or use column chooser dialog to move columns
;Sort columns
:Click on column header, click again to reverse sort directions
;Filter columns
:Use the filter toolbar beneath the column header
:Many columns display a pull down list to select options
:Other columns allow for text entry, the comparison operator can be changed by clicking on the operator to the left of the entry field.
:If filtering of file or directory size enter the number in bytes e.g. 1000000 for 1 MiB
:If filtering on duration, scheduled duration or resume point enter the number in seconds e.g. 600 for 10 Mins
:If filtering of date fields use the Date Picker or enter the date in dd mon yy hh:mm format
;Save configuration
:Adjust visible columns, size & positions as desired, select directories to be displayed, Click Save button and type name for the configuration.
:Note. You can overwrite the supplied configurations but this is not recommended.
;Restore supplied configuration
:If you delete or make unwanted changes to supplied configurations
:Delete unwanted configurations (Load button) and then force reinstall the flexview package on Diag panel

== Installation ==
FlexView is in the "development and advanced packages" section of the
catalogue so to see and install the package select "Show development and
advanced packages?" in the "Advanced settings" section of the Settings
page.

== Settings ==
None currently on Settings page.

New configurations are created by selecting directories to be expanded
and/or displayed in the tree view and by changing column display options
then using the Save button to save the new configuration.

Saved configurations are saved in /mod/etc/fvConfiq_name.json they can be
editted, with care, to adjust configuration values
that can't currently be changed via the UI.

== Limitations ==
* TVDB information is not shown.
* MP3/MP4/JPEG attributes are not shown
* No interface for changing date formats and some other parameters.

== Debugging ==
FlexView writes a few lines to the /mod/tmp/flexview.log but the vast
majority of output is written to the browser console log viewable by
pressing F12 on a web page.

== Under the covers ==
FlexView is based on the jqgrid jquery plugin.
The directory and file information is delivered in JSON format with the
majority of the formatting taking place in the browser

== Change History ==
{|border=2
| '''Date'''||'''Version'''||'''Description'''
|-
|2016-03-21 ||flexview 0.1.1-0 || Initial public version
|-
|2025-03-08 ||flexview 0.1.2 || Bug fixes, filtering now dynamic
|}

== Future Enhancements ==
Possible future enhancements - please suggest more
* Include TVDB information
* Drag and drop for moving recordings
* Multiselect filters
* Save filters/sort in configuration
* ...

== Acknowledgements ==
;af123:For providing the icon and changes to webif needed to enable FlexView to work.
;guriddo:jqgrid plugin http://guriddo.net
;everbody else:Who has assisted through the forums

FlexView

2025-03-08T15:33:25Z

MymsMan: /* Settings */

[[file:Flexview.png|left||Icon]]
= FlexView - A flexible way to manage your recordings =
== Overview ==
FlexView is intended to offer an alternative to the traditional webif to
allow you to view an manage your recording inventory in whatever way suits
you.

__TOC__

As the name suggests the emphasis is on maximum flexibility, you can:
* Choose the which pieces of information are displayed.
* Choose the display order
* Change the display size.
* Change the display format (more flexibility to come)
* Sort and filter on nearly all attributes
* Allow table to grow to accommodate data or fix table size
* Hide the directory tree
* Refresh individual folder
* Display multiple folders simultaneously
* Save your preferred display options for re-use
* Switch between saved formats
* Use all of the Browse context menu commands (plus a few more)

FlexView does not change the contents of your disk (unlike FlatView) so it
does not change the on TV, using remote control, view of recordings

== Usage scenarios ==
[[file:FVex1.jpg|Fixed size table, single directory (Movies) selected]]

Fixed size table, single directory (Movies) selected, showing tooltip

[[file:FVex2.jpg|Default configuration with ABC directory and sub-folders selected]]

Default configuration with ABC directory and sub-folders selected

[[file:FVex3.jpg|Directory tree hidden, using Column Chooser to add thumbnail image column ]]

Directory tree hidden, using Column Chooser to add thumbnail image column

[[file:FVex4.jpg|]File list with thumbnails shown and filtered to show only New (unwatched) files]]

File list with thumbnails shown and filtered to show only New (unwatched) files

== How To ==
;Resize columns
:Hover over line between column headers until resize handle appears, drag handle to resize column
;Move columns
:Drag column header to desired position or use column chooser dialog to move columns
;Sort columns
:Click on column header, click again to reverse sort directions
;Filter columns
:Use the filter toolbar beneath the column header
:Many columns display a pull down list to select options
:Other columns allow for text entry, the comparison operator can be changed by clicking on the operator to the left of the entry field.
:If filtering of file size enter the number in bytes e.g. 1000000 for 1 MiB
;Save configuration
:Adjust visible columns, size & positions as desired, select directories to be displayed, Click Save button and type name for the configuration.
:Note. You can overwrite the supplied configurations but this is not recommended.
;Restore supplied configuration
:If you delete or make unwanted changes to supplied configurations
:Delete unwanted configurations (Load button) and then force reinstall the flexview package on Diag panel
== Installation ==
FlexView is in the "development and advanced packages" section of the
catalogue so to see and install the package select "Show development and
advanced packages?" in the "Advanced settings" section of the Settings
page.

== Settings ==
None currently on Settings page.

New configurations are created by selecting directories to be expanded
and/or displayed in the tree view and by changing column display options
then using the Save button to save the new configuration.

Saved configurations are saved in /mod/etc/fvConfiq_name.json they can be
editted, with care, to adjust configuration values
that can't currently be changed via the UI.

== Limitations ==
* TVDB information is not shown.
* MP3/MP4/JPEG attributes are not shown
* No interface for changing date formats and some other parameters.

== Debugging ==
FlexView writes a few lines to the /mod/tmp/flexview.log but the vast
majority of output is written to the browser console log viewable by
pressing F12 on a web page.

== Under the covers ==
FlexView is based on the jqgrid jquery plugin.
The directory and file information is delivered in JSON format with the
majority of the formatting taking place in the browser

== Change History ==
{|border=2
| '''Date'''||'''Version'''||'''Description'''
|-
|2016-03-21 ||flexview 0.1.1-0 || Initial public version
|-
|2025-03-08 ||flexview 0.1.2 || Bug fixes, filtering now dynamic
|}

== Future Enhancements ==
Possible future enhancements - please suggest more
* Include TVDB information
* Drag and drop for moving recordings
* Multiselect filters
* Save filters/sort in configuration
* ...

== Acknowledgements ==
;af123:For providing the icon and changes to webif needed to enable FlexView to work.
;guriddo:jqgrid plugin http://guriddo.net
;everbody else:Who has assisted through the forums

FlexView

2025-03-08T15:32:23Z

MymsMan: /* Change History */

[[file:Flexview.png|left||Icon]]
= FlexView - A flexible way to manage your recordings =
== Overview ==
FlexView is intended to offer an alternative to the traditional webif to
allow you to view an manage your recording inventory in whatever way suits
you.

__TOC__

As the name suggests the emphasis is on maximum flexibility, you can:
* Choose the which pieces of information are displayed.
* Choose the display order
* Change the display size.
* Change the display format (more flexibility to come)
* Sort and filter on nearly all attributes
* Allow table to grow to accommodate data or fix table size
* Hide the directory tree
* Refresh individual folder
* Display multiple folders simultaneously
* Save your preferred display options for re-use
* Switch between saved formats
* Use all of the Browse context menu commands (plus a few more)

FlexView does not change the contents of your disk (unlike FlatView) so it
does not change the on TV, using remote control, view of recordings

== Usage scenarios ==
[[file:FVex1.jpg|Fixed size table, single directory (Movies) selected]]

Fixed size table, single directory (Movies) selected, showing tooltip

[[file:FVex2.jpg|Default configuration with ABC directory and sub-folders selected]]

Default configuration with ABC directory and sub-folders selected

[[file:FVex3.jpg|Directory tree hidden, using Column Chooser to add thumbnail image column ]]

Directory tree hidden, using Column Chooser to add thumbnail image column

[[file:FVex4.jpg|]File list with thumbnails shown and filtered to show only New (unwatched) files]]

File list with thumbnails shown and filtered to show only New (unwatched) files

== How To ==
;Resize columns
:Hover over line between column headers until resize handle appears, drag handle to resize column
;Move columns
:Drag column header to desired position or use column chooser dialog to move columns
;Sort columns
:Click on column header, click again to reverse sort directions
;Filter columns
:Use the filter toolbar beneath the column header
:Many columns display a pull down list to select options
:Other columns allow for text entry, the comparison operator can be changed by clicking on the operator to the left of the entry field.
:If filtering of file size enter the number in bytes e.g. 1000000 for 1 MiB
;Save configuration
:Adjust visible columns, size & positions as desired, select directories to be displayed, Click Save button and type name for the configuration.
:Note. You can overwrite the supplied configurations but this is not recommended.
;Restore supplied configuration
:If you delete or make unwanted changes to supplied configurations
:Delete unwanted configurations (Load button) and then force reinstall the flexview package on Diag panel
== Installation ==
FlexView is in the "development and advanced packages" section of the
catalogue so to see and install the package select "Show development and
advanced packages?" in the "Advanced settings" section of the Settings
page.

== Settings ==
None currently on Settings page.

New configurations are created by selecting directories to be expanded
and/or displayed in the tree view and by changing column display options
then using the Save button to save the new configuration.

Saved configurations are saved in /mod/etc/fvConfiq_name.json they can be
editted, with care, to adjust configuration values such as date formats
that can't currently be changed via the UI.

== Limitations ==
* TVDB information is not shown.
* MP3/MP4/JPEG attributes are not shown
* No interface for changing date formats and some other parameters.

== Debugging ==
FlexView writes a few lines to the /mod/tmp/flexview.log but the vast
majority of output is written to the browser console log viewable by
pressing F12 on a web page.

== Under the covers ==
FlexView is based on the jqgrid jquery plugin.
The directory and file information is delivered in JSON format with the
majority of the formatting taking place in the browser

== Change History ==
{|border=2
| '''Date'''||'''Version'''||'''Description'''
|-
|2016-03-21 ||flexview 0.1.1-0 || Initial public version
|-
|2025-03-08 ||flexview 0.1.2 || Bug fixes, filtering now dynamic
|}

== Future Enhancements ==
Possible future enhancements - please suggest more
* Include TVDB information
* Drag and drop for moving recordings
* Multiselect filters
* Save filters/sort in configuration
* ...

== Acknowledgements ==
;af123:For providing the icon and changes to webif needed to enable FlexView to work.
;guriddo:jqgrid plugin http://guriddo.net
;everbody else:Who has assisted through the forums

Schedchk

2020-06-16T10:27:49Z

MymsMan: /* Change history */

= [[File:Schedchk48.png|left]]Schedchk - Check and fix the Humax recording schedule =
== Introduction ==
While it is "only telly" it can be extremely annoying when we find that a programme we had scheduled to record fails to record correctly.
Some failures can be attributed to user errors but a considerable numbers of problems are attributable to the broadcasters and problems in the Humax software not anticipating the ever more creative ways the broadcasters find to make life complicated!

The origins of schedchk go back several years to a [https://hummy.tv/forum/threads/schedchk-auto-fix-schedule-changes-a-proposal.7988 forum post]where I proposed the idea of automatically detecting when programmes were delayed or moved to another channel (e.g. BBC One -> BBC Two) because of overrunning sporting events or breaking news events. Nothing much happened at that time since Wimbledon only last two weeks and other last minute programme changes are by their nature unpredictable making testing difficult.

However now we live in Interesting Times and the unpredictable has become routine, every day the BBC1 showing of Pointless is moved to BBC2 to make way for the Corona Virus Daily Update. One might think that after this long the BBC would take the hint and schedule Pointless on BBC2 but no they persist in scheduling it on BBC1 and only update the schedules 3-72 hours in advance!
Since Pointless is one of our favourite shows I was provoked into resurrecting the Schedchk idea and finally it is now ready for a wider audience though there may still be a few rough edges.

[[File:Schedchk-rts.png|400px|frameless|right]]

The program relies on the EPG being kept up-to-date to allow it to find alternative showings of programmes and, especially with last minute changes, that can't be relied upon and sometimes there are no alternate showings so it will not be infallible but hopefully it will help you avoid some missed recordings,

To allow schedchk to promptly update the recording schedule it is important that Real-time scheduling is enabled via the Advanced Settings section of the Settings page

I have found several different categories of potential errors in the schedule and these are listed below with examples of how they can occur and action schedchk takes when attempting to fix them.
__TOC__
== Schedule Check Categories ==
=== EPG changes ===
The most basic form of schedule change is when the broadcaster changes the start time, duration or scheduled episode (event-CRID change).
Usually the Humax is quite good at spotting these changes but sometimes it doesn't immediately.

Schedchk will resolve this type of error by updating the schedule entry with the new details.

Checking for this type of problem can be by-passed by specifying the -noEPGchg option in settings or on the command line

=== Missing EPG entry ===
[[File:Schedchk-duplicateepisode.png|600px|frameless|right|Duplicate episode]]
Sometimes the event-id associated with a programme changes and the Humax is not good at resolving these, on occasion it can get very confused resulting in it scheduling two episodes of the same series at the same time!

Changes to the event-id can occur when a programme is moved another channel (e.g. Pointless moving from BBC1→2), when a programme is added to the schedule (ITV assigned new event-ids to all programmes following the Queen's recent broadcasts), a different episode is scheduled (e.g, the duplicate example above) or if a programme is cancelled and replaced by something else.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead.
If there are no matches by event-CRID it will look for a programme of the same name scheduled for the same time in case the Broadcaster has changed event-id, event-CRID and series-CRID and scheduled an episode from a different series of the programme.
If duplicate episodes occur it will delete the episode that no longer appears in the EPG.

Checking for this type of problem can be by-passed by specifying the -noMissEPG option in settings or on the command line

=== Conflict resolution ===

Conflict arise when three of more programmes are scheduled to be recorded at the same time (Two or more on HD model).
This can arise if a user ignores conflict warnings when scheduling, when a news day's EPG data is loaded, or if the EPG changes.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead. When considering alternatives schedchk will attempt to find a match on a channel with the same definition (HD or SD) as the original but if there is no match it will consider matches on channels with a different definition.

Schedchk is quite simple minded in its approach to conflict resolution and will not always choose the best solution for your viewing needs. For complex conflicts or where you want to select which programmes you don't want delayed you should attempt to manually resolve conflicts using the Visual Schedule displays in the webif or RS before schedchk attempts automatic resolution.

At the moment Split recordings are not considered for conflict resolution.

Checking for this type of problem can be by-passed by specifying the -noConflict option in settings or on the command line

=== Unscheduled episodes ===

The Humax normally manges to automatically schedule new episodes of a series but can sometimes miss changes that happen in the middle of the scheduled sequence

Schedchk checks the EPG by series-CRID and adds any missing

Checking for this type of problem can be by-passed by specifying the -noUnsched option in settings or on the command line

=== series-CRID changes ===

Often broadcasters change the series-CRID of a long running programme causing the next episodes of the programme to be not recorded. Sometimes this is because it has switched to another series of the programme (as if we really care whether it is repeats from series 51 or 55) but other times there is no obvious reason for the change.

Schedchk handles this by looking by programme name for a new series with matching name in the same time slot on the same channel and scheduling a new series recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes with variable time slots such as the F1 Grand Prix races
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the series-CRID check is liable to consider the +1 series a new unscheduled series

Checking for this type of problem can be by-passed by specifying the -noSCRID option in settings or on the command line

=== One-off episodes of a series ===

Sometimes broadcasters schedule episodes of a series as 1-off programmes without a series-CRID. Often this is deliberate when filling in a gap in the schedule but other times it is the result of broadcaster incompetence! Recently, Pick broadcast several episodes of the Sherlock series as 1-off programmes 😥

Schedchk handles this by looking by programme name for a 1-off programme with matching name on the same channel and scheduling a recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the 1-off check is liable to search the +1 channel

Checking for this type of problem can be by-passed by specifying the -no1off option in settings or on the command line

=== Not Recording ===

Occasionally a programme fails to start recording. This can be due to an unresolved conflict, overrunning programmes, last minute schedule changes etc. but some failures are unexplained.

When a programme is due to be recording schedchk checks whether there is a file for the recording and whether it is growing in size. If the programme is not recording it searches by event-CRID for an alternative showing and, if a suitable alternate is found, schedules it as a 1-off recording.

Since some late starting is normal the checking starts a short while after the scheduled start. By default this is 300 seconds (5 minutes) but this can be modified by specifying the -recWait option in settings or on the command line

Checking for this type of problem can be by-passed by specifying the -noNotRec option in settings or on the command line

Note: Since active recording schedule entries are deleted on Humax start-up schedchk can't schedule alternates for recordings truncated by a power failure or Humax crash 😥.

=== Split Recordings ===

Split recordings are where a long programme such as a film has a shorter programme, often a news bulletin, in the middle of the longer programme. While they may appear to be a 2-episode series they are not treated as such by the broadcasters or the Humax and have their own (very badly designed) set of rules which the Humax only partially implements.
Split recordings contain #number at the end of their event-CRID (eg /X4454865#01) and both halves of the split recording are required to have the same number, known as an IMI (Instance Metadata ID). The problem arises when the same film is repeated later in the week with exactly the same event-CRID and IMI, under the rules if there is more than three hours between them they should be treated as different programmes but the Humax treats them all as additional parts of the same programme.

This is a particular problem on channels such as Sony Movies which split most films into 2 parts and regularly repeat films up to three times a week. So you can attempt to schedule just one showing of a film but the Humax will schedule all six parts and some of the unwanted recordings can cause schedule conflicts.

Schedchk handles split recordings by leaving those with one or two parts schedule alone, if there are more than two parts scheduled it checks whether there is more than a 3-hour gap and whether there are any conflicts. The first, non-conflicting, showing is kept with a dummy IMI to prevent the Humax rescheduling and the other showings are removed from the schedule.

Checking for this type of problem can be by-passed by specifying the -noSplit option in settings or on the command line

== Other controls ==

=== Threshold ===

The Threshold setting (-thresh) controls how far into the schedule schedchk should look for problems. The default, unless changed in settings, is 36 hours which seems adequate for resolving potential problems.

You may wish to increase it on infrequently used machines.

=== No Auto ===

Normally schedchk runs as part of the regular Auto processing.
If you would prefer to run it on ad-hoc basis from a command line or set up your own [[Schedchk#Running via crontabs|schedule with crontabs]] you can specify No Auto in the Schedchk section of the settings page.

=== No Alerts ===

Schedchk generates webif warnings when it makes changes to the recording schedule to let you know what has happened.
[[File:Schedchk-alert.png|frame|center|Alert messages]]
If you would prefer not to receive these pop-up messages you can specify the -noAlert option in settings or on the command line.

Note: The example shows that sometimes broadcasters makes changes and then reverse them in short order.

=== Test Mode ===

If you specify the -test option no schedule changes will actually be made

=== In-place updating ===

If you use the visual schedule webif/RS pages to "Record this showing instead" it will generate a skip entry for the current episode and a one-off recording entry for the replacement episode. Schedchk uses a different approach and where possible updates the existing series entry with the new episode details.

The main advantages of this approach is that the recording will automatically go into the series folder and any folder related webif settings (auto-decrypt, shrink, detectads etc) will be applied as usual. You will only have one entry in the recording schedule rather than many and you won't have to move recordings from the My Videos folder.

[[File:Schedchk-inplace.png|800px||right]]
[[File:Schedchk-inplace2.png|800px||right]]
It can look a bit odd to have episodes from different channels in the same series but both webif and RS handle this correctly

Which of the channels will show as the 'main' channel for the series depends on the channel of the next scheduled episode

Minor disadvantages are:
* The Humax won't add new episodes while the 'wrong' channel is main (but Schedchk 'Unscheduled episodes' will add them instead)
* Schedchk 'SCRID change' and '1-off episodes' will check the alternate channel when it is main (more work needs to be done in this area)

If you would prefer more traditional skip and 1-off scheduling you can specify the -noAlert option in settings or on the command line.

=== Progress Messages ===

The -d option controls the level of mesages produced:
* 0 - Schedule changes and errors only (also displayed as webif notifications)
* 1 - Intermediate level
* 2 - Detailed progress messages

== Schedchk settings ==

Initially all schedchk processing options are enabled but the default settings can be overridden on the webif Settings page, any changes made here become the new defaults for schedchk.

More detail on each of the options is given in the sections above.

[[File:Schedchk-settingspage.png|frame|center|SchedChk Settings Page ]]

== Schedchk command line ==

As well as running automatically every few minutes as part of the regular Auto process you can also run schedchk on demand from a command line. Options specified on the command line override values set on the settings page for this invocation of schedchk only, they don't change the default values.

<pre>
schedchk = Check for recording schedule issues and attempt to fix them

schedchk -h = produce this help
schedchk -rsv = scan the recording schedule

Options Default (unless changed in Settings)
-thresh 36 = Don't check for problems more than x hrs away from start
-d 0 = Produce more detailed output
-test n = Don't make updates
-noAuto n = Don't run regularly as part of Auto-Processing
-noAlert n = Don't generate webif alert messages for changes made
-noConflict n = Don't check for conflicts
-noUnsched n = Don't check for episodes missing from schedule
-noSCRID n = Don't check for series CRID changes
-no1off n = Don't check for episodes scheduled as one off programmes
-noNotRec n = Don't check for failures to record
-recWait 300 = Don't assume recording failed until x seconds late starting
-noMissEPG n = Don't resolve missing epg entries
-noEPGchg n = Don't resolve epg time/ duration/ event crid changes
-noSplit n = Don't resolve repeated split recordings
-noInplace n = Update reservation by skipping & 1-off rather than inplace

Note: Options are not case sensitive
</pre>
-noAuto has no effect when specified as a command option, it needs to be set via the settings page.

== Running via crontabs ==

As an alternative to running schedchk as part of the standard customised firmware Auto processing it also possible to schedule schedchk to run at different intervals using the crontabs file.

You might want to do this if:
* You normally disable Auto processing during recordings but would still like to take advantage of Not Recording checks
* You want some checks made at a different frequency from others
* You want process messages written to a dedicated log file

You can edit the crontabs file via webif→Diag→File Editor→Commonly edited files→/mod/var/spool/cron/crontabs/root
[[File:Schedchk-crontabs.png|frame|center|Editing crontabs file]]
In the example above schedchk will run a Not Recording check every 4 minutes and check for SCRID changes and 1-off recordings every 4 hours at 17 minutes past the hour, output will be written to schedchk.log

[https://www.thegeekstuff.com/2009/06/15-practical-crontab-examples/ Guides to crontabs time formats are available online]

== fmtrsv - Format a rsv.db table entry ==
Fmtrsv is a simple command line utility created to help with displaying the contents of the rsv.db where schedule entries are stored. It is included with the schedchk package to help in gathering information for debugging purposes. Entries displayed can be filtered with a number of options
<pre>
# fmtrsv -h
fmtrsv = Formats schedule entries from the rsv.db

fmtrsv options
no options will list all reservations

Options
-h produce this help
-n,-name xxx = select recording name contains
-s,-slot n = select slot
-l,-lcn n = select channel number
-c,-cname xxx = select channel name contains
</pre>
Sample output
<pre>
# fmtrsv -s 16
ulslot = 16
ersvtype = 3 Recording
hsvc = 131097
nsttime = 1590429600 25/05/2020 19:00
szsttime = 00000000000000
nduration = 3600 01:00
erepeat = 0 no repeats
usevtid = 12270
szevtname = i7Code-Breakers: Bletchley Park's... (Code-Breakers: Bletchley Park's...)
ulPreOffset = 0
ulPostOffset = 0
ulProgramId = 0
ulSeriesId = 0
ucVolume = 0
ucInputMode = 0
usChNum = 0
ucRecKind = 4 series
ucCRIDType = 50 series
szCRID = FP.BBC.CO.UK/B-3P5L5
szFPBRecPath = Code-Breakers: Bletchley Park's...
szRecordedProgCrid = 1FP.BBC.CO.UK/B/KZSO7|
szEventToRecord = 1FP.BBC.CO.UK/B/KOEPL|
aulEventToRecordInfo = {131097 1590429600 1590433200 12270}
bRecomRsv = 0
usLastRecordedEvtId = 0
eReady = 30
szSvcName = BBC TWO
usLcn = 2
Svcid Start End Evtid CRID
131097 1590429600 25/05/2020 19:00 1590433200 25/05/2020 20:00 12270 1FP.BBC.CO.UK/B/KOEPL
Skiplist Svcid:Evtid
131097:12390
========================================================

</pre>
== Other Stuff ==
=== Change history ===
{|border=1,
| '''Date'''||'''Version'''||'''Author'''||'''Description'''
|-
|2020-06-05 ||schedchk 0.1.0|| mymsman || Intial Version
* All new!
|-
|2020-06-15 ||schedchk 0.1.1|| mymsman || Minor fixes
* Fixed problem with scrid change that stopped change to Cardinal series crid being recognized
* Check for gaps in EPG and don't reschedule programmes already scheduled in gap.
|}

=== Acknowledgements ===
;af123:For providing the cf framework that underlies everything and who's code I have copied and hacked.
;/df:For investigating the problems with Split recordings and writing the rsv set method
;everybody else:Who has assisted through the forums
=== Future Enhancements ===
* Detect and reschedule recordings active at time of crash
* Improve Series CRID change detection to reduce false positives

Schedchk

2020-06-09T11:54:24Z

MymsMan: /* Split Recordings */

= [[File:Schedchk48.png|left]]Schedchk - Check and fix the Humax recording schedule =
== Introduction ==
While it is "only telly" it can be extremely annoying when we find that a programme we had scheduled to record fails to record correctly.
Some failures can be attributed to user errors but a considerable numbers of problems are attributable to the broadcasters and problems in the Humax software not anticipating the ever more creative ways the broadcasters find to make life complicated!

The origins of schedchk go back several years to a [https://hummy.tv/forum/threads/schedchk-auto-fix-schedule-changes-a-proposal.7988 forum post]where I proposed the idea of automatically detecting when programmes were delayed or moved to another channel (e.g. BBC One -> BBC Two) because of overrunning sporting events or breaking news events. Nothing much happened at that time since Wimbledon only last two weeks and other last minute programme changes are by their nature unpredictable making testing difficult.

However now we live in Interesting Times and the unpredictable has become routine, every day the BBC1 showing of Pointless is moved to BBC2 to make way for the Corona Virus Daily Update. One might think that after this long the BBC would take the hint and schedule Pointless on BBC2 but no they persist in scheduling it on BBC1 and only update the schedules 3-72 hours in advance!
Since Pointless is one of our favourite shows I was provoked into resurrecting the Schedchk idea and finally it is now ready for a wider audience though there may still be a few rough edges.

[[File:Schedchk-rts.png|400px|frameless|right]]

The program relies on the EPG being kept up-to-date to allow it to find alternative showings of programmes and, especially with last minute changes, that can't be relied upon and sometimes there are no alternate showings so it will not be infallible but hopefully it will help you avoid some missed recordings,

To allow schedchk to promptly update the recording schedule it is important that Real-time scheduling is enabled via the Advanced Settings section of the Settings page

I have found several different categories of potential errors in the schedule and these are listed below with examples of how they can occur and action schedchk takes when attempting to fix them.
__TOC__
== Schedule Check Categories ==
=== EPG changes ===
The most basic form of schedule change is when the broadcaster changes the start time, duration or scheduled episode (event-CRID change).
Usually the Humax is quite good at spotting these changes but sometimes it doesn't immediately.

Schedchk will resolve this type of error by updating the schedule entry with the new details.

Checking for this type of problem can be by-passed by specifying the -noEPGchg option in settings or on the command line

=== Missing EPG entry ===
[[File:Schedchk-duplicateepisode.png|600px|frameless|right|Duplicate episode]]
Sometimes the event-id associated with a programme changes and the Humax is not good at resolving these, on occasion it can get very confused resulting in it scheduling two episodes of the same series at the same time!

Changes to the event-id can occur when a programme is moved another channel (e.g. Pointless moving from BBC1→2), when a programme is added to the schedule (ITV assigned new event-ids to all programmes following the Queen's recent broadcasts), a different episode is scheduled (e.g, the duplicate example above) or if a programme is cancelled and replaced by something else.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead.
If there are no matches by event-CRID it will look for a programme of the same name scheduled for the same time in case the Broadcaster has changed event-id, event-CRID and series-CRID and scheduled an episode from a different series of the programme.
If duplicate episodes occur it will delete the episode that no longer appears in the EPG.

Checking for this type of problem can be by-passed by specifying the -noMissEPG option in settings or on the command line

=== Conflict resolution ===

Conflict arise when three of more programmes are scheduled to be recorded at the same time (Two or more on HD model).
This can arise if a user ignores conflict warnings when scheduling, when a news day's EPG data is loaded, or if the EPG changes.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead. When considering alternatives schedchk will attempt to find a match on a channel with the same definition (HD or SD) as the original but if there is no match it will consider matches on channels with a different definition.

Schedchk is quite simple minded in its approach to conflict resolution and will not always choose the best solution for your viewing needs. For complex conflicts or where you want to select which programmes you don't want delayed you should attempt to manually resolve conflicts using the Visual Schedule displays in the webif or RS before schedchk attempts automatic resolution.

At the moment Split recordings are not considered for conflict resolution.

Checking for this type of problem can be by-passed by specifying the -noConflict option in settings or on the command line

=== Unscheduled episodes ===

The Humax normally manges to automatically schedule new episodes of a series but can sometimes miss changes that happen in the middle of the scheduled sequence

Schedchk checks the EPG by series-CRID and adds any missing

Checking for this type of problem can be by-passed by specifying the -noUnsched option in settings or on the command line

=== series-CRID changes ===

Often broadcasters change the series-CRID of a long running programme causing the next episodes of the programme to be not recorded. Sometimes this is because it has switched to another series of the programme (as if we really care whether it is repeats from series 51 or 55) but other times there is no obvious reason for the change.

Schedchk handles this by looking by programme name for a new series with matching name in the same time slot on the same channel and scheduling a new series recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes with variable time slots such as the F1 Grand Prix races
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the series-CRID check is liable to consider the +1 series a new unscheduled series

Checking for this type of problem can be by-passed by specifying the -noSCRID option in settings or on the command line

=== One-off episodes of a series ===

Sometimes broadcasters schedule episodes of a series as 1-off programmes without a series-CRID. Often this is deliberate when filling in a gap in the schedule but other times it is the result of broadcaster incompetence! Recently, Pick broadcast several episodes of the Sherlock series as 1-off programmes 😥

Schedchk handles this by looking by programme name for a 1-off programme with matching name on the same channel and scheduling a recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the 1-off check is liable to search the +1 channel

Checking for this type of problem can be by-passed by specifying the -no1off option in settings or on the command line

=== Not Recording ===

Occasionally a programme fails to start recording. This can be due to an unresolved conflict, overrunning programmes, last minute schedule changes etc. but some failures are unexplained.

When a programme is due to be recording schedchk checks whether there is a file for the recording and whether it is growing in size. If the programme is not recording it searches by event-CRID for an alternative showing and, if a suitable alternate is found, schedules it as a 1-off recording.

Since some late starting is normal the checking starts a short while after the scheduled start. By default this is 300 seconds (5 minutes) but this can be modified by specifying the -recWait option in settings or on the command line

Checking for this type of problem can be by-passed by specifying the -noNotRec option in settings or on the command line

Note: Since active recording schedule entries are deleted on Humax start-up schedchk can't schedule alternates for recordings truncated by a power failure or Humax crash 😥.

=== Split Recordings ===

Split recordings are where a long programme such as a film has a shorter programme, often a news bulletin, in the middle of the longer programme. While they may appear to be a 2-episode series they are not treated as such by the broadcasters or the Humax and have their own (very badly designed) set of rules which the Humax only partially implements.
Split recordings contain #number at the end of their event-CRID (eg /X4454865#01) and both halves of the split recording are required to have the same number, known as an IMI (Instance Metadata ID). The problem arises when the same film is repeated later in the week with exactly the same event-CRID and IMI, under the rules if there is more than three hours between them they should be treated as different programmes but the Humax treats them all as additional parts of the same programme.

This is a particular problem on channels such as Sony Movies which split most films into 2 parts and regularly repeat films up to three times a week. So you can attempt to schedule just one showing of a film but the Humax will schedule all six parts and some of the unwanted recordings can cause schedule conflicts.

Schedchk handles split recordings by leaving those with one or two parts schedule alone, if there are more than two parts scheduled it checks whether there is more than a 3-hour gap and whether there are any conflicts. The first, non-conflicting, showing is kept with a dummy IMI to prevent the Humax rescheduling and the other showings are removed from the schedule.

Checking for this type of problem can be by-passed by specifying the -noSplit option in settings or on the command line

== Other controls ==

=== Threshold ===

The Threshold setting (-thresh) controls how far into the schedule schedchk should look for problems. The default, unless changed in settings, is 36 hours which seems adequate for resolving potential problems.

You may wish to increase it on infrequently used machines.

=== No Auto ===

Normally schedchk runs as part of the regular Auto processing.
If you would prefer to run it on ad-hoc basis from a command line or set up your own [[Schedchk#Running via crontabs|schedule with crontabs]] you can specify No Auto in the Schedchk section of the settings page.

=== No Alerts ===

Schedchk generates webif warnings when it makes changes to the recording schedule to let you know what has happened.
[[File:Schedchk-alert.png|frame|center|Alert messages]]
If you would prefer not to receive these pop-up messages you can specify the -noAlert option in settings or on the command line.

Note: The example shows that sometimes broadcasters makes changes and then reverse them in short order.

=== Test Mode ===

If you specify the -test option no schedule changes will actually be made

=== In-place updating ===

If you use the visual schedule webif/RS pages to "Record this showing instead" it will generate a skip entry for the current episode and a one-off recording entry for the replacement episode. Schedchk uses a different approach and where possible updates the existing series entry with the new episode details.

The main advantages of this approach is that the recording will automatically go into the series folder and any folder related webif settings (auto-decrypt, shrink, detectads etc) will be applied as usual. You will only have one entry in the recording schedule rather than many and you won't have to move recordings from the My Videos folder.

[[File:Schedchk-inplace.png|800px||right]]
[[File:Schedchk-inplace2.png|800px||right]]
It can look a bit odd to have episodes from different channels in the same series but both webif and RS handle this correctly

Which of the channels will show as the 'main' channel for the series depends on the channel of the next scheduled episode

Minor disadvantages are:
* The Humax won't add new episodes while the 'wrong' channel is main (but Schedchk 'Unscheduled episodes' will add them instead)
* Schedchk 'SCRID change' and '1-off episodes' will check the alternate channel when it is main (more work needs to be done in this area)

If you would prefer more traditional skip and 1-off scheduling you can specify the -noAlert option in settings or on the command line.

=== Progress Messages ===

The -d option controls the level of mesages produced:
* 0 - Schedule changes and errors only (also displayed as webif notifications)
* 1 - Intermediate level
* 2 - Detailed progress messages

== Schedchk settings ==

Initially all schedchk processing options are enabled but the default settings can be overridden on the webif Settings page, any changes made here become the new defaults for schedchk.

More detail on each of the options is given in the sections above.

[[File:Schedchk-settingspage.png|frame|center|SchedChk Settings Page ]]

== Schedchk command line ==

As well as running automatically every few minutes as part of the regular Auto process you can also run schedchk on demand from a command line. Options specified on the command line override values set on the settings page for this invocation of schedchk only, they don't change the default values.

<pre>
schedchk = Check for recording schedule issues and attempt to fix them

schedchk -h = produce this help
schedchk -rsv = scan the recording schedule

Options Default (unless changed in Settings)
-thresh 36 = Don't check for problems more than x hrs away from start
-d 0 = Produce more detailed output
-test n = Don't make updates
-noAuto n = Don't run regularly as part of Auto-Processing
-noAlert n = Don't generate webif alert messages for changes made
-noConflict n = Don't check for conflicts
-noUnsched n = Don't check for episodes missing from schedule
-noSCRID n = Don't check for series CRID changes
-no1off n = Don't check for episodes scheduled as one off programmes
-noNotRec n = Don't check for failures to record
-recWait 300 = Don't assume recording failed until x seconds late starting
-noMissEPG n = Don't resolve missing epg entries
-noEPGchg n = Don't resolve epg time/ duration/ event crid changes
-noSplit n = Don't resolve repeated split recordings
-noInplace n = Update reservation by skipping & 1-off rather than inplace

Note: Options are not case sensitive
</pre>
-noAuto has no effect when specified as a command option, it needs to be set via the settings page.

== Running via crontabs ==

As an alternative to running schedchk as part of the standard customised firmware Auto processing it also possible to schedule schedchk to run at different intervals using the crontabs file.

You might want to do this if:
* You normally disable Auto processing during recordings but would still like to take advantage of Not Recording checks
* You want some checks made at a different frequency from others
* You want process messages written to a dedicated log file

You can edit the crontabs file via webif→Diag→File Editor→Commonly edited files→/mod/var/spool/cron/crontabs/root
[[File:Schedchk-crontabs.png|frame|center|Editing crontabs file]]
In the example above schedchk will run a Not Recording check every 4 minutes and check for SCRID changes and 1-off recordings every 4 hours at 17 minutes past the hour, output will be written to schedchk.log

[https://www.thegeekstuff.com/2009/06/15-practical-crontab-examples/ Guides to crontabs time formats are available online]

== fmtrsv - Format a rsv.db table entry ==
Fmtrsv is a simple command line utility created to help with displaying the contents of the rsv.db where schedule entries are stored. It is included with the schedchk package to help in gathering information for debugging purposes. Entries displayed can be filtered with a number of options
<pre>
# fmtrsv -h
fmtrsv = Formats schedule entries from the rsv.db

fmtrsv options
no options will list all reservations

Options
-h produce this help
-n,-name xxx = select recording name contains
-s,-slot n = select slot
-l,-lcn n = select channel number
-c,-cname xxx = select channel name contains
</pre>
Sample output
<pre>
# fmtrsv -s 16
ulslot = 16
ersvtype = 3 Recording
hsvc = 131097
nsttime = 1590429600 25/05/2020 19:00
szsttime = 00000000000000
nduration = 3600 01:00
erepeat = 0 no repeats
usevtid = 12270
szevtname = i7Code-Breakers: Bletchley Park's... (Code-Breakers: Bletchley Park's...)
ulPreOffset = 0
ulPostOffset = 0
ulProgramId = 0
ulSeriesId = 0
ucVolume = 0
ucInputMode = 0
usChNum = 0
ucRecKind = 4 series
ucCRIDType = 50 series
szCRID = FP.BBC.CO.UK/B-3P5L5
szFPBRecPath = Code-Breakers: Bletchley Park's...
szRecordedProgCrid = 1FP.BBC.CO.UK/B/KZSO7|
szEventToRecord = 1FP.BBC.CO.UK/B/KOEPL|
aulEventToRecordInfo = {131097 1590429600 1590433200 12270}
bRecomRsv = 0
usLastRecordedEvtId = 0
eReady = 30
szSvcName = BBC TWO
usLcn = 2
Svcid Start End Evtid CRID
131097 1590429600 25/05/2020 19:00 1590433200 25/05/2020 20:00 12270 1FP.BBC.CO.UK/B/KOEPL
Skiplist Svcid:Evtid
131097:12390
========================================================

</pre>
== Other Stuff ==
=== Change history ===
{|border=1,
| '''Date'''||'''Version'''||'''Author'''||'''Description'''
|-
|2020-06-05 ||schedchk 0.1.0|| mymsman || Intial Version
* All new!
|}
=== Acknowledgements ===
;af123:For providing the cf framework that underlies everything and who's code I have copied and hacked.
;/df:For investigating the problems with Split recordings and writing the rsv set method
;everybody else:Who has assisted through the forums
=== Future Enhancements ===
* Detect and reschedule recordings active at time of crash
* Improve Series CRID change detection to reduce false positives

Schedchk

2020-06-09T11:24:45Z

MymsMan: /* Running via crontabs */

= [[File:Schedchk48.png|left]]Schedchk - Check and fix the Humax recording schedule =
== Introduction ==
While it is "only telly" it can be extremely annoying when we find that a programme we had scheduled to record fails to record correctly.
Some failures can be attributed to user errors but a considerable numbers of problems are attributable to the broadcasters and problems in the Humax software not anticipating the ever more creative ways the broadcasters find to make life complicated!

The origins of schedchk go back several years to a [https://hummy.tv/forum/threads/schedchk-auto-fix-schedule-changes-a-proposal.7988 forum post]where I proposed the idea of automatically detecting when programmes were delayed or moved to another channel (e.g. BBC One -> BBC Two) because of overrunning sporting events or breaking news events. Nothing much happened at that time since Wimbledon only last two weeks and other last minute programme changes are by their nature unpredictable making testing difficult.

However now we live in Interesting Times and the unpredictable has become routine, every day the BBC1 showing of Pointless is moved to BBC2 to make way for the Corona Virus Daily Update. One might think that after this long the BBC would take the hint and schedule Pointless on BBC2 but no they persist in scheduling it on BBC1 and only update the schedules 3-72 hours in advance!
Since Pointless is one of our favourite shows I was provoked into resurrecting the Schedchk idea and finally it is now ready for a wider audience though there may still be a few rough edges.

[[File:Schedchk-rts.png|400px|frameless|right]]

The program relies on the EPG being kept up-to-date to allow it to find alternative showings of programmes and, especially with last minute changes, that can't be relied upon and sometimes there are no alternate showings so it will not be infallible but hopefully it will help you avoid some missed recordings,

To allow schedchk to promptly update the recording schedule it is important that Real-time scheduling is enabled via the Advanced Settings section of the Settings page

I have found several different categories of potential errors in the schedule and these are listed below with examples of how they can occur and action schedchk takes when attempting to fix them.
__TOC__
== Schedule Check Categories ==
=== EPG changes ===
The most basic form of schedule change is when the broadcaster changes the start time, duration or scheduled episode (event-CRID change).
Usually the Humax is quite good at spotting these changes but sometimes it doesn't immediately.

Schedchk will resolve this type of error by updating the schedule entry with the new details.

Checking for this type of problem can be by-passed by specifying the -noEPGchg option in settings or on the command line

=== Missing EPG entry ===
[[File:Schedchk-duplicateepisode.png|600px|frameless|right|Duplicate episode]]
Sometimes the event-id associated with a programme changes and the Humax is not good at resolving these, on occasion it can get very confused resulting in it scheduling two episodes of the same series at the same time!

Changes to the event-id can occur when a programme is moved another channel (e.g. Pointless moving from BBC1→2), when a programme is added to the schedule (ITV assigned new event-ids to all programmes following the Queen's recent broadcasts), a different episode is scheduled (e.g, the duplicate example above) or if a programme is cancelled and replaced by something else.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead.
If there are no matches by event-CRID it will look for a programme of the same name scheduled for the same time in case the Broadcaster has changed event-id, event-CRID and series-CRID and scheduled an episode from a different series of the programme.
If duplicate episodes occur it will delete the episode that no longer appears in the EPG.

Checking for this type of problem can be by-passed by specifying the -noMissEPG option in settings or on the command line

=== Conflict resolution ===

Conflict arise when three of more programmes are scheduled to be recorded at the same time (Two or more on HD model).
This can arise if a user ignores conflict warnings when scheduling, when a news day's EPG data is loaded, or if the EPG changes.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead. When considering alternatives schedchk will attempt to find a match on a channel with the same definition (HD or SD) as the original but if there is no match it will consider matches on channels with a different definition.

Schedchk is quite simple minded in its approach to conflict resolution and will not always choose the best solution for your viewing needs. For complex conflicts or where you want to select which programmes you don't want delayed you should attempt to manually resolve conflicts using the Visual Schedule displays in the webif or RS before schedchk attempts automatic resolution.

At the moment Split recordings are not considered for conflict resolution.

Checking for this type of problem can be by-passed by specifying the -noConflict option in settings or on the command line

=== Unscheduled episodes ===

The Humax normally manges to automatically schedule new episodes of a series but can sometimes miss changes that happen in the middle of the scheduled sequence

Schedchk checks the EPG by series-CRID and adds any missing

Checking for this type of problem can be by-passed by specifying the -noUnsched option in settings or on the command line

=== series-CRID changes ===

Often broadcasters change the series-CRID of a long running programme causing the next episodes of the programme to be not recorded. Sometimes this is because it has switched to another series of the programme (as if we really care whether it is repeats from series 51 or 55) but other times there is no obvious reason for the change.

Schedchk handles this by looking by programme name for a new series with matching name in the same time slot on the same channel and scheduling a new series recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes with variable time slots such as the F1 Grand Prix races
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the series-CRID check is liable to consider the +1 series a new unscheduled series

Checking for this type of problem can be by-passed by specifying the -noSCRID option in settings or on the command line

=== One-off episodes of a series ===

Sometimes broadcasters schedule episodes of a series as 1-off programmes without a series-CRID. Often this is deliberate when filling in a gap in the schedule but other times it is the result of broadcaster incompetence! Recently, Pick broadcast several episodes of the Sherlock series as 1-off programmes 😥

Schedchk handles this by looking by programme name for a 1-off programme with matching name on the same channel and scheduling a recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the 1-off check is liable to search the +1 channel

Checking for this type of problem can be by-passed by specifying the -no1off option in settings or on the command line

=== Not Recording ===

Occasionally a programme fails to start recording. This can be due to an unresolved conflict, overrunning programmes, last minute schedule changes etc. but some failures are unexplained.

When a programme is due to be recording schedchk checks whether there is a file for the recording and whether it is growing in size. If the programme is not recording it searches by event-CRID for an alternative showing and, if a suitable alternate is found, schedules it as a 1-off recording.

Since some late starting is normal the checking starts a short while after the scheduled start. By default this is 300 seconds (5 minutes) but this can be modified by specifying the -recWait option in settings or on the command line

Checking for this type of problem can be by-passed by specifying the -noNotRec option in settings or on the command line

Note: Since active recording schedule entries are deleted on Humax start-up schedchk can't schedule alternates for recordings truncated by a power failure or Humax crash 😥.

=== Split Recordings ===

Split recordings are where a long programme such as a film has a shorter programme, often a news bulletin, in the middle of the longer programme. While they may appear to be a 2-epsidode series they are not treated as such by the broadcasters or the Humax and have their own (very badly designed) set of rules which the Humax only partially implements.
Split recordings contain #number at the end of their event-CRID (eg /X4454865#01) and both halves of the split recording are required to have the same number, known as an IMI (Instance Metadata ID). The problem arises when the same film is repeated later in the week with exactly the same event-CRID and IMI, under the rules if there is more than three hours between them they should be treated as different programmes but the Humax treats them all as additional parts of the same programme.

This is a particular problem on channels such as Sony Movies which split most films into 2 parts and regularly repeat films up to three times a week. So you can attempt to schedule just one showing of a film but the Humax will schedule all six parts and some of the unwanted recordings can cause schedule conflicts.

Schedchk handles split recordings by leaving those with one or two parts schedule alone, if there are more than two parts scheduled it checks whether there is more than a 3-hour gap and whether there are any conflicts. The first, non-conflicting, showing is kept with a dummy IMI to prevent the Humax rescheduling and the other showings are removed from the schedule.

Checking for this type of problem can be by-passed by specifying the -noSplit option in settings or on the command line

== Other controls ==

=== Threshold ===

The Threshold setting (-thresh) controls how far into the schedule schedchk should look for problems. The default, unless changed in settings, is 36 hours which seems adequate for resolving potential problems.

You may wish to increase it on infrequently used machines.

=== No Auto ===

Normally schedchk runs as part of the regular Auto processing.
If you would prefer to run it on ad-hoc basis from a command line or set up your own [[Schedchk#Running via crontabs|schedule with crontabs]] you can specify No Auto in the Schedchk section of the settings page.

=== No Alerts ===

Schedchk generates webif warnings when it makes changes to the recording schedule to let you know what has happened.
[[File:Schedchk-alert.png|frame|center|Alert messages]]
If you would prefer not to receive these pop-up messages you can specify the -noAlert option in settings or on the command line.

Note: The example shows that sometimes broadcasters makes changes and then reverse them in short order.

=== Test Mode ===

If you specify the -test option no schedule changes will actually be made

=== In-place updating ===

If you use the visual schedule webif/RS pages to "Record this showing instead" it will generate a skip entry for the current episode and a one-off recording entry for the replacement episode. Schedchk uses a different approach and where possible updates the existing series entry with the new episode details.

The main advantages of this approach is that the recording will automatically go into the series folder and any folder related webif settings (auto-decrypt, shrink, detectads etc) will be applied as usual. You will only have one entry in the recording schedule rather than many and you won't have to move recordings from the My Videos folder.

[[File:Schedchk-inplace.png|800px||right]]
[[File:Schedchk-inplace2.png|800px||right]]
It can look a bit odd to have episodes from different channels in the same series but both webif and RS handle this correctly

Which of the channels will show as the 'main' channel for the series depends on the channel of the next scheduled episode

Minor disadvantages are:
* The Humax won't add new episodes while the 'wrong' channel is main (but Schedchk 'Unscheduled episodes' will add them instead)
* Schedchk 'SCRID change' and '1-off episodes' will check the alternate channel when it is main (more work needs to be done in this area)

If you would prefer more traditional skip and 1-off scheduling you can specify the -noAlert option in settings or on the command line.

=== Progress Messages ===

The -d option controls the level of mesages produced:
* 0 - Schedule changes and errors only (also displayed as webif notifications)
* 1 - Intermediate level
* 2 - Detailed progress messages

== Schedchk settings ==

Initially all schedchk processing options are enabled but the default settings can be overridden on the webif Settings page, any changes made here become the new defaults for schedchk.

More detail on each of the options is given in the sections above.

[[File:Schedchk-settingspage.png|frame|center|SchedChk Settings Page ]]

== Schedchk command line ==

As well as running automatically every few minutes as part of the regular Auto process you can also run schedchk on demand from a command line. Options specified on the command line override values set on the settings page for this invocation of schedchk only, they don't change the default values.

<pre>
schedchk = Check for recording schedule issues and attempt to fix them

schedchk -h = produce this help
schedchk -rsv = scan the recording schedule

Options Default (unless changed in Settings)
-thresh 36 = Don't check for problems more than x hrs away from start
-d 0 = Produce more detailed output
-test n = Don't make updates
-noAuto n = Don't run regularly as part of Auto-Processing
-noAlert n = Don't generate webif alert messages for changes made
-noConflict n = Don't check for conflicts
-noUnsched n = Don't check for episodes missing from schedule
-noSCRID n = Don't check for series CRID changes
-no1off n = Don't check for episodes scheduled as one off programmes
-noNotRec n = Don't check for failures to record
-recWait 300 = Don't assume recording failed until x seconds late starting
-noMissEPG n = Don't resolve missing epg entries
-noEPGchg n = Don't resolve epg time/ duration/ event crid changes
-noSplit n = Don't resolve repeated split recordings
-noInplace n = Update reservation by skipping & 1-off rather than inplace

Note: Options are not case sensitive
</pre>
-noAuto has no effect when specified as a command option, it needs to be set via the settings page.

== Running via crontabs ==

As an alternative to running schedchk as part of the standard customised firmware Auto processing it also possible to schedule schedchk to run at different intervals using the crontabs file.

You might want to do this if:
* You normally disable Auto processing during recordings but would still like to take advantage of Not Recording checks
* You want some checks made at a different frequency from others
* You want process messages written to a dedicated log file

You can edit the crontabs file via webif→Diag→File Editor→Commonly edited files→/mod/var/spool/cron/crontabs/root
[[File:Schedchk-crontabs.png|frame|center|Editing crontabs file]]
In the example above schedchk will run a Not Recording check every 4 minutes and check for SCRID changes and 1-off recordings every 4 hours at 17 minutes past the hour, output will be written to schedchk.log

[https://www.thegeekstuff.com/2009/06/15-practical-crontab-examples/ Guides to crontabs time formats are available online]

== fmtrsv - Format a rsv.db table entry ==
Fmtrsv is a simple command line utility created to help with displaying the contents of the rsv.db where schedule entries are stored. It is included with the schedchk package to help in gathering information for debugging purposes. Entries displayed can be filtered with a number of options
<pre>
# fmtrsv -h
fmtrsv = Formats schedule entries from the rsv.db

fmtrsv options
no options will list all reservations

Options
-h produce this help
-n,-name xxx = select recording name contains
-s,-slot n = select slot
-l,-lcn n = select channel number
-c,-cname xxx = select channel name contains
</pre>
Sample output
<pre>
# fmtrsv -s 16
ulslot = 16
ersvtype = 3 Recording
hsvc = 131097
nsttime = 1590429600 25/05/2020 19:00
szsttime = 00000000000000
nduration = 3600 01:00
erepeat = 0 no repeats
usevtid = 12270
szevtname = i7Code-Breakers: Bletchley Park's... (Code-Breakers: Bletchley Park's...)
ulPreOffset = 0
ulPostOffset = 0
ulProgramId = 0
ulSeriesId = 0
ucVolume = 0
ucInputMode = 0
usChNum = 0
ucRecKind = 4 series
ucCRIDType = 50 series
szCRID = FP.BBC.CO.UK/B-3P5L5
szFPBRecPath = Code-Breakers: Bletchley Park's...
szRecordedProgCrid = 1FP.BBC.CO.UK/B/KZSO7|
szEventToRecord = 1FP.BBC.CO.UK/B/KOEPL|
aulEventToRecordInfo = {131097 1590429600 1590433200 12270}
bRecomRsv = 0
usLastRecordedEvtId = 0
eReady = 30
szSvcName = BBC TWO
usLcn = 2
Svcid Start End Evtid CRID
131097 1590429600 25/05/2020 19:00 1590433200 25/05/2020 20:00 12270 1FP.BBC.CO.UK/B/KOEPL
Skiplist Svcid:Evtid
131097:12390
========================================================

</pre>
== Other Stuff ==
=== Change history ===
{|border=1,
| '''Date'''||'''Version'''||'''Author'''||'''Description'''
|-
|2020-06-05 ||schedchk 0.1.0|| mymsman || Intial Version
* All new!
|}
=== Acknowledgements ===
;af123:For providing the cf framework that underlies everything and who's code I have copied and hacked.
;/df:For investigating the problems with Split recordings and writing the rsv set method
;everybody else:Who has assisted through the forums
=== Future Enhancements ===
* Detect and reschedule recordings active at time of crash
* Improve Series CRID change detection to reduce false positives

Schedchk

2020-06-09T11:22:25Z

MymsMan: /* Missing EPG entry */

= [[File:Schedchk48.png|left]]Schedchk - Check and fix the Humax recording schedule =
== Introduction ==
While it is "only telly" it can be extremely annoying when we find that a programme we had scheduled to record fails to record correctly.
Some failures can be attributed to user errors but a considerable numbers of problems are attributable to the broadcasters and problems in the Humax software not anticipating the ever more creative ways the broadcasters find to make life complicated!

The origins of schedchk go back several years to a [https://hummy.tv/forum/threads/schedchk-auto-fix-schedule-changes-a-proposal.7988 forum post]where I proposed the idea of automatically detecting when programmes were delayed or moved to another channel (e.g. BBC One -> BBC Two) because of overrunning sporting events or breaking news events. Nothing much happened at that time since Wimbledon only last two weeks and other last minute programme changes are by their nature unpredictable making testing difficult.

However now we live in Interesting Times and the unpredictable has become routine, every day the BBC1 showing of Pointless is moved to BBC2 to make way for the Corona Virus Daily Update. One might think that after this long the BBC would take the hint and schedule Pointless on BBC2 but no they persist in scheduling it on BBC1 and only update the schedules 3-72 hours in advance!
Since Pointless is one of our favourite shows I was provoked into resurrecting the Schedchk idea and finally it is now ready for a wider audience though there may still be a few rough edges.

[[File:Schedchk-rts.png|400px|frameless|right]]

The program relies on the EPG being kept up-to-date to allow it to find alternative showings of programmes and, especially with last minute changes, that can't be relied upon and sometimes there are no alternate showings so it will not be infallible but hopefully it will help you avoid some missed recordings,

To allow schedchk to promptly update the recording schedule it is important that Real-time scheduling is enabled via the Advanced Settings section of the Settings page

I have found several different categories of potential errors in the schedule and these are listed below with examples of how they can occur and action schedchk takes when attempting to fix them.
__TOC__
== Schedule Check Categories ==
=== EPG changes ===
The most basic form of schedule change is when the broadcaster changes the start time, duration or scheduled episode (event-CRID change).
Usually the Humax is quite good at spotting these changes but sometimes it doesn't immediately.

Schedchk will resolve this type of error by updating the schedule entry with the new details.

Checking for this type of problem can be by-passed by specifying the -noEPGchg option in settings or on the command line

=== Missing EPG entry ===
[[File:Schedchk-duplicateepisode.png|600px|frameless|right|Duplicate episode]]
Sometimes the event-id associated with a programme changes and the Humax is not good at resolving these, on occasion it can get very confused resulting in it scheduling two episodes of the same series at the same time!

Changes to the event-id can occur when a programme is moved another channel (e.g. Pointless moving from BBC1→2), when a programme is added to the schedule (ITV assigned new event-ids to all programmes following the Queen's recent broadcasts), a different episode is scheduled (e.g, the duplicate example above) or if a programme is cancelled and replaced by something else.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead.
If there are no matches by event-CRID it will look for a programme of the same name scheduled for the same time in case the Broadcaster has changed event-id, event-CRID and series-CRID and scheduled an episode from a different series of the programme.
If duplicate episodes occur it will delete the episode that no longer appears in the EPG.

Checking for this type of problem can be by-passed by specifying the -noMissEPG option in settings or on the command line

=== Conflict resolution ===

Conflict arise when three of more programmes are scheduled to be recorded at the same time (Two or more on HD model).
This can arise if a user ignores conflict warnings when scheduling, when a news day's EPG data is loaded, or if the EPG changes.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead. When considering alternatives schedchk will attempt to find a match on a channel with the same definition (HD or SD) as the original but if there is no match it will consider matches on channels with a different definition.

Schedchk is quite simple minded in its approach to conflict resolution and will not always choose the best solution for your viewing needs. For complex conflicts or where you want to select which programmes you don't want delayed you should attempt to manually resolve conflicts using the Visual Schedule displays in the webif or RS before schedchk attempts automatic resolution.

At the moment Split recordings are not considered for conflict resolution.

Checking for this type of problem can be by-passed by specifying the -noConflict option in settings or on the command line

=== Unscheduled episodes ===

The Humax normally manges to automatically schedule new episodes of a series but can sometimes miss changes that happen in the middle of the scheduled sequence

Schedchk checks the EPG by series-CRID and adds any missing

Checking for this type of problem can be by-passed by specifying the -noUnsched option in settings or on the command line

=== series-CRID changes ===

Often broadcasters change the series-CRID of a long running programme causing the next episodes of the programme to be not recorded. Sometimes this is because it has switched to another series of the programme (as if we really care whether it is repeats from series 51 or 55) but other times there is no obvious reason for the change.

Schedchk handles this by looking by programme name for a new series with matching name in the same time slot on the same channel and scheduling a new series recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes with variable time slots such as the F1 Grand Prix races
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the series-CRID check is liable to consider the +1 series a new unscheduled series

Checking for this type of problem can be by-passed by specifying the -noSCRID option in settings or on the command line

=== One-off episodes of a series ===

Sometimes broadcasters schedule episodes of a series as 1-off programmes without a series-CRID. Often this is deliberate when filling in a gap in the schedule but other times it is the result of broadcaster incompetence! Recently, Pick broadcast several episodes of the Sherlock series as 1-off programmes 😥

Schedchk handles this by looking by programme name for a 1-off programme with matching name on the same channel and scheduling a recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the 1-off check is liable to search the +1 channel

Checking for this type of problem can be by-passed by specifying the -no1off option in settings or on the command line

=== Not Recording ===

Occasionally a programme fails to start recording. This can be due to an unresolved conflict, overrunning programmes, last minute schedule changes etc. but some failures are unexplained.

When a programme is due to be recording schedchk checks whether there is a file for the recording and whether it is growing in size. If the programme is not recording it searches by event-CRID for an alternative showing and, if a suitable alternate is found, schedules it as a 1-off recording.

Since some late starting is normal the checking starts a short while after the scheduled start. By default this is 300 seconds (5 minutes) but this can be modified by specifying the -recWait option in settings or on the command line

Checking for this type of problem can be by-passed by specifying the -noNotRec option in settings or on the command line

Note: Since active recording schedule entries are deleted on Humax start-up schedchk can't schedule alternates for recordings truncated by a power failure or Humax crash 😥.

=== Split Recordings ===

Split recordings are where a long programme such as a film has a shorter programme, often a news bulletin, in the middle of the longer programme. While they may appear to be a 2-epsidode series they are not treated as such by the broadcasters or the Humax and have their own (very badly designed) set of rules which the Humax only partially implements.
Split recordings contain #number at the end of their event-CRID (eg /X4454865#01) and both halves of the split recording are required to have the same number, known as an IMI (Instance Metadata ID). The problem arises when the same film is repeated later in the week with exactly the same event-CRID and IMI, under the rules if there is more than three hours between them they should be treated as different programmes but the Humax treats them all as additional parts of the same programme.

This is a particular problem on channels such as Sony Movies which split most films into 2 parts and regularly repeat films up to three times a week. So you can attempt to schedule just one showing of a film but the Humax will schedule all six parts and some of the unwanted recordings can cause schedule conflicts.

Schedchk handles split recordings by leaving those with one or two parts schedule alone, if there are more than two parts scheduled it checks whether there is more than a 3-hour gap and whether there are any conflicts. The first, non-conflicting, showing is kept with a dummy IMI to prevent the Humax rescheduling and the other showings are removed from the schedule.

Checking for this type of problem can be by-passed by specifying the -noSplit option in settings or on the command line

== Other controls ==

=== Threshold ===

The Threshold setting (-thresh) controls how far into the schedule schedchk should look for problems. The default, unless changed in settings, is 36 hours which seems adequate for resolving potential problems.

You may wish to increase it on infrequently used machines.

=== No Auto ===

Normally schedchk runs as part of the regular Auto processing.
If you would prefer to run it on ad-hoc basis from a command line or set up your own [[Schedchk#Running via crontabs|schedule with crontabs]] you can specify No Auto in the Schedchk section of the settings page.

=== No Alerts ===

Schedchk generates webif warnings when it makes changes to the recording schedule to let you know what has happened.
[[File:Schedchk-alert.png|frame|center|Alert messages]]
If you would prefer not to receive these pop-up messages you can specify the -noAlert option in settings or on the command line.

Note: The example shows that sometimes broadcasters makes changes and then reverse them in short order.

=== Test Mode ===

If you specify the -test option no schedule changes will actually be made

=== In-place updating ===

If you use the visual schedule webif/RS pages to "Record this showing instead" it will generate a skip entry for the current episode and a one-off recording entry for the replacement episode. Schedchk uses a different approach and where possible updates the existing series entry with the new episode details.

The main advantages of this approach is that the recording will automatically go into the series folder and any folder related webif settings (auto-decrypt, shrink, detectads etc) will be applied as usual. You will only have one entry in the recording schedule rather than many and you won't have to move recordings from the My Videos folder.

[[File:Schedchk-inplace.png|800px||right]]
[[File:Schedchk-inplace2.png|800px||right]]
It can look a bit odd to have episodes from different channels in the same series but both webif and RS handle this correctly

Which of the channels will show as the 'main' channel for the series depends on the channel of the next scheduled episode

Minor disadvantages are:
* The Humax won't add new episodes while the 'wrong' channel is main (but Schedchk 'Unscheduled episodes' will add them instead)
* Schedchk 'SCRID change' and '1-off episodes' will check the alternate channel when it is main (more work needs to be done in this area)

If you would prefer more traditional skip and 1-off scheduling you can specify the -noAlert option in settings or on the command line.

=== Progress Messages ===

The -d option controls the level of mesages produced:
* 0 - Schedule changes and errors only (also displayed as webif notifications)
* 1 - Intermediate level
* 2 - Detailed progress messages

== Schedchk settings ==

Initially all schedchk processing options are enabled but the default settings can be overridden on the webif Settings page, any changes made here become the new defaults for schedchk.

More detail on each of the options is given in the sections above.

[[File:Schedchk-settingspage.png|frame|center|SchedChk Settings Page ]]

== Schedchk command line ==

As well as running automatically every few minutes as part of the regular Auto process you can also run schedchk on demand from a command line. Options specified on the command line override values set on the settings page for this invocation of schedchk only, they don't change the default values.

<pre>
schedchk = Check for recording schedule issues and attempt to fix them

schedchk -h = produce this help
schedchk -rsv = scan the recording schedule

Options Default (unless changed in Settings)
-thresh 36 = Don't check for problems more than x hrs away from start
-d 0 = Produce more detailed output
-test n = Don't make updates
-noAuto n = Don't run regularly as part of Auto-Processing
-noAlert n = Don't generate webif alert messages for changes made
-noConflict n = Don't check for conflicts
-noUnsched n = Don't check for episodes missing from schedule
-noSCRID n = Don't check for series CRID changes
-no1off n = Don't check for episodes scheduled as one off programmes
-noNotRec n = Don't check for failures to record
-recWait 300 = Don't assume recording failed until x seconds late starting
-noMissEPG n = Don't resolve missing epg entries
-noEPGchg n = Don't resolve epg time/ duration/ event crid changes
-noSplit n = Don't resolve repeated split recordings
-noInplace n = Update reservation by skipping & 1-off rather than inplace

Note: Options are not case sensitive
</pre>
-noAuto has no effect when specified as a command option, it needs to be set via the settings page.

== Running via crontabs ==

As an alternative to running schedchk as part of the standard customised firmware Auto processing it also possible to schedule schedchk to run at different intervals using the crontabs file.

You might want to do this if:
* You normally disable Auto processing during recordings but would still like to take advantage of Not Recording checks
* You want some checks made at a different frequency from others
* You want process messages written to a dedicated log file

You can edit the crontabs file via webif->Diag->File Editor->Commonly edited files->/mod/var/spool/cron/crontabs/root
[[File:Schedchk-crontabs.png|frame|center|Editing crontabs file]]
In the example above schedchk will run a Not Recording check every 4 minutes and check for SCRID changes and 1-off recordings every 4 hours at 17 minutes past the hour, output will be written to schedchk.log

[https://www.thegeekstuff.com/2009/06/15-practical-crontab-examples/ Guides to crontabs time formats are available online]

== fmtrsv - Format a rsv.db table entry ==
Fmtrsv is a simple command line utility created to help with displaying the contents of the rsv.db where schedule entries are stored. It is included with the schedchk package to help in gathering information for debugging purposes. Entries displayed can be filtered with a number of options
<pre>
# fmtrsv -h
fmtrsv = Formats schedule entries from the rsv.db

fmtrsv options
no options will list all reservations

Options
-h produce this help
-n,-name xxx = select recording name contains
-s,-slot n = select slot
-l,-lcn n = select channel number
-c,-cname xxx = select channel name contains
</pre>
Sample output
<pre>
# fmtrsv -s 16
ulslot = 16
ersvtype = 3 Recording
hsvc = 131097
nsttime = 1590429600 25/05/2020 19:00
szsttime = 00000000000000
nduration = 3600 01:00
erepeat = 0 no repeats
usevtid = 12270
szevtname = i7Code-Breakers: Bletchley Park's... (Code-Breakers: Bletchley Park's...)
ulPreOffset = 0
ulPostOffset = 0
ulProgramId = 0
ulSeriesId = 0
ucVolume = 0
ucInputMode = 0
usChNum = 0
ucRecKind = 4 series
ucCRIDType = 50 series
szCRID = FP.BBC.CO.UK/B-3P5L5
szFPBRecPath = Code-Breakers: Bletchley Park's...
szRecordedProgCrid = 1FP.BBC.CO.UK/B/KZSO7|
szEventToRecord = 1FP.BBC.CO.UK/B/KOEPL|
aulEventToRecordInfo = {131097 1590429600 1590433200 12270}
bRecomRsv = 0
usLastRecordedEvtId = 0
eReady = 30
szSvcName = BBC TWO
usLcn = 2
Svcid Start End Evtid CRID
131097 1590429600 25/05/2020 19:00 1590433200 25/05/2020 20:00 12270 1FP.BBC.CO.UK/B/KOEPL
Skiplist Svcid:Evtid
131097:12390
========================================================

</pre>
== Other Stuff ==
=== Change history ===
{|border=1,
| '''Date'''||'''Version'''||'''Author'''||'''Description'''
|-
|2020-06-05 ||schedchk 0.1.0|| mymsman || Intial Version
* All new!
|}
=== Acknowledgements ===
;af123:For providing the cf framework that underlies everything and who's code I have copied and hacked.
;/df:For investigating the problems with Split recordings and writing the rsv set method
;everybody else:Who has assisted through the forums
=== Future Enhancements ===
* Detect and reschedule recordings active at time of crash
* Improve Series CRID change detection to reduce false positives

Schedchk

2020-06-09T11:19:57Z

MymsMan:

= [[File:Schedchk48.png|left]]Schedchk - Check and fix the Humax recording schedule =
== Introduction ==
While it is "only telly" it can be extremely annoying when we find that a programme we had scheduled to record fails to record correctly.
Some failures can be attributed to user errors but a considerable numbers of problems are attributable to the broadcasters and problems in the Humax software not anticipating the ever more creative ways the broadcasters find to make life complicated!

The origins of schedchk go back several years to a [https://hummy.tv/forum/threads/schedchk-auto-fix-schedule-changes-a-proposal.7988 forum post]where I proposed the idea of automatically detecting when programmes were delayed or moved to another channel (e.g. BBC One -> BBC Two) because of overrunning sporting events or breaking news events. Nothing much happened at that time since Wimbledon only last two weeks and other last minute programme changes are by their nature unpredictable making testing difficult.

However now we live in Interesting Times and the unpredictable has become routine, every day the BBC1 showing of Pointless is moved to BBC2 to make way for the Corona Virus Daily Update. One might think that after this long the BBC would take the hint and schedule Pointless on BBC2 but no they persist in scheduling it on BBC1 and only update the schedules 3-72 hours in advance!
Since Pointless is one of our favourite shows I was provoked into resurrecting the Schedchk idea and finally it is now ready for a wider audience though there may still be a few rough edges.

[[File:Schedchk-rts.png|400px|frameless|right]]

The program relies on the EPG being kept up-to-date to allow it to find alternative showings of programmes and, especially with last minute changes, that can't be relied upon and sometimes there are no alternate showings so it will not be infallible but hopefully it will help you avoid some missed recordings,

To allow schedchk to promptly update the recording schedule it is important that Real-time scheduling is enabled via the Advanced Settings section of the Settings page

I have found several different categories of potential errors in the schedule and these are listed below with examples of how they can occur and action schedchk takes when attempting to fix them.
__TOC__
== Schedule Check Categories ==
=== EPG changes ===
The most basic form of schedule change is when the broadcaster changes the start time, duration or scheduled episode (event-CRID change).
Usually the Humax is quite good at spotting these changes but sometimes it doesn't immediately.

Schedchk will resolve this type of error by updating the schedule entry with the new details.

Checking for this type of problem can be by-passed by specifying the -noEPGchg option in settings or on the command line

=== Missing EPG entry ===
[[File:Schedchk-duplicateepisode.png|600px|frameless|right|Duplicate episode]]
Sometimes the event-id associated with a programme changes and the Humax is not good at resolving these, on occasion it can get very confused resulting in it scheduling two episodes of the same series at the same time!

Changes to the event-id can occur when a programme is moved another channel (e.g. Pointless moving from BBC1_>2), when a programme is added to the schedule (ITV assigned new event-ids to all programmes following the Queen's recent broadcasts), a different episode is scheduled (e.g, the duplicate example above) or if a programme is cancelled and replaced by something else.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead.
If there are no matches by event-CRID it will look for a programme of the same name scheduled for the same time in case the Broadcaster has changed event-id, event-CRID and series-CRID and scheduled an episode from a different series of the programme.
If duplicate episodes occur it will delete the episode that no longer appears in the EPG.

Checking for this type of problem can be by-passed by specifying the -noMissEPG option in settings or on the command line

=== Conflict resolution ===

Conflict arise when three of more programmes are scheduled to be recorded at the same time (Two or more on HD model).
This can arise if a user ignores conflict warnings when scheduling, when a news day's EPG data is loaded, or if the EPG changes.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead. When considering alternatives schedchk will attempt to find a match on a channel with the same definition (HD or SD) as the original but if there is no match it will consider matches on channels with a different definition.

Schedchk is quite simple minded in its approach to conflict resolution and will not always choose the best solution for your viewing needs. For complex conflicts or where you want to select which programmes you don't want delayed you should attempt to manually resolve conflicts using the Visual Schedule displays in the webif or RS before schedchk attempts automatic resolution.

At the moment Split recordings are not considered for conflict resolution.

Checking for this type of problem can be by-passed by specifying the -noConflict option in settings or on the command line

=== Unscheduled episodes ===

The Humax normally manges to automatically schedule new episodes of a series but can sometimes miss changes that happen in the middle of the scheduled sequence

Schedchk checks the EPG by series-CRID and adds any missing

Checking for this type of problem can be by-passed by specifying the -noUnsched option in settings or on the command line

=== series-CRID changes ===

Often broadcasters change the series-CRID of a long running programme causing the next episodes of the programme to be not recorded. Sometimes this is because it has switched to another series of the programme (as if we really care whether it is repeats from series 51 or 55) but other times there is no obvious reason for the change.

Schedchk handles this by looking by programme name for a new series with matching name in the same time slot on the same channel and scheduling a new series recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes with variable time slots such as the F1 Grand Prix races
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the series-CRID check is liable to consider the +1 series a new unscheduled series

Checking for this type of problem can be by-passed by specifying the -noSCRID option in settings or on the command line

=== One-off episodes of a series ===

Sometimes broadcasters schedule episodes of a series as 1-off programmes without a series-CRID. Often this is deliberate when filling in a gap in the schedule but other times it is the result of broadcaster incompetence! Recently, Pick broadcast several episodes of the Sherlock series as 1-off programmes 😥

Schedchk handles this by looking by programme name for a 1-off programme with matching name on the same channel and scheduling a recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the 1-off check is liable to search the +1 channel

Checking for this type of problem can be by-passed by specifying the -no1off option in settings or on the command line

=== Not Recording ===

Occasionally a programme fails to start recording. This can be due to an unresolved conflict, overrunning programmes, last minute schedule changes etc. but some failures are unexplained.

When a programme is due to be recording schedchk checks whether there is a file for the recording and whether it is growing in size. If the programme is not recording it searches by event-CRID for an alternative showing and, if a suitable alternate is found, schedules it as a 1-off recording.

Since some late starting is normal the checking starts a short while after the scheduled start. By default this is 300 seconds (5 minutes) but this can be modified by specifying the -recWait option in settings or on the command line

Checking for this type of problem can be by-passed by specifying the -noNotRec option in settings or on the command line

Note: Since active recording schedule entries are deleted on Humax start-up schedchk can't schedule alternates for recordings truncated by a power failure or Humax crash 😥.

=== Split Recordings ===

Split recordings are where a long programme such as a film has a shorter programme, often a news bulletin, in the middle of the longer programme. While they may appear to be a 2-epsidode series they are not treated as such by the broadcasters or the Humax and have their own (very badly designed) set of rules which the Humax only partially implements.
Split recordings contain #number at the end of their event-CRID (eg /X4454865#01) and both halves of the split recording are required to have the same number, known as an IMI (Instance Metadata ID). The problem arises when the same film is repeated later in the week with exactly the same event-CRID and IMI, under the rules if there is more than three hours between them they should be treated as different programmes but the Humax treats them all as additional parts of the same programme.

This is a particular problem on channels such as Sony Movies which split most films into 2 parts and regularly repeat films up to three times a week. So you can attempt to schedule just one showing of a film but the Humax will schedule all six parts and some of the unwanted recordings can cause schedule conflicts.

Schedchk handles split recordings by leaving those with one or two parts schedule alone, if there are more than two parts scheduled it checks whether there is more than a 3-hour gap and whether there are any conflicts. The first, non-conflicting, showing is kept with a dummy IMI to prevent the Humax rescheduling and the other showings are removed from the schedule.

Checking for this type of problem can be by-passed by specifying the -noSplit option in settings or on the command line

== Other controls ==

=== Threshold ===

The Threshold setting (-thresh) controls how far into the schedule schedchk should look for problems. The default, unless changed in settings, is 36 hours which seems adequate for resolving potential problems.

You may wish to increase it on infrequently used machines.

=== No Auto ===

Normally schedchk runs as part of the regular Auto processing.
If you would prefer to run it on ad-hoc basis from a command line or set up your own [[Schedchk#Running via crontabs|schedule with crontabs]] you can specify No Auto in the Schedchk section of the settings page.

=== No Alerts ===

Schedchk generates webif warnings when it makes changes to the recording schedule to let you know what has happened.
[[File:Schedchk-alert.png|frame|center|Alert messages]]
If you would prefer not to receive these pop-up messages you can specify the -noAlert option in settings or on the command line.

Note: The example shows that sometimes broadcasters makes changes and then reverse them in short order.

=== Test Mode ===

If you specify the -test option no schedule changes will actually be made

=== In-place updating ===

If you use the visual schedule webif/RS pages to "Record this showing instead" it will generate a skip entry for the current episode and a one-off recording entry for the replacement episode. Schedchk uses a different approach and where possible updates the existing series entry with the new episode details.

The main advantages of this approach is that the recording will automatically go into the series folder and any folder related webif settings (auto-decrypt, shrink, detectads etc) will be applied as usual. You will only have one entry in the recording schedule rather than many and you won't have to move recordings from the My Videos folder.

[[File:Schedchk-inplace.png|800px||right]]
[[File:Schedchk-inplace2.png|800px||right]]
It can look a bit odd to have episodes from different channels in the same series but both webif and RS handle this correctly

Which of the channels will show as the 'main' channel for the series depends on the channel of the next scheduled episode

Minor disadvantages are:
* The Humax won't add new episodes while the 'wrong' channel is main (but Schedchk 'Unscheduled episodes' will add them instead)
* Schedchk 'SCRID change' and '1-off episodes' will check the alternate channel when it is main (more work needs to be done in this area)

If you would prefer more traditional skip and 1-off scheduling you can specify the -noAlert option in settings or on the command line.

=== Progress Messages ===

The -d option controls the level of mesages produced:
* 0 - Schedule changes and errors only (also displayed as webif notifications)
* 1 - Intermediate level
* 2 - Detailed progress messages

== Schedchk settings ==

Initially all schedchk processing options are enabled but the default settings can be overridden on the webif Settings page, any changes made here become the new defaults for schedchk.

More detail on each of the options is given in the sections above.

[[File:Schedchk-settingspage.png|frame|center|SchedChk Settings Page ]]

== Schedchk command line ==

As well as running automatically every few minutes as part of the regular Auto process you can also run schedchk on demand from a command line. Options specified on the command line override values set on the settings page for this invocation of schedchk only, they don't change the default values.

<pre>
schedchk = Check for recording schedule issues and attempt to fix them

schedchk -h = produce this help
schedchk -rsv = scan the recording schedule

Options Default (unless changed in Settings)
-thresh 36 = Don't check for problems more than x hrs away from start
-d 0 = Produce more detailed output
-test n = Don't make updates
-noAuto n = Don't run regularly as part of Auto-Processing
-noAlert n = Don't generate webif alert messages for changes made
-noConflict n = Don't check for conflicts
-noUnsched n = Don't check for episodes missing from schedule
-noSCRID n = Don't check for series CRID changes
-no1off n = Don't check for episodes scheduled as one off programmes
-noNotRec n = Don't check for failures to record
-recWait 300 = Don't assume recording failed until x seconds late starting
-noMissEPG n = Don't resolve missing epg entries
-noEPGchg n = Don't resolve epg time/ duration/ event crid changes
-noSplit n = Don't resolve repeated split recordings
-noInplace n = Update reservation by skipping & 1-off rather than inplace

Note: Options are not case sensitive
</pre>
-noAuto has no effect when specified as a command option, it needs to be set via the settings page.

== Running via crontabs ==

As an alternative to running schedchk as part of the standard customised firmware Auto processing it also possible to schedule schedchk to run at different intervals using the crontabs file.

You might want to do this if:
* You normally disable Auto processing during recordings but would still like to take advantage of Not Recording checks
* You want some checks made at a different frequency from others
* You want process messages written to a dedicated log file

You can edit the crontabs file via webif->Diag->File Editor->Commonly edited files->/mod/var/spool/cron/crontabs/root
[[File:Schedchk-crontabs.png|frame|center|Editing crontabs file]]
In the example above schedchk will run a Not Recording check every 4 minutes and check for SCRID changes and 1-off recordings every 4 hours at 17 minutes past the hour, output will be written to schedchk.log

[https://www.thegeekstuff.com/2009/06/15-practical-crontab-examples/ Guides to crontabs time formats are available online]

== fmtrsv - Format a rsv.db table entry ==
Fmtrsv is a simple command line utility created to help with displaying the contents of the rsv.db where schedule entries are stored. It is included with the schedchk package to help in gathering information for debugging purposes. Entries displayed can be filtered with a number of options
<pre>
# fmtrsv -h
fmtrsv = Formats schedule entries from the rsv.db

fmtrsv options
no options will list all reservations

Options
-h produce this help
-n,-name xxx = select recording name contains
-s,-slot n = select slot
-l,-lcn n = select channel number
-c,-cname xxx = select channel name contains
</pre>
Sample output
<pre>
# fmtrsv -s 16
ulslot = 16
ersvtype = 3 Recording
hsvc = 131097
nsttime = 1590429600 25/05/2020 19:00
szsttime = 00000000000000
nduration = 3600 01:00
erepeat = 0 no repeats
usevtid = 12270
szevtname = i7Code-Breakers: Bletchley Park's... (Code-Breakers: Bletchley Park's...)
ulPreOffset = 0
ulPostOffset = 0
ulProgramId = 0
ulSeriesId = 0
ucVolume = 0
ucInputMode = 0
usChNum = 0
ucRecKind = 4 series
ucCRIDType = 50 series
szCRID = FP.BBC.CO.UK/B-3P5L5
szFPBRecPath = Code-Breakers: Bletchley Park's...
szRecordedProgCrid = 1FP.BBC.CO.UK/B/KZSO7|
szEventToRecord = 1FP.BBC.CO.UK/B/KOEPL|
aulEventToRecordInfo = {131097 1590429600 1590433200 12270}
bRecomRsv = 0
usLastRecordedEvtId = 0
eReady = 30
szSvcName = BBC TWO
usLcn = 2
Svcid Start End Evtid CRID
131097 1590429600 25/05/2020 19:00 1590433200 25/05/2020 20:00 12270 1FP.BBC.CO.UK/B/KOEPL
Skiplist Svcid:Evtid
131097:12390
========================================================

</pre>
== Other Stuff ==
=== Change history ===
{|border=1,
| '''Date'''||'''Version'''||'''Author'''||'''Description'''
|-
|2020-06-05 ||schedchk 0.1.0|| mymsman || Intial Version
* All new!
|}
=== Acknowledgements ===
;af123:For providing the cf framework that underlies everything and who's code I have copied and hacked.
;/df:For investigating the problems with Split recordings and writing the rsv set method
;everybody else:Who has assisted through the forums
=== Future Enhancements ===
* Detect and reschedule recordings active at time of crash
* Improve Series CRID change detection to reduce false positives

File:Schedchk-rts.png

2020-06-09T11:02:12Z

MymsMan: Advanced settings option

== Summary ==
Advanced settings option

Custom Firmware Package Notes

2020-06-09T10:53:19Z

MymsMan: /* Schedchk */

'''BRIEF NOTES FOR CUSTOM FIRMWARE PACKAGES'''
{{Note|Some Functions of the Web Interface are 'Built-In' and do not require any additional packages to be installed. These features are covered in the Web If section of this page.

Some packages require a reboot (Hard disk spin down) before they take effect.}}

Also, see Forum Links [[Forum_Links|'''HERE''']]

==7Zip==

Command line utility that can pack and unpack zip type files

*Supported Packing / unpacking formats = 7z, XZ, BZIP2, GZIP, TAR, ZIP and WIM
*Supported Unpacking only = ARJ, CAB, CHM, CPIO, CramFS, DEB, DMG, FAT, HFS, ISO, LZH, LZMA, MBR, MSI, NSIS, NTFS, RAR, RPM, SquashFS, UDF, VHD, WIM, XAR and Z.

==Arbookmarks==

Adds bookmarks into automatically or manually padded recordings, bookmarks are placed at [[Padding_versus_Accurate_Recording | '''Accurate Recording''']] start and stop points to all files in folders marked as Auto Decrypt, the following conditions must be met before the Bookmarks will be added :-
* The Arbookmarks package must be installed
* Files must be in a folder that is marked for auto-decryption ([[Icons#Media_Browser_-_Folders|'''open lock icon''']] present)
* Files must be DLNA indexed (automatically done by the Humax periodically, [[Icons#Media_Browser_-_Files|'''lime green circular icon''']] present)
* Files must not be recorded using AR i.e. the AR flags are not at start and end of file
* AR flags must be present i.e. recordings made in the middle of a programme won't contain AR flags

==At==

at, batch, atq, atrm - queue, examine or delete jobs for later execution. This is the UNIX at command and atd daemon, which allow for scheduling of one-off commands to be run when specified.

More notes [http://en.wikipedia.org/wiki/At_%28Unix%29 '''HERE''']

==Auto Schedule Restore==

This package checks whether the schedule is present on each boot, If a schedule is in place it is backed up to flash, otherwise the schedule and any favourites list are restored from the flash backup. The schedule will be deemed to be present if there is at least one schedule item or one reservation item existing

'''NOTES:-'''
* After a re-boot the restore process will start and "Schedule Restored . . . Rebooting" will be displayed on the front display
* A second re-boot will take place automatically after 15 seconds to finalise the restoration process
* The Web-if will display "The recording schedule has been automatically restored" after the second re-boot

==Auto-Unprotect==

The Auto-Unprotect package runs in the background and automatically removes the Encryption Protected flag on High Definition recordings on the HDR-Fox T2. This is the flag which prevents the file from being decrypted in the same way as a Standard Definition file. On first installation, the hard disk will be scanned for any High Definition recordings and they will be unprotected. Thereafter, new recordings will have the flag removed as they are completed. See reset_unprotect [[Diagnostic_Utilities | '''HERE''']] to fix any 'missed files'.

Auto, Auto-Unprotect makes a change to the DLNA index so that High Definition files can be streamed without DTCP, Note, Foxy does not remove DTCP which is required for DLNA decryption

NOTES:-
*The removal of the ENC flag does not decrypt the file, however it does make decryption possible by the same means as for a Standard Definition file - see flow chart [[Encryption |'''HERE''']].
*Auto-Unprotect on the HD-Fox T2 will not allow decryption unless the HD-Fox T2 is running in BootHDR mode

==Auto-Update==

This package automatically keeps the installed packages up to date by checking for any new releases daily and automatically downloading and installing them. It will check once per day at the earliest power on - for most people probably the 04:30 boot.

==Badnts==

Utility to fix a recording error where a full size TS file is recorded but the associated NTS file generated by the Humax is of zero length, this results in the the Humax rejecting the file on playback. After the recording is decrypted in a folder that is marked for auto-decyption, the utility will look for a zero length NTS file and if found the NTS, THM and HMT files will all be deleted (or moved to the [Deleted] folder), this will make the TS file playable on the Humax,however as the 'sidecar' files have been removed there will be some play-back
limitations, e.g. transport controls etc.
'''Notes'''
*This utility only works on HDR-Fox T2 not HD-Fox T2
*Only files stored in an auto-decrypt folder will be fixed

==Bash==

Bourne Again SHell is an enhanced [[Custom_Firmware_Package_Notes#Sh | '''Sh (Shell)''']] Command line / scripting language. [http://www.gnu.org/software/bash/manual/bashref.html '''See Reference Guide''']

==Betaftpd==

===For HDR-Fox T2===

The HDR-FOX T2 has a built-in FTP server. The default server will still be available after the Custom Firmware is installed, however only files under ‘Media’ are visible. Betaftpd has two possible Logins. If login = humaxftp and password = 0000 is used then only ‘Media’ is visible. If login = root and password = 0000 is used then the entire file system is accessible. If the remote password has been changed from 0000 then the new password must be used.

NOTE:- The Built-in FTP server must be turned off if Betaftpd is used with Menu >> Settings >> System >> Internet Settings >> FTP Server = OFF

===For HD-Fox T2===

Betaftpd will add an FTP server to the Humax after installation. Betaftpd has two possible Logins. If login = humaxftp and password = 0000 is used then only ‘Media’ is visible. If login = root and password = 0000 is used then the entire file system is accessible. If the remote password has been changed from 0000 then the new password must be used.

==Blocklist==

See Transmission (torrent) Block List notes [[Custom_Firmware_Package_Notes#Blocklist_2|'''HERE''']].

==Bookmark==

The Humax Bookmarks used to place 'jump-to' points within a recording are also used by several Custom Firmware packages, as Follows:-
*[[Edit_On_Box|'''Edit On Box''']] . . . A single or multiple bookmarks are used as cut and join points for editing a recording in the Web-If [[#Crop|'''Crop''']] option
*[[#Set_Thumbnail|''' Set Thumbnails''']] . . . Uses the the first bookmark in a recording as a central point from which to pick a new thumbnail
*[[#Arbookmarks|'''Arbookmarks''']] . . . Bookmarks are automatically added to a recording at [[Padding_versus_Accurate_Recording|'''Accurate Recording''']] start and stop points so that a [[#Crop|'''Crop''']] can be performed

==BootHDR==

<big>'''This package is for the HD-FOX T2 only (NOT for HDR-Fox T2</big>''') 

It allows the HD-FOX T2 to run the software for the HDR-FOX T2, to allow decryption of recordings by copying to a volume. BootHDR can be installed from the Web-If packages screen (of the HD-Fox T2 only). Here is the equivalent command line (Telnet) :-

 opkg install wget 

 opkg install boothdr --force-reinstall 

Once the package is installed you can run in HDR-Fox T2 mode, while in this mode, the front panel display will freeze and the box will be incapable of making new recordings. To initiate HDR-Fox T2 mode copy the *Modsettings/TriggerHDR folder to the root of drive1 and then re-boot the HD-Fox T2

Installing the BootHDR package also adds the command line keyword bootHDRmode, this can be used to invoke HDR mode

There is a Guide to using BootHDR on the Wiki [[Decrypt_recordings_on_the_HD-FOX_T2 | '''HERE''']]

==Boot_Settings==

Set system parameters to specified values on every boot. [Update settings]

==Bsed==

Binary-safe search/replace utility.

==BusyBox==

Your Humax box has a ‘Unix’ operating system. Busybox is a package that provides 158 common Unix [[Custom_Firmware_Package_Notes#Sh_.28SHell.29 | '''Sh (Shell)''']] commands that can be used in Telnet sessions. The list below shows the available commands. There is no 'man' command that would explain what they do, but most commands can have a -? or -h extension to get some help e.g. ls -?

A command look up table can be found [http://busybox.net/downloads/BusyBox.html '''HERE'''].

NOTE:- It is not a good idea to 'Play' with these commands if you don't know what you are doing.

<div style="column-count:8;-moz-column-count:8;-webkit-column-count:8">
*[
*[[
*ar
*arp
*arping
*ash
*awk
*base64
*basename
*bunzip2
*bzcat
*bzip2
*cal
*cat
*catv
*chgrp
*chmod
*chown
*chroot
*cksum
*clear
*cmp
*comm
*cp
*cpio
*cut
*date
*dc
*dd
*df
*diff
*dirname
*dos2unix
*du
*echo
*ed
*egrep
*env
*ether-wake
*expr
*false
*fgrep
*find
*fold
*free
*ftpget
*ftpput
*fuser
*grep
*gunzip
*gzip
*hd
*head
*hexdump
*ifconfig
*insmod
*install
*iostat
*kill
*killall
*killall5
*last
*less
*ln
*logname
*ls
*lsmod
*lsusb
*lzcat
*lzma
*md5sum
*mkdir
*mkfifo
*mknod
*mktemp
*modinfo
*modprobe
*more
*mpstat
*mv
*nc
*netstat
*nice
*nmeter
*nohup
*nslookup
*od
*patch
*pgrep
*ping
*pkill
*pmap
*printenv
*printf
*ps
*pstree
*pwd
*pwdx
*readlink
*realpath
*renice
*rm
*rmdir
*rmmod
*route
*rpm
*sed
*sendmail
*seq
*sh
*sha1sum
*sha256sum
*sha512sum
*sleep
*sort
*split
*stat
*strings
*stty
*sum
*sync
*sysctl
*tail
*tar
*tee
*telnet
*test
*tftp
*time
*top
*touch
*tr
*traceroute
*true
*tty
*uname
*uniq
*unix2dos
*unlzma
*unxz
*unzip
*uptime
*usleep
*uudecode
*uuencode
*vi
*watch
*wc
*wget
*which
*who
*whoami
*xargs
*xz
*xzcat
*yes
*zcat
</div>

==Channeldel==

Note: now superseded by tunefix

Automatic channel deletion. select TV channels to be permanently removed from the group TV list in Web-If >> Settings >> Automatic Channel Deletion, selected channels, plus a set of 9 unavailable channels known to cause problems will be automatically deleted the next time the Humax is booted, and following any retune

Select all but one file and press delete to reduce the current list in /mod/boot/chandel.conf, the remaining file can be deleted later

==ChaseDecrypt==

Retrieve and decrypt recording whilst recording is still in progress, uses Chaseget

See [[ChaseDecrypt]] for further details

==Chaseget==

Retrieve and decrypt recording, can run whilst recording is still in progress

This is intended to be used as part of other packages (such as detectads) rather than installed and used standalone

Runs as first stage of pipeline, output is always to stdout

Usage= /mod/bin/chaseget recording.ts start_offset logfile > output.ts

==CIFS==

The Common Internet File System. The cifs package provides the Humax with the ability to remotely access files shared from PCs using Windows file sharing. This package adds the support to the running system but mounting remote file systems must currently be performed from the command line. Example :-

 mkdir /media/NAS 

 mkdir "/media/My Video/NAS" 

 mount -t cifs //server/share /media/NAS -o user=abc,password=def 

 mount -t cifs //server/share "/media/My Video/NAS" -o user=abc,password=def 

==CLI==

This is an acronym for Command Line Interface, a CLI can be established by Telnetting into the Humax and being presented with a CLI prompt, If the Tmenu is displayed there will be a 'cli' option to gain the CLI prompt e.g. humax#

==Content Sharing==

Menu >> Settings >> System >> Internet Settings >> Content Sharing = On

Content Sharing is an in-built DLNA / UPnP server that allows the HDR to stream content over it's LAN connector to a DNLA / UPnP client, this feature is also used by the Custom Firmware to provide decryption of both Standard Definition and High Definition content

==Crashdiag==

Captures a memory dump (core file) when the main Humax process crashes,The dump files will end up in /mod/core/ called humaxtv.<UNIX timestamp> and a reboot is required following package installation in order to activate it

==Crash Log==

The Mulitenv 1.4 package contains a procedure that monitors the behaviour of running processes, If the Humax crashes a file will be generated under /mod/tmp/ called crash.log, it can be examined from Web-If >> Diagnostics >> View Log Files. The Crash log will tell you if Custom Firmware plug-ins are being disabled as a result of the crash, To re-start undelete, redring and ir packages, run Web-If >> Diagnostics >> fix-flash-packages >> Run Diagnostic. To prevent the crash log auto disabling plug-ins, create a file with the following command :-
<pre>
touch /var/lib/humaxtv/mod/no_plugin_autodisable
</pre>

==Cron==

Cron is a time-based job scheduler that will auto-run tasks for you. It is built into Busybox which is a standard utility on your Humax, so Cron does not need to be installed. The tasks are held in a Cron table or crontab. Here is an example crontab :-

<pre>
humax# cd /mod/var/spool/cron/crontabs/
humax# cat root
0 2 * * * /mod/sbin/anacron -s -d
1,31 * * * * /mod/sbin/unencrypt "/mnt/hd2/My Video/archive" > /mod/tmp/unencrypt.log 2>&1
*/10 * * * * /mod/sbin/rs_process >> /mod/tmp/rs.log 2>&1
humax#

</pre>

Each line of crontab has the following structure:

<Minute> <Hour> <Day> <Month> <Day of Week> <Command line> Note :- * = All or Every

The three examples above will run
#at 2AM every day
#at 1 Minute and 31 Minutes of every Hour every day
#every 10 Minutes continuously

It is possible to display all cron jobs with the following command line:-

 crontab -l 

To add a new cron job edit file /mod/var/spool/cron/crontabs/root and add a new line

==Cryptokey==

This is the unique key that is used by the Humax HDR / HD to encrypt and decrypt all recordings on the hard disk, it is made up from the MAC address of the unit (6 pairs of hexadecimal) followed by the first 10 digits of the unit's serial number (also in hexadecimal)

The cryptokey can be examined, changed and reset (Cleared) to the original by sending the following [[Custom_Firmware_Package_Notes#Nugget | '''nugget''']] command line options :-

<pre>
humax# nugget cryptokey
Native key: dc d3 21 01 02 03 36 33 37 31 30 35 37 36 33 30
Using key: <no custom key in use>

humax# nugget cryptokey 01.01.01.01.01.01.01.01.01.01.01.01.01.01.01.01
Using key: 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01

humax# nugget cryptokey
Native key: dc d3 21 01 02 03 36 33 37 31 30 35 37 36 33 30
Using key: 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01

humax# nugget cryptokey -clear
Cleared custom encryption key.

humax# nugget cryptokey
Native key: dc d3 21 01 02 03 36 33 37 31 30 35 37 36 33 30
Using key: <no custom key in use>
</pre>

The cryptokey is used by the [[Custom_Firmware_Package_Notes#Stripts | '''Stripts Package''']] when decrypting files on the Humax

==Curl Command==

curl command line utility.

==Custom TV Portal==

An extension to the Humax TV Portal that adds more features.

Full Guide[[Custom_TV_Portal | '''HERE''']]

==DB Update==

General boot-time database update utility

==Dedup (Command Line)==
[[File:Webif-media-ded.png|right|150px]]
[[File:Webif-media-ded2.png|right|150px]]
The dedup package adds a command line utility which can consolidate recordings within a single folder so that duplicates are removed and the remaining episodes are renamed so that the episode name and number (if available) are displayed in the Media Browser.

Note:- There is a 'built-in' version of Dedup in the [[Custom_Firmware_Package_Notes#Web_IF | '''Web-If ''']] that effectively replaces the command line package. However if the dedup package is installed it is possible to perform the following Telnet commands from the folder you have navigated to:-

 dedup HIDE lists the recordings there and shows what they would be renamed to

 dedup -yes HIDE perform the changes as detailed below :-

*Renames the files on disk to match the episode name
*Changes the title shown in the media list to match the episode name
*Identifies duplicate episodes and moves them to a sub-folder called dup/

==Dedup (Series Helper File)==

It is possible to create a series helper file that Dedup can use to enhance the re-naming of series, the file should be placed in the directory containing the series and named series.info, Dedup will look for this file and automatically use it, an example of a series.info file is shown below :-

<pre>
Pilot ==> S1-01
Pilot The Big Bang Theory ==> S1-01
The Big Bran Hypothesis ==> S1-02
The Fuzzy Boots Corollary ==> S1-03
The Luminous Fish Effect ==> S1-04
The Hamburger Postulate ==> S1-05
The Middle Earth Paradigm ==> S1-06
The Dumpling Paradox ==> S1-07
The Grasshopper Experiment ==> S1-08
The Cooper-Hofstadter Polarization ==> S1-09
</pre>

The above 'full' file is stored here :- [http://hummypkg.org.uk/series/tbbt.series.info '''http://hummypkg.org.uk/series/tbbt.series.info''']

==DeRMA==

After a Web-If >> Diagnostics >> Set-Return-to-manufacturer (RMA) Mode operation has been carried out, standard Humax software should be re-installed, this should leave the Humax in an 'out-of-the-box' state, however if for any reason the 'RMA' message is still being displayed, then loading this package onto a USB stick and inserting it into the Humax, while it is running, will remove the RMA message

==Detectads==

This package will attempt to add bookmarks to a recording to indicate the start and end of advert breaks, so that the adverts can be removed with a crop function, cropping can optionally be performed automatically within the package,

Using the new 'Detect while recording' function the detection process runs in parallel with the actual recording so the processing completes within a few seconds of the recording finishing. You can even, with some limitations, start to watch your program adfree whilst it is still recording.

See [[DetectAds]] for more information about this package

==Disable DSO==

Disable automatic retuning in response to Digital-Switch-Over events. When the Humax carries out a retune all recording Schedule events and all Favourites Lists will be erased, however recorded programmes will not be erased. DSO events are sent to the Humax by the TV broadcasters when they need to change some aspect of the Electronic Programme Guide, such as changing a channel number or adding extra channels

==Disable OTA==

Disable OTA inhibits any Over The Air software updates transmitted by Humax by deleting OTA schedules created by the Humax, it also has a "Create Reminder to cover OTA Period = Y / N" option in the Settings page, this will create a reminder on the Red Button (channel 200) to cover the OTA period, if you want it to use a different channel or on / off time, you can edit the reminder using the standard Humax on-TV menus, you can also disable the reminder option completely, however if this is done there is a small possibility that an OTA search may still be actioned on your Humax

'''Note''' The OTA service for software updates is no longer in operation

==Display==

A command that can be used to display a message on the HDR-Fox T2 front panel, any alpha-numerics (Max 12 characters) can be displayed, scrolling is not available. The new message will be displayed until the unit is rebooted or changed by the Humax, example :-

 /sbin/display 'Twelve Chars' 

The display can be blanked with :-

 /sbin/display ' ' 

The display of the HD-Fox T2 (Max 4 characters + colon) can also be used by adding '$' to the string e.g. :-

 /sbin/display '$he:lp' 

'''NOTE''' If the Humax updates the display e.g. after a channel change or is scrolling the display then your message will be removed

==DLNA-Filter==

Filters out DLNA server network traffic to prevent other DLNA servers from crashing the Humax. File /mod/etc/init.d/S02dlna-filter contains rule="-p tcp --dport 50001 -j DROP". From default the package works on all IP addresses, however in Web-If >> Settings >> Settings for DLNA-Filter package, it is possible to restrict operation to one or more specified IP addresses

'''NOTES'''
*DLNA-Filter requires Custom Firmware Version 3.00 or later
*DLNA-Filter will block access to the Humax DLNA server if the Settings for DLNA-Filter package is left blank

==DLNA-Servername==

This package enables Humaxs on the same network to be given a unique Media Server Name. It requires that Custom Version 2.20 or above be installed

==Dropbear SSH==

A secure shell (ssh) server for the Humax. This package provides remote command line access over an encrypted session and is a secure alternative to using Telnet
to gain command line access - although it causes the box to do more work. Also allows the use of ''scp'' (secure copy) as a secure alternative to FTP.

Login with username=root, password=humax

Create file /mod/.ssh/authorized_keys containing a list of public keys

Note :- chmod 700 /mod/.ssh and chmod 600 /mod/.ssh/authorized_keys

==Dropbear SFTP==

Greenend-sftp is a plugin for dropbear-ssh which provides SFTP server functionality.SFTP is often used to provide remote virtual filesystem (VFS) access to the Humax's filesystem, e.g. via FUSE. For further info. click link [http://www.greenend.org.uk/rjk/sftpserver/ '''HERE''']

==DUMA==

D.U.M.A. - Detect Unintended Memory Access - A Red-Zone memory allocator. It can detect memory leaks and buffer overruns (or underruns) in a malloc() / new memory buffer. DUMA is a fork of Bruce Perens' Electric Fence library.

==Dvbsnoop==

Utility for inspecting DVB files. Some more info [http://dvbsnoop.sourceforge.net/ '''HERE'''].

Note that one cannot inspect live streams off air on the Humax, as the Humax doesn't provide the required software interface to its DVB hardware.

==E2fs_Progs==

Ext2/3/4 File system Utilities. The Linux File Disk system used on the Humax. Useful for formatting a USB Flash drive in EXT2 to avoid journalling. First allow the Humax to format the drive as EXT3 then follow the procedure [[FAQs#How_do_I_convert_a_drive_to_EXT2.3F|'''HERE''']].

==[Eject]==
[[File:Eject.png|left|50px]]
The Eject icon is displayed (If a USB Device is detected), on all Web-if Headers adjacent to the FREEVIEW icon, when the user clicks on this icon, a list of USB devices attached to the Humax will be displayed with the following information (from Left to Right) :-

*USB interface name
*USB Device name
*Format type, e.g. FAT32, NTFS, EXT3 etc.
*Device % used
*Device capacity
*Eject Option

To the far right there is an eject icon, when the user clicks on this icon, an option will be displayed, e.g. "Eject USB-1? - OK or Cancel, If OK is selected the USB device will be unmounted, this is similar to the Windows option "Safely Remove Hardware"

If 'Device not mounted' is displayed, the user can click on the recycle icon (far right) to display a 'Rescan OK/Cancel' option, this will allow a rescan and the USB device will be re-mounted

'''NOTES'''
*This feature is only present on the HDR-FOX T2, not the HD-FOX T2

==EPG==

The command line utility used by the Electronic Program Guide in the Web-If e.g. :-

<pre>
humax# epg
Humax EPG Tool v1.0.8, by af123, 2011.

Syntax: epg [options] [filters] <command>...

Options:
-b Brief output.
-d[level] Set debug level.
-f<file> Specify alternate EPG data file.
-h Show help text.
-p Parsable output.

Filters: (can be specified multiple times, all must be true)
-C<CRID> Show only events with this CRID.
-D<descriptor type> Show only selected descriptor type.
-E<event id> Show only selected event.
-R<SCRID> Show only events with this Series ID.
-S<service id> Show only selected service.
-T<content type> Show only selected content types.
-@<unix timestamp> Show only programmes at time.
-/<unix timestamp> Show only programmes on day.
-/<days> Show only programmes on day.
-=<start>:<end> Show only programmes in time period.

Commands:
dump Show a parsed summary of the EPG.
dumpraw Show raw data from the EPG.
sqldump Produce SQL statements from EPG data.
sqlitedump <file> Create SQLite database from EPG data.
now Show what is currently on.
first Show the time of the earliest record.
last Show the time of the latest record.
parse Parse the EPG, no output.
search <text> Search programme names for text.
searchall <text> Search programme names/descriptions for text.
</pre>

==Epgfix==

epgfix causes a channel change once a day (by default at 4am) for 3 minutes before restoring the original channel it was tuned to. This is enough to trigger the Humax software to keep the EPG up to date when the Humax is on 24/7, (it has no advantage when the unit has a daily on/standby cycle).

You need at least a single service on an alternative mux. to the one the box is tuned to for it to work. Changing to a different service on the same mux. was found not to work reliably enough.

There is no user interface, no settings and nothing to configure. The only thing you can change is the time of operation if it is not suitable!
You have to do this manually by editing the /mod/bin/epgfix entry in the /mod/var/spool/cron/crontabs/root file. This is easily available using the File Editor on the WebIf's Diagnostics page.

==Epg Keywords (Web-If)==

This package was a web interface plugin which allowed a list of keywords to be configured and when found an email was sent Weekly to a specified email address detailing any programmes in the EPG which matched the keywords.

NOTE:- The EPG Keywords functionality has now been moved to [[Remote_Scheduling_Auto | '''Remote Scheduling Auto''']].

Initial Setup :-
*Web-If MAIN >> SETTINGS >> Email address >> myname@talktalk.co.uk
*Web-If MAIN >> SETTINGS >> SMTP >> smtp.talktalk.co.uk
*Web-If MAIN >> SETTINGS >> SEND TEST EMAIL

==Epgpatch==

Utility for patching EPG information in a completed recording, it is used to fix problems in TV areas that use non standard EPG data e.g. Ireland Saorview

==Enable Telnet==

This USB loaded package will re-enable telnet for the Custom Firmware, it performs the following command lines :-

<pre>
rm -f /var/lib/humaxtv/mod/notelnet
/etc/init.d/S50telnet start << /dev/null >> /dev/null 2>&1
</pre>

==Exfat==

This package adds support for reading and writing files in the Exfat format

Please take the time to read the [http://en.wikipedia.org/wiki/ExFAT '''Wikipedia'''] article on exFAT

==Exfat Builder==

'''See Exfat above'''

[[File:exfat-panel.png|right]]
'''Note that this package does not add exFAT support to your system, only provides a simple method for you to do it yourself.''' This is because there are licence and patent issues around exFAT and if we were to make the compiled exFAT code available in the repository then we would be in violation of at least some of them.

The package provides a web page (accessible from the standard web interface settings screen) from which you can download, build and install the required files in a single step. It will:

*Download an open-source exFAT implementation from Google Code;
*Unpack and modify the code to support the Humax;
*Compile the files into binaries which can run on the Humax;
*Install the compiled binaries on your system;
*Add hooks to automatically mount exFAT disks when they are detected.

==EXTRA.css==

See [[Custom_Firmware_Package_Notes#Webif_Style_Sheet|'''Webif Style Sheet''']]

==Fan==

the default fan speeds set by humax are :-
*70% - once the HDD temperature reaches 55°C
*65% - when the temperature drops to 54°C
*55% - when the temperature drops to 51°C
*0% - when the temperature drops to 49°C

This utility allows the user to set a minimum continuous fan speed between 0% and 100%, By setting a minimum fan speed higher than zero it is possible to prevent the fan reaching the noisier 70% setting. If the Humax requests a higher speed setting, this higher speed will be used

'''Notes'''

*After an initial Humax restart, this package can change the minimum fan speed on-the-fly every two minutes
*The fanspeed (0 - 255) is stored in the /mod/boot/fanspeed file
*Changes made by this package will be displayed in the /tmp/humaxtv.log file, if Diagnostics >> debugtv >> Run Diagnostic has been run

<pre>
Editing /tmp/humaxtv.log
Sun Sep 15 10:42:36 2013 Applying minimum fan speed = 255 (ff)
Sun Sep 15 10:44:36 2013 Applying minimum fan speed = 0 (0)
</pre>

==Ffmpeg==

FFmpeg will record, convert, extract and stream audio and video. It includes libavcodec - the leading audio/video codec library. It also displays information about video and audio files. See Link [http://ffmpeg.org/ffmpeg.html '''HERE''']

NOTE:- Ffmpeg operations performed on the Humax can be very demanding on CPU time, especially when performing conversions rather than extractions. The following examples were carried out using a version of Ffmpeg running on a P.C.rather than on the Humax.

Convert an extracted MP3 audio file in MP2 format to the more common MP3:-

 ffmpeg -i input.ts -vn -ar 44100 -ac 2 -ab 192000 -f mp3 output.mp3

Extract an MPG file from a Hi-Definition TS file from the Humax :-

 ffmpeg -i input.ts -target pal-dvd -vcodec copy -acodec copy output.mpeg

There is also a GUI from end available for the P.C. version of ffmpeg [http://avanti.arrozcru.org/'''HERE''']

==Fix-disk==

Fix-Disk is a disk partition repair utility (built into Custom Firmware Ver 2.12 and above) for the Humax HDR-Fox T2. It does a full file system check, repairing minor faults automatically as it goes. It will also allow you to fix the delete loop problem. A fix-disk.log file will be generated in /mod/tmp/ and can be viewed using Web-If >> Diagnostics >> View Log Files

To invoke the Fix-Disk utility follow the Maintenance Mode Guide [[Maintenance_Mode | '''HERE''']]

==Fix-disk (USB)==

As fix-disk is now built into Custom Firmware 2.12 and is therefore already resident on your hard drive, the USB version is no longer recommended or supported. However it is still available [[http://www66.zippyshare.com/v/44898524/file.html '''HERE''']].

==Flatten==

This feature changes how recorded programs are displayed on screen in the 'Media - My Video' menu. Series of programs are normally grouped into a sub-folder. Flatten will move the contents of sub-folders to the main 'Top' folder and remove empty sub-folders. After installing flatten the Web-If will have an option under OPT+ which lets you toggle directories between flatten and no-flatten.

'''NOTES'''
#All directories will default to have flatten turned on unless they are changed
#Flatten runs every 15 Minutes when the box is not in standby

'''Exceptions'''

* Folders marked as no flatten using the OPT+ option will not be flattened
* Folders whose names are bounded by square brackets e.g. [NOT THIS ONE] will not be flattened
* Folders containing a file called .noflatten will not be flattened (Note:- Create this file Via Telnet)

==Flatview==

FlatView is an alternative to flatten, it provides both a flattened view and a hierarchical view at the same time by creating a new top-level directory (called " [FlatView]" by default). Recordings appear in both without using any additional disk space

'''NOTES'''

*Recordings deleted from the flattened view area are automatically removed from the original location in the hierarchy and the original folder will be removed if it is empty;
*Recordings deleted from the hierarchical view will be automatically removed from the flattened area too;
*If a recording is renamed in either area, then the change will be reflected in the other (there may be a small delay);
*Changes in flags such as 'Unwatched' and the resume point are synchronised across the two locations;
*If you move a recording out of the flattened view area, the system will think that it has been deleted and will remove the corresponding recording from the hierarchical view area;
*If you move a recording into the flattened view area, it will be left untouched
*Command line option = /mod/webif/plugin/flatview/run

'''Exceptions'''

*The contents of folders marked as no flatten using the OPT+ option will not appear in [Flatview]
*The contents of folders with names in square brackets [Like This] will not appear in [Flatview]
*The contents of folders containing a file named .noflatten will not appear in [Flatview]

==Flexget==

FlexGet is a multi-purpose automation tool for content like torrents, nzbs, pod-casts, comics, series, movies, etc. It can use different kinds of sources like RSS-feeds, html pages, csv files, search engines and there are even plugins for sites that do not provide any kind of useful feeds.

A Typical Cron entry for Flexget would be :-

 */1 * * * * /mod/bin/flexget -c /mod/.flexget/config.yml --cron 

* Flexget Documentation [http://flexget.com '''HERE''']

==Flexview==

FlexView is intended to offer an alternative to the traditional webif to allow you to view an manage your recording inventory in whatever way suits you

[[FlexView | '''See a Guide to Flexview''']]

==Forcedate==

This utility forces the date on your Humax to 16 November 2011 12:34:56. It is required if the Humax can't get Time / Date info Over The Air. After using Forcedate it is possible to set time / date to internet time automatically on boot-up using [[Custom_Firmware_Package_Notes#Ntp_Client | '''NTP Client''']].

==Foscam==

See Guide [[Custom_TV_Portal#Portal_Foscam | '''HERE''']].

==FTP==

File Transfer Protocol is a method of transferring files to and from your Humax. The Humax HDR-Fox T2 has a built-in FTP server for access to the media folders only. See the [[Custom_Firmware_Package_Notes#Betaftpd |'''Betaftpd package''' ]] for access to the full Humax file structure or to add an FTP server to the HD-Fox T2. To use FTP on a P.C. a program that handles FTP is required. Internet Explorer and Windows (file) Explorer will allow FTP access by entering ftp://10.0.0.200 into the address bar, although access may be restricted to media folders only, even when using the Betaftpd package. If access to the whole file structure is required, programs like Filezilla or WS_FTP_Pro can be used.

Notes :-
* To use the Built-In Humax FTP server MENU >> Settings >> System >> Internet Settings >> FTP Server = ON
* When using Betaftpd MENU >> Settings >> System >> Internet Settings >> FTP Server = OFF
* 10.0.0.200 needs to be replaced with your own Humax IP address
* login = humaxftp
* password = 0000 (your Remote Pin default). If the remote password has been changed from 0000 then the new password must be used

==Foxlink==

Helper package for linking a HD Fox-T2 to a HDR, See [[Foxlink|'''Guide Here''']]

==Fuse==

With FUSE it is possible to implement a fully functional filesystem in a userspace program.

==Genre Icons==

It is possible to inhibit the Genre Icons displayed in the Web-If, see [[Custom_Firmware_Package_Notes#Webif_Style_Sheet | ''' Web-If Style Sheet''']]

==Git==

Distributed version control system designed to handle everything from small to very large projects with speed and efficiency.

==Grep==

Grep is built into Busybox and is used to search through a file or files looking for specified blocks of text. The output can be displayed on-screen or sent to a new file. [http://unixhelp.ed.ac.uk/CGI/man-cgi?egrep Syntax Here]

Associated utilities = Egrep, Fgrep

<pre>
humax# cat original-file.txt

-H Add 'filename:' prefix
-h Do not add 'filename:' prefix
-n Add 'line_no:' prefix
-l Show only names of files that match
-L Show only names of files that don't match
-c Show only count of matching lines
-o Show only the matching part of line
-q Quiet. Return 0 if PATTERN is found, 1 otherwise
-v Select non-matching lines
-s Suppress open and read errors
-r Recurse
-i Ignore case
-w Match whole words only
-F PATTERN is a literal (not regexp)
-E PATTERN is an extended regexp
-m N Match up to N times per file
-A N Print N lines of trailing context
-B N Print N lines of leading context
-C N Same as '-A N -B N'
-e PTRN Pattern to match
-f FILE Read pattern from file

humax# grep match original-file.txt
-l Show only names of files that match
-L Show only names of files that don't match
-c Show only count of matching lines
-o Show only the matching part of line
-v Select non-matching lines
-e PTRN Pattern to match
humax#
</pre>

==Gnu Fdisk==

GNU fdisk.

==Hdparm==

hdparm is a command line utility for setting and viewing ATA hard disk drive hardware parameters. It can set parameters such as drive caches, sleep mode, power management, acoustic management, and DMA settings.

==HMT==

This package displays information on, and allows editing of, the Humax *.hmt file, which is a small 'side-car' file created alongside the main *.ts video file.

From a Telnet session, navigate to a directory containing an *.hmt file, then enter hmt {filename}

 hmt KAISER_CHIEFS_DD5_1_20110410_0147.hmt 

'''hmt Options List'''
<pre>
humax# hmt
Humax HMT Tool v2.0.6, by af123, 2011-2015.

Syntax: hmt [command] <filename> [filename] ...
Commands:
+/-new Mark/unmark recording as new.
+/-lock Mark/unmark recording as locked.
+/-guidance Mark/unmark recording as having guidance.
+/-protect Enable/disable protection (prevents decryption on copy).
+/-encrypted Mark/unmark recording as encrypted.
+/-shrunk Mark/unmark recording as shrunk.
+/-dedup Mark/unmark recording as deduped.
+/-detectads Mark/unmark recording as ad-detection-done.
-p Display parseable file information (see *).
-list Display file information (default).
-bookmarks Display bookmarks.
+addbookmark=<seconds>[:<seconds>]...
+setbookmarks=<seconds>[:<seconds>]...
+clearbookmarks
+settitle=<new title>
+setsynopsis=<new synopsis>
+setguidance=<new guidance>
+setfolder=<new folder> (patch hmt only)
+setfilename=<new filename> (patch hmt only)
+setgenre=<genre> (can just specifiy initial part)
+setresume=<resume point (seconds)> (-seconds to set from end)

Generic patch commands:
+patch8=offset:value patch 8-bit value
+patch16=offset:value patch 16-bit value
+patch32=offset:value patch 32-bit value
Offset and value can be preceeded with 0x to indicate hex.

Generic read commands:
+read8=offset read 8-bit value
+read16=offset read 16-bit value
+read32=offset read 32-bit value
Offset can be preceeded with 0x to indicate hex.

* Parseable output is tab delimited and contains the following fields:
Title, Synopsis, HD/SD, LCN, Channel Name,
Start time, End time, Flags, Guidance, Bookmark count,
Scheduled start, Scheduled duration, Genre code,
Resume point, Status/Reason.

</pre>

'''Notes'''
*+addbookmark=100:200:300 = Add to existing bookmark list
*+setbookmarks=100:200:300 = replace bookmark list with this new ones
*+setbookmarks= = same as +clearbookmarks i.e. remove all bookmarks

==hmt-linux==

A version of hmt compiled to run on a Linux platform (not for the Humax)

==hmt-solaris==

A version of hmt compiled to run on a Solaris platform (not for the Humax)

==Hrwconv==

Wrapper script for ffmpeg and sidecar packages to convert 9200T/9150T/9300T files to HDR format

It is recommended that you create a new directory and move your existing 9200T/9150T/9300T files and their sidecars into it, Hrwconv will not make any changes to the originals but will create new files so you will need to ensure that you have enough free disk space.

After installing the package, connect to the Humax via Telnet, change directory 'cd' to the new directory and then run:-

<pre>hrwconv *.ts</pre>

After a few hours the new files will have been created in the subdirectory 'new'

==HTTPS==

HyperText Transfer Protocol Secure is an extra layer built into the normal HTTP protocol used to access the Web-Interface for the Humax, It provides a more secure connection to the Humax. An HTTPS Server can be enabled in Web-If >> Settings >> General Settings >> HTTPS web server = On

==Humaxrw==

Utility to copy recordings from a Humax 9200T/9150T/9300T hard disk that is connected to the HDR via USB. The files recorded on 9000 series Humaxs are playable on the HDR, however the HDR can't directly read a hard disk formatted on a 9000 series, Humaxrw will allow the transfer of files between 9000 series and the HDR.

After installing Humaxrw, access to the utility is by [[Custom_Firmware_Package_Notes#Telnet | '''Telnet''']] command line.

<pre>
humax# humaxrw -h
Host <-> Humax disk
===================
Usage: humaxrw [options] HUMAXDISK

-b backup all recordings from Humax disk to current directory
-d <list> delete recordings
-g <list> get recordings to current directory
-h help (this text)
-i <list> get info for recordings
-l list recordings
-p <filename> put recording(s) onto Humax disk
-u <list> unprotect recordings
-v version
-x extended listing for humaxdiag
-w pause at the end waiting for a keypress
-y answer yes to all prompts

Advanced Options
-D Delete time shift recording buffers
-E Update all synopsis/info data for version 1.00.20 or later
-H <list> get hre files for recordings
-M <n> modify recording number n (use with -O & -V options)
-O <n> offset for modify recording (use with -M & -V options)
-V <n> modify recording value (use with -M & -O options)
-Z Delete EPG save data

Humax disk -> Humax disk
========================
Usage: humaxrw [options] SRCHUMAXDISK DESTHUMAXDISK

-b backup all recordings from source Humax disk
and copy to destination Humax disk
-g <list> get recordings from source disk
and copy to destination Humax disk

Recovery mode - use if record list is missing/corrupt
=============
Usage: humaxrw -r [options] HUMAXDISK

-i <list> get info for recordings
-l list recordings
-n no info - use if corruption is really bad
-g <list> get recordings to current directory as recover_nnnn.ts

Example of a list: 10-20,30,41-42
</pre>

==Humidify==

A utility for manipulating Humax Download Format (HDF) files.
<pre>
humax# humidify
HDF Tool v1.0.4, by af123, 2011-2015.

Syntax: humidify [options] <filename>
-C Skip checksum validation.
-c <arguments> Create HDF file ('-c help' for more).
-d<level> Enable debugging at level.
-l Show contents of HDF file (default).
-o Use old-style checksum blocks when creating.
-r Don't compress blocks when creating.
-S<section> Extract only the numbered section.
-t Test archive (validate checksums).
-x Extract files.
-s Also show/extract member checksums.

Examples:

View HDF: humidify file.hdf
Test HDF: humidify -t file.hdf
Extract HDF: humidify -x file.hdf
Create HDF: humidify -c file.hdf (run 'humidify -c help' for more)

</pre>

A cross platform version of Humidify can be downloaded from the packages page, [[Customised_Firmware_-_Features_Available#Miscellaneous_Software_Utilities | '''HERE''']]
It contains the following files:-

[[File:Humidify-1.0.2.zip.jpg]]

==Hwctl==

Hardware control utility - Use with caution ! ! !

==Id3v2==

A command line ID3v1.1 tagger for MP3 files. See also See also [[#Popol |'''Popol''']].

Available commands:

<pre>
-h, --help Display this help and exit
-f, --list-frames Display all possible frames for id3v2
-L, --list-genres Lists all id3v1 genres
-v, --version Display version information and exit
-l, --list Lists the tag(s) on the file(s)
-R, --list-rfc822 Lists using an rfc822-style format for output
-d, --delete-v2 Deletes id3v2 tags
-s, --delete-v1 Deletes id3v1 tags
-D, --delete-all Deletes both id3v1 and id3v2 tags
-C, --convert Converts id3v1 tag to id3v2
-1, --id3v1-only Writes only id3v1 tag
-2, --id3v2-only Writes only id3v2 tag
-a, --artist "ARTIST" Set the artist information
-A, --album "ALBUM" Set the album title information
-t, --song "SONG" Set the song title information
-c, --comment "DESCRIPTION":"COMMENT":"LANGUAGE"
Set the comment information (both
description and language optional)
-g, --genre num Set the genre number
-y, --year num Set the year
-T, --track num/num Set the track number/(optional) total tracks

You can set the value for any id3v2 frame by using '--' and then frame id
For example:
id3v2 --TIT3 "Monkey!" file.mp3
would set the "Subtitle/Description" frame to "Monkey!".
</pre>

==Inadyn==
A Dynamic DNS client with web configuration plug-in (see webif settings page). The log file is blanked whenever the box set to standby and a new one created when switched from standby.

For freedns.afraid.org the hostname in settings should be of the form:
xxxx.xxxxxxxx.xxxxx, <user name hash>
Where <user name hash> is obtained from the freedns website, when logged on

==In Use==

Utility for checking whether a recording is in use.

==I-Phone Interface==

An iphone optimised web interface for the Humax.

Screen Shots [[Smartphone_Web_Interface_Screenshots | '''HERE''']].

==Ir (Web-If Remote Controller)==

This package adds a fully functioning Remote Controller to the Web Interface. Full Details [[WebIf_Remote_Controller|'''HERE''']].

==lsof==

This unix command stands for LiSt of Open Files. With no extensions it will default to 'All' open files, but it is probably more useful when used with a filter as shown in the examples :-

 lsof | grep humaxtv HIDE All files opened by the main Humax TV process

 lsof | cut -f 1 -d' ' | sort | uniq HIDE List all processes that have opened files

 lsof | grep epg HIDE All files opened by the EPG process

<pre>humax# lsof | grep epg
epg 596 root cwd 0000 31,0 1307722938 21474853357 /dev
epg 596 root rtd 0000 31,0 1321652395 77309428205 /
epg 596 root txt 0000 8,18 1322689164 4295000557 /mnt/hd2/mod/bin/epg
epg 596 root mem REG 8,18 9226050 /mnt/hd2/mod/bin/epg (path inode=4295000557)
epg 596 root mem REG 31,0 174 /lib/ld-uClibc-0.9.29.so (path inode=4295000557)
epg 596 root mem REG 8,18 9225846 /mnt/hd2/mod/lib/libsqlite3.so.0.8.6 (path inode=4295000557)
epg 596 root mem REG 31,0 169 /lib/libuClibc-0.9.29.so (path inode=4295000448)
epg 596 root mem REG 31,0 216 /lib/libpthread-0.9.29.so (path inode=4295000448)
epg 596 root mem REG 31,0 186 /lib/libdl-0.9.29.so (path inode=4295000448)
epg 596 root 0 0000 31,0 1307722935 4294975926 /dev/null
epg 596 root 1 0000 0,13 1322848876 4295000502 /tmp/epgd.log
epg 596 root 2 0000 0,13 1322848858 4295000502 /tmp/modinit.log
</pre>

==Jim==

Jim is a form of the programming language TCL (Tool Command Language) that runs on the Humax unix platform.

==Jpnevulator==

Serial Port Sniffer.

==Joe==

Text Editor. See [[Custom_Firmware_Package_Notes#Text_Editors | '''Text Editors''']].

==Kernels==

An alternative Kernel for the HDR-Fox T2 is loadable via USB upgrade, the zip files contains copies of the standard kernels and a version with GUID/EFI support

==Lighttpd==

Lighttpd is a replacement for the mongoose Web server used on the Humax to handle it's Web-If pages. [[Web_Interface_Screenshots | '''SEE EXAMPLES''']]

For more information on lighttpd click [http://www.lighttpd.net/ '''HERE''']

==LDD==

ldd prints the shared libraries required by each program or shared library specified on the command line

==Libpcre==

Perl-compatible Regular Expressions Library

==Libunwind==

Utility used with the Crashdiag package

==LibParted==

Library for the [[#Parted|'''Parted''']] package

==Libsndfile==

A C library for reading and writing files containing sampled sound.

==Loaders==

{{Warning|title=WARNING !|Although the installation of a new loader only takes a few seconds (unlike a full firmware change), it is imperative that there is no power interruption during the process as this could cause the Humax to become permanently inoperative (bricked)}}

The Loader - sometimes called the Boot Loader is a small routine that the Humax runs on start-up, the version of your Loader is displayed in the lower left hand corner of the Humax screen immediately after the unit is taken out of standby, there are currently 4 loader versions known to be installed on the HDR-Fox T2, they are :-
a730, a731, a733 and a734.

Different versions of loader may improve 'Green Screen' HDMI handshake problems found on some televisions, a link to the hummy.tv discussion can be found [https://hummy.tv/forum/threads/hdmi-issue-with-bravia.8203/page-2#post-116204 '''HERE''']

==M4==

GNU M4 is an implementation of the traditional Unix macro processor. More notes [http://www.gnu.org/software/m4/ '''HERE''']

==Maintenance Mode==

This is as special mode that the Humax can be placed in, to carry out checks etc. on the system. See Guide [[Maintenance_Mode|'''HERE''']]

==Mediatomb==
A UPnP Media Server, This package allows the HD T2 to stream content to other devices on your network, as the HD T2 does not have this facility built-in. There is a user Guide [http://mediatomb.cc/pages/documentation '''HERE''']

==Mongoose==

Mongoose was the Webserver that the Custom Firmware Package used to present Web pages, it has been replaced by Lighttpd.

==Multienv==

Helper utility for modifying the set top environment, Used by other packages.

==Multi-mode==

[[Multi-mode_Recording | '''See Guide HERE''']]

==Mvdisks==

Mounts external drives (connected via USB) under "My Video" to allow export by the DLNA server (HDR only)
Note:- It is possible to change the name of the moved USB directory from 'usb-disk' to another name by using Web-If >> Diagnostics >> File Editor and replacing 3 of the 4 'usb-disk's with a new name in the file /mod/etc/mdev/rmvdisks.The second occurrence of 'usb-disk' does not need changing

*Allows recording directly to a USB drive on the HDR
*Allows files on a USB drive to be served via DLNA (HDR only)

==Network Shares Automount==

Automatic mounting of remote nfs or smb directories, with configuration on the box, using special "settings" directories to add and configure shares. Remote host(s) are "pinged" regularly, and shares are mounting / unmounting automatically with host availability

Folders on a computer or NAS box can be shared with other devices on the same network. On the Humax box with custom firmware we can add support for two protocols - smb (used by Windows, pre-Lion OsX, linux running Samba), and nfs (Linux, OsX, common with NAS boxes). smb support is provided by the cifs package. We can "mount" the remote shared folder(s) so they appear as if they were part of the local file system on the Humax

This packages uses directory names in the "*Modsettings/smb" and/or "*Modsettings/nfs" folders to configure as many shares as you like. For example to set up a new smb share, use the opt+ button to create a new directory within the smb folder. Name it what you want the mount to be called (eg "MyPc") Wait about 10 seconds, and navigate into the new folder. The script should have created a load of template "configuration directories" for you to rename (host IP address, foldername, user, password etc).

'''Notes'''

#The "_" symbol is used instead of "." in IP names and "/" in folder names as these can't be input (or if they can I think the box changes them to a "_")
#Once configured, the script will regularly ping the host computer to see if it is available. If it is then the shared folder will be mounted and should be browsable. If the host goes offline, the folder will be unmounted, preventing the box from locking up.
#Wake up On LAN (WOL) is available to automatically power up compatible (newer) NAS boxes, The user must supply the MAC address of the NAS box and set wakeNow? to remove the '?' for a single wake or wakeConstantly? to remove the '?' to repeat every few seconds. A script called wakecmd in mod/sbin is now called up that contains both ether-wake and the WOL script
#If option ShareFolder = off, the mount will appear in the USB section and either a real USB device or virtual2 must be installed
#If option ShareFolder = on, the mount will appear under 'My Video'
[[File:warning-anim.gif|100px|left]]
''' DELETING THE MY VIDEO/[SHARES] FOLDER WILL DELETE FILES ON YOUR REMOTE COMPUTER / LAPTOP/ NAS ETC. '''

To safely remove the [Shares] DO NOT DELETE folder :-
#Delete the configuration file created in [ModSettings]/NFS or [Modsettings]/SMB
#reboot the Humax
#Ensure there are no active shares in the [Shares] folder
#Turn off the remote device holding the shared files
#Delete the [Shares] DO NOT DELETE folder

==Nano==

Text Editor, See [[Custom_Firmware_Package_Notes#Text_Editors | '''Text Editors''']]

==New Portal==

This package adds a new front-end to the standard Humax TV Portal, See guide [[Custom_TV_Portal | ''' HERE''']]

==Newk==

This utility will create a folder on the hard disk with a chosen prefix removed, in order to tidy-up the folder title, so for example when recording a new series called "New: The Walking Dead" a folder will be created called "The Walking Dead" and all new recordings will be placed into it, if the prefix "New: " is placed in Webif >> Settings >> Automatic Series Prefix Removal settings.

Note:- Existing series folder will not be renamed by the Newk package

==Nicesplice==

A recorded program editing utility, See [[Edit_On_Box | '''Edit On box Guide''']], Nicesplice also 'Shrinks' the file using [[Custom_Firmware_Package_Notes#Stripts|'''Stripts''']]

==Nsplice==

Nsplice is supplied with the '''[[DetectAds]]''' package, it is a version of the Nicesplice program modified to accept commands from stdin instead of the command line and to make the output recording visible as it is processed to permit chase playing. The .nts for the -dec file input to splice is a hard link to the .nts for the input recording.

==NTFS 3g==

Read/write NTFS disk access. Out of the box the Humax can only read NTFS formatted drives but this package upgrades that support to full read/write access

==NTFS Progs==

This utility contains diagnostic tools and a utililty to format a partition as NTFS

==Ntp Client==

Network Time Protocol sets the Humax clock from an Internet time server on each boot. Useful if you do not have an aerial connection or your Humax doesn't keep good time. Ntpclient runs with the -l option which also adjusts the time in between system boots.

Note :- This utility may also need [[Custom_Firmware_Package_Notes#Forcedate | '''Forcedate''']] to be loaded, In order to get the date near the current as NTP won't change a time / Date that is too far out. More notes [http://doolittle.icarus.com/ntpclient/ '''HERE''']

==Nugget==

Nugget framework, handles a number of utilities sent from the commeand line, current option are :-

<pre>
nugget <command>
ping - Test nugget connectivity.
status - Show nugget status and version.
schedule.load - Load recording schedule from disk.
schedule.save - Save recording schedule to disk.
schedule.slot - Update timers for schedule slot.
schedule.db - sqlite3 database handle info.
schedule.epg - Display EPG information for slot.
schedule.timers - Show internal timers.
cryptokey - Set or display encryption key.
</pre>

==OPKG==

Open PacKaGe Management is the tool used to handle Custom Firmware packages, Here Are some examples :-

opkgHID= list all opkg commands

opkg install http://hummypkg.org.uk/hdrfoxt2/base/auto-unprotect_1.0.6_mipsel.opk HID= Install a remote package

opkg download auto-unprotect HID= download current version of a remote package (Version number not allowed)

opkg listHID= list of available packages

opkg list-installedHID= list of installed packages

opkg remove auto-unprotectHID= uninstall a package Note: No version numbers

 opkg install undelete --force-reinstall HID= Force a package reinstall

 opkg whatdepends anacron HID= Show dependants

==Opkg-beta==

When this package is installed beta versions of installed packages will be made available in 'Package Management >> Upgrades' screen

==Parted==

GNU Partition Editor. On-line User Manual [http://www.gnu.org/software/parted/manual/parted.html#Introduction '''HERE]

==Popol==

A command line ID3v1.1 tagger for MP3 files, If is possible to insert the following fields into an MP3 ID3 header. See also See also [[#Id3v2 |'''Id3v2''']]

<pre>

-s, --songname set songname
-a, --artist set artist
-l, --album set album
-c, --comment set comment
-y, --year set release year
-t, --tracknum set track number

</pre>

==Portal Foscam==

See [[Custom_TV_Portal#Portal_Foscam | '''GUIDE''']]

==Portal Xtra1==

See Guide [[Custom_TV_Portal#Portal_Xtra1 | '''HERE''']]

==Portal Xtra1 (USB)==

This is a version of the Portal Xtra1 that runs in Flash memory, this package was built to run on the Humax HD-Fox T2 without an External Hard Disk Drive and is installed Via USB only. See Guide [[Custom_TV_Portal#Portal_Xtra1 | '''HERE''']]

==Poweron-Channel==

NOTE:- This package was replaced by the Boot-Settings package with the release of Webif 1.4

This Utility forces the Humax to always power up on a selected TV channel regardless of the last channel viewed, After installing the Poweron-Channel package, select options in Web-If >> Settings >> Settings for poc package >> Click here for settings

*Power-On Channel = Selected TV Channel for start-up (See note 1)
*Volume = 0-20 or Last Audio Volume
*Power-On Channel Group = Select Favourites List or None

*Disable Subtitles on every boot (See Note 3)
*Turn the DLNA server on at every boot (See Note 3)

'''NOTES'''
# Ensure that the selected Poweron TV channel is included in the selected Favourite group
#A scheduled wake-up will use the channel set in the on-TV menus at Settings>>Preferences>>Time>>Channel not the Power-On Channel settings
# Only available by editing /mod/boot/pox using Diagnostics >> File Editor (details below)
# The parameters set by Poweron-Channel are contained in the /var/lib/humaxtv/setup.db database, other items may be added to the pox file from this database, but please use extreme caution, their functions are not fully understood
<pre>
humax# cat /mod/boot/pox
# Poweron-channel additional options.

# Example: uncomment the following line to disable subtitles on every boot
#TBL_MENUCONFIG:SUBTITLE_DISPLAY_F:1

# Example: uncomment the following line to turn the DLNA server on at each
# boot in case it has been turned off.
#TBL_MENUCONFIG:DMS_START_ON:1

</pre>

==Procps==

procps is the package that has a bunch of small useful utilities that give information about processes using the /proc file system. The package includes the programs ps, top, vmstat, w, kill, free, slabtop, and skill.Version 3 includes NPTL thread support, a rewritten top, many bug fixes, performance improvements, and new features. Link [http://procps.sourceforge.net/ '''HERE''']

==Prog Backup==

Utility for backing up recordings and side-car files to locally attached drives, A search of attached drives will be made so that the user can choose. Both Hi-Def and Standard definition recordings will be de-crypted so they can be played on a P.C. or copied back to a different Humax. Command line examples Below :-

 progbackup HIDE Backup everything under My Video

 progbackup "/mnt/hd2/My Video/BOB's Films/" HIDE Backup files in a specified folder

'''NOTE:-''' Make sure to use the quotation marks around the directory name.

==Python==

A package that adds the Python programming language

==Python Setuptools==

Setup tools including Easy_Install for the Python programming language, see notes [[http://pypi.python.org/pypi/setuptools#using-setuptools-and-easyinstall|'''HERE''']]

==Qtube==

Simple webif to queue youtube downloads to run in the Auto process queue, see [[Custom_Firmware_Package_Notes#Youtube-dl | '''Youtube-dl''']]

==Recmon==

Utility for executing another process whenever a recording starts or finishes

Recmon runs every script in /mod/etc/recmon.d in response to events. The order that they are run in is not guaranteed (they actually run in parallel).
The commands are run with two arguments, a switch saying which event triggered this and the base name of the recording file (no extension).

e.g.

/mod/etc/recmon.d/test -start "/media/My Video/path/to/recording"

Flags are -start, -stop, -move and -delete. Usually -move is called twice, once for the source location and once for the destination.

Examples
<pre>
/mod/etc/recmon.d/auto-unprotect -start "/media/My Video/The Resident_20150520_0007"
/mod/etc/recmon.d/auto-unprotect -stop "/media/My Video/The Resident_20150520_0007"
</pre>

==Rc app bridge==

Utility that enables the Humax HDR-Fox T2 to be controlled by the TV Remote App. (supplied by Humax) that runs on the I-Phone, the same App. is also available on the Android platform, however version HMARG 1.0.4 does not appear to work with this package

'''Notes'''
* This package requires Content Share to be enabled

==Real Time Scheduling (RTS)==

When the Custom Firmware was developed, Scheduled events created in the Web-If or Via Remote Scheduling were placed into a pending queue and only moved into the main schedule on the next boot or reboot, In Web-If version 1.3.2-1 and later, it is possible to automatically progress from the 'Pending' stage directly to a fully scheduled stage without the Humax having to perform a boot cycle. This option can be enabled / disabled with the :- Settings >> Advanced Settings >> Real Time Scheduling Yes / No option

==Redring ==

Causes the Humax to display a Red LED ring when recording in standby, plus various other front panel options detailed in the table below. The new settings are configurable using the Web-If >> Settings >> Redring Settings

{| border="1"
|+ '''GENERAL SETTINGS'''
! width="250"| Humax Status
! width="100"|Humax Default
! width="150"|With Redring
! width="100"|Redring Setting
|-
! align="left" |Show Purple When dual Recording
! 11% Amber
! bgcolor=#ffbbbb | Purple
! bgcolor=#ffbbbb | On / Off
|-
! align="left" |Enable Debugging Log
! N/A
! bgcolor=#ffbbbb | Debug
! bgcolor=#ffbbbb | On / Off
|}

{| border="1"
|+ '''WHEN FULLY AWAKE i.e. TV Display = On'''
! width="250"|Humax Status
! width="100"|Humax Default
! width="150"|With Redring
! width="100"|Redring Setting
|-
! align="left" |Disable Screen Scrolling
! Scrolling On
! bgcolor=#ffbbbb | Scrolling Off
! bgcolor=#ffbbbb | On / Off
|-
! align="left" |Enable Clock
! Clock Off
! bgcolor=#ffbbbb | Clock On
! bgcolor=#ffbbbb | On / Off
|-
! align="left" |Show Elapsed Time During Playback
! N/A
! bgcolor=#ffbbbb | Elapsed Time
! bgcolor=#ffbbbb | On / Off
|-
! align="left" |Show Play HH:MM Instead of Clock
! N/A
! bgcolor=#ffbbbb | HH:MM
! bgcolor=#ffbbbb | On / Off
|-
! align="left" |Override LED Ring Brightness
Blue Brightness

Red Brightness
! Fixed
100% > 50%

after 3 Mins.
! bgcolor=#ffbbbb | Switchable Override
Variable

Variable
! bgcolor=#ffbbbb | On / Off
0% to 100%

0% to 100%
|-
! align="left" |Override Display Brightness
Brightness
! Fixed
Fixed
! bgcolor=#ffbbbb | Switchable Override
Variable
! bgcolor=#ffbbbb | On / Off
0% to 100%
|-
! align="left" |Override Playback Display Brightness
Brightness
! Fixed
Fixed
! bgcolor=#ffbbbb | Switchable Override
Variable
! bgcolor=#ffbbbb | On / Off
0% to 100%
|}

{| border="1"
|+ '''WHEN HALF AWAKE i.e. Waiting / Recording from standby or OTA Search'''
! width="250"|Humax Status
! width="100"|Humax Default
! width="150"|With Redring
! width="100"|Redring Setting
|-
! align="left" |Show Blue LED Ring
Brightness
! Fixed
11% Amber
! bgcolor=#ffbbbb | Switchable Blue
Variable
! bgcolor=#ffbbbb | On / Off
10% to 100%
|-
! align="left" |Show Red LED Ring (Recording)
Brightness
! Fixed
11% Amber
! bgcolor=#ffbbbb | Switchable Red
Variable
! bgcolor=#ffbbbb | On / Off
10% to 100%
|}

{| border="1"
|+ '''WHEN IN STANDBY i.e. Hard Disk Not Spinning'''
! width="250"|Humax Status
! width="100"|Humax Default
! width="150"|With Redring
! width="100"|Redring Setting
|-
! align="left" |Override LED Ring Brightness
Brightness
! Fixed
11% Amber
! bgcolor=#ffbbbb | Switchable Override
Amber Brightness
! bgcolor=#ffbbbb | On / Off
0% to 100%
|-
! align="left" |Override Display Brightness
Brightness
! Fixed
11%
! bgcolor=#ffbbbb | Switchable Override
Variable
! bgcolor=#ffbbbb | On / Off
0% to 100%
|}

 HIDE ** = Change from Humax default

'''Notes'''

*Redring can cause slight delay of Remote Control key presses, e.g. Pause etc.
*Problems writing to the /mod/tmp/redring.log will be listed in the /var/log/humaxtv.log after diagnostics >> debugtv is run

==Renumber==
[[File:renumber.png|200px|thumb|right]]
Channel re-numbering support, for each channel that you wish to change, enter a new number into the box and save changes. Next time you reboot your Humax, the channel numbers will change around. If you ever rescan the channels on your box then the next time you reboot they will be automatically changed to match your saved preference. Once installed, a new option will be shown in the Web Interface Settings screen, probably near the bottom.

Renumbering channels is useful for people who want to swap the high-definitions services with their standard-definition counterparts, e.g. swap BBC ONE for BBC ONE HD putting BBC ONE HD on channel 1, and can also be used to re-order channels (e.g. move BBC HD to channel 8) to be closer to the start of the EPG. Of course another way to achieve this is to use the standard favourites feature in the Humax software to define your own list of channels and order them to suit.

'''Notes'''

*The renumber settings appears under the "reorder" section of the settings page on the Web-If
*The [[Custom_Firmware_Package_Notes#Tunefix | '''Tune Fix''']] package has replaced the Renumber package

==Reset Webif==

Reset Webif will clear out all of the custom firmware packages and files without affecting your recordings or scheduled recordings. It is designed to be executable by booting from a Flash USB device loaded with the Reset Webif utility and is useful when the 'Web-If >> Diagnostics >> Remove All Custom Firmware packages and settings' is not available, Wait for the light to stop flashing then remove the disk and reboot the Humax (using the remote control). If you point a web browser at the Humax then you'll be back at the initial installation interface.

==Remote Scheduling (RS)==

Remote Scheduling Service. Links your device to the remote scheduling portal so you can manage your scheduled recordings list from anywhere with an Internet connection and web browser

Full Guide[[Remote_Scheduling | '''HERE''']]

==Remote Scheduling Auto==

Full Guide[[Remote_Scheduling_Auto | '''HERE''']]

==Remote Scheduling Muti-Mode==

Full Guide[[Multi-mode_Recording#Multi-Mode_Recording_Via_RS_Portal | '''HERE''']]

==Remote Scheduling Mobile==

Full Guide[[Remote_Scheduling_Mobile_Edition#Multi-Mode_Recording_Via_RS_Portal | '''HERE''']]

==rs==

Command line tool that carries out a number of functions relating to the Remote Scheduling service, e.g. :-

<pre>
humax# rs
Humax Remote Scheduling Tool v1.3.1, by af123, 2011-2015.

Syntax: rs [options] <command>...

Options:
-d[level] Set debug level.
-D<seconds> Sleep for random(seconds).
-h Show help text.
-i Show detected machine info.
-q Be more quiet.

Commands:
register <email> Register this device.
push Push scheduled events.
cmd Retrieve next queued command.
ack <id> Acknowledge command <id>.
status Show device registration status.
log <msg> Send log message to server.
epg Distributed EPG management.

</pre>

==rs time==

Command line utility that returns a number in seconds, that indicates the time offset between your Humax unit and the Remote Servers time

==RMA==

The Return to MAnufacturer Web-If option under [[Diagnostic_Utilities |'''Diagnostics''']] removes Custom Firmware files from the internal hard disk drive of the HDR Fox T2, following an RMA the user should re-install a version of official Humax Software to complete the 'Out of the Box' status of the Humax

'''Notes'''
* After running the procedure, 'RMA' will be displayed in the front panel display, this message should be removed after the official Humax Software is installed, however if the message is still present, it is possible to remove it by running the [[#DeRMA | '''DeRMA''']] USB package
* More options for removing the Custom Firmware are detailed in the [[Remove_Modified_Firmware | '''Remove Modified Firmware''']] page

==Rsvsync==

Boot-time reservation sync service

==Rsync==

A fast, versatile, remote (and local) file-copying tool, example :-

 rsync -avr --progress --delete --exclude 'Tsr/' mnt/hd2/ root@synology ip::NetBackup 

This [[Custom_Firmware_Package_Notes#Cron|'''cronjob''']] example would run at 01:05 each day, keeping the internal and external disks in sync - you just need to ensure the box is on at that time via a reminder or other mechanism.

 5 1 * * * /mod/bin/rsync --archive --delete-after --log-file=/mod/tmp/rsync.log /media/My\ Video/ /media/drive1/Video/ 

The Custom Firmware and Humax setup can be copied from an existing Humax to a new Humax by installing the rsync and dropbear packages on both units and then entering Maintenance Mode on the new Humax and sending the following two command lines :-

 rsync -avr <ip address of old humax>:/var/lib/humaxtv/ /var/lib/humaxtv/ 

 rsync -avr <ip address of old humax>:/mnt/hd2/mod/ /mnt/hd2/mod/ 

[http://ss64.com/bash/rsync.html '''More Info.''']

==rt3070==

This package was a replacement wireless driver which allowed for a wider range of wireless dongle vendor types, it was removed from the packages list because version 1.0 is not compatible with the latest 1.03.XX versions of Custom firmware

==Safe Mode==

Safe Mode is a package loaded onto the Humax via USB in the same way as a software upgrade, it temporarily switches off most Custom Firmware components (apart from a small web server that allows you to get back out of safe more when you want), there is a package called enablesafemode.spk to turn this feature on and another called disablesafemode.spk to turn it back off, they are available frrom the [[Firmware_Downloads | '''Firmware Download page''']]

'''Note''' if you have altered the encryption keys on your humax that any recordings made in safe mode will be made using the standard encryption and won't be, automatically, viewable when you return to normal mode.

==Samba==

Windows compatible file sharing. Allows access to the Humax file system from a computer on the same network. The file system is shared using Windows compatible sharing so can be access from Windows, MacOSX and most other operating systems. Samba operates using 'Server Message Block' (SMB), also known as Common Internet File System (CIFS) protocols

To map a network drive in windows :-

#Click Start, click My Network Places, click Entire Network, and then double-click Microsoft Windows Network.
#Double-click the domain that you want to open.
#Double-click the computer that has the shared resource you want to map. All the shared resources for that computer automatically appear in the window.
#Right-click the shared drive or folder that you want to map, and then click Map Network Drive.
#Click the drive letter that you want to use, and then specify whether you want to reconnect every time that you log on to your computer.
#Note Network drives are mapped by using letters starting from the letter Z. This is the default drive letter for the first mapped drive you create. However, you can select another letter if you want to use a letter other than Z.

Drive sizes can be incorrectly reported, to avoid this set path = /media/My Video in the /mod/etc/smb.conf file

'''Tips'''

#Ensure Samba is enabled in Web-If >> Service Management
#If the Windows 'WORKGROUP' has been changed from default, edit file /mod/etc/smb.conf to match the new name

==Schedchk==

Check scheduled recordings against EPG and reschedule, if possible, entries that don't match the EPG

See the [[Schedchk|user guide]] for further details

==Scons==

SCons is an Open Source software construction tool—that is, a next-generation build tool. Think of SCons as an improved, cross-platform substitute for the classic Make utility with integrated functionality similar to autoconf/automake and compiler caches such as ccache. In short, SCons is an easier, more reliable and faster way to build software

==Screensaver==

If you pause live TV for more than 3 Mins. you will see the current time displayed on the TV screen, This is a screensaver and is designed to prevent ‘burn-in’ on flat panel TVs. The digits are made up of a series of pictures that are stored on the Humax in this read only area :- /opt/share/images/blue/821-4, It is possible to change these pictures to remove the screensaver completely (Black) or use a different font. After a new screensaver package is loaded, it will automatically become the new screensaver, you can select from installed screensaver plug-ins using the Web-If >> Settings screen

When screensaver is first installed only ‘Humax default’ is present, this is the 'flip Clock' default screensaver, If Black is installed then a completely Blank screen will be displayed. All screensaver plug-ins can be installed separately from the Web-If, e.g. the first screensaver Plug-in shown below is called screensaver-3X5, here is a list of plug-ins available :-

{| border="1"
|-
!3X5
>>>
|[[File:3X5.png|200px]]
!Neon
>>>
|[[File:neon.png|200px]]
!Avatar
>>>
|[[File:avatar.png|200px]]
|-
! 7Seg
>>>
| [[File:7Seg.png|200px]]
! Neon-Blue
>>>
| [[File:neon-blue.png|200px]]
!Wedge
>>>
|[[File:Wedge.png|200px]]
|-
! Dot
>>>
| [[File:Dot.png|200px]]
! Agen
>>>
| [[File:Agen.png|200px]]
!Cursor
>>>
|[[File:Cursor.png|200px]]
|-
! VFD
>>>
| [[File:VFD.png|200px]]
! Glass-Blue
>>>
| [[File:glass-b.png|200px]]
!Maze
>>>
|[[File:Maze.png|200px]]
|}

'''screensaver-all''' = Install all current screensavers from the package server

''' screensaver-random''' = Randomly select from the list of installed screensavers

Telnet selection of installed screensaver Plug-ins as follows e.g.:-

<pre>
humax# screensaver
1: 3X5
2: 7Seg
3: Black
4: Cursor
5: Humax Default
6: Neon
7: Neon-Blue
8: VFD
Choose option [1-8]:</pre>
'''NOTES:-'''
*The Humax will need to be placed into stand-by before the new screensaver will be displayed
*If screensaver-all is installed, it must be uninstalled before other screensaver plug-ins are uninstalled
*If any of the screensaver Plug-ins are uninstalled the display will default to Humax Default

==Sed==

GNU Stream Editor, A stream editor is used to perform basic text transformations on an input stream, application notes [http://www.gnu.org/software/sed/manual/sed.html '''HERE'''] or [http://www.grymoire.com/Unix/Sed.html#uh-0 '''HERE''']

==Series Filer==

'''NOTE'''

'''The Series Filer package is no longer supported, the functions it carried out can be replicated by the [[sweeper | '''Sweeper''']] package, the following notes have been retained for reference only.'''

This utility will re-locate series folders created at the top level of My Video to Selected Sub-Directories so that they can be grouped together. After a New series folder has been created by the Humax at the top level, Simply move this series folder to a Sub-directory that you have created e.g. move the Doctor Who series folder to a sub-folder called ‘His Video’. When the next instalment of Doctor Who is transmitted the Humax will create another Doctor Who folder at the top level again, However, If Series Files is running the new instalment will be moved to the ‘His Video / Doctor Who’ automatically. Program names will also be re-named (if possible) to give more detail of each episode

'''NOTE:-'''

The early versions of Series Filer were not compatible with the Undelete package because the [deleted] directory was not handled correctly. Please DO-NOT run Series Filer versions before 0.2.2 with any version of the Undelete package, version 0.2.2 and above are safe to use

==Service Control==

A command line utility allowing easy control of installed services. Run the 'service' command from the command line for help.

From a Telnet command line prompt send the following :-

 service 
<pre>
humax# service

Name Installed Autostart Running
---- --------- --------- -------
mediatomb No No No
dropbear No No No
transmission No No No
samba No No No
cifs No No No
mongoose Yes Yes Yes

Syntax:
service start <service>
service stop <service>
service auto <service> (toggles autostart) </pre>

==Sh (SHell)==

Sh or Shell is a command line / scripting language built into Busybox that is roughly equivalent to the Windows DOS (Disk Operating System) utility. It is however a lot more powerful than DOS and is a true language

==Sidecar==

Web-If MAIN >> Browse Media Files >> (Select Single File) >> OPT+ >> Sidecar Files

Recreates sidecar files .hmt and .nts from a .ts source file.

Command line options :-
<pre>
sidecar v2.5, a utility for the Humax HD/HDR Fox T2, by raydon (c) 2014-2018
Usage: sidecar [-options] <recording name minus .ts extension>

-n : Create new .nts file
-h : Create new or update existing .hmt file
-x : Exclude Prog/PMT ID's from .hmt file
-c : <Channel number for .hmt file>
-t : <Channel name for .hmt file>
-p : Display progress bar
-i : Display infomation

Enclose recording or channel name in quotes if they contain spaces or special characters e.g. &.

humax#
</pre>

'''NOTES'''
# The Sidecar package must be installed using the Web-If >> Main screen >> Package Management >> Available screen
# TS files must be decrypted before running Sidecar, If the TS is encrypted see note 5 below
#Source video not native to the HDR/HD Fox T2, or that has been processed using some third party application may not be compatible
#There are versions of sidecar complied for Linux and Windows platforms [[Customised_Firmware_-_Features_Available#Miscellaneous_Software_Utilities | '''Here''']]
# if the ts file is encrypted, the package will create dummy hmt and nts files to allow the file to be decrypted i.e :-
*Use Sidecar to create the dummy hmt and nts files
*Once indexed by the DLNA server, manually decrypt via 'Opt+' menu in Web-If
*When the TS file is decrypted, simply run Sidecar again to create hmt and nts files providing full transport control.
*There is no need to delete the dummy hmt or nts files since sidecar will detect these, and replace them with valid files
*Sidecar can recreate valid hmt and nts file for both video and radio recordings

==Smartmontools==

This utility will report on the condition of the S.M.A.R.T. hard disk drive, After installing the package enter the following command line using Telnet :-

 mod/bin/smartctl /dev/sdb -A 

or

 mod/bin/smartctl /dev/sdb -a HIDE for more details

Documentation [http://sourceforge.net/apps/trac/smartmontools/wiki/TocDoc'''HERE''']
<pre>

humax# /mod/bin/smartctl /dev/sdb -A
smartctl 5.41 2011-06-09 r3365 [7405b0-smp-linux-2.6.18-7.1] (local build)
Copyright (C) 2002-11 by Bruce Allen, http://smartmontools.sourceforge.net

=== START OF READ SMART DATA SECTION ===
SMART Attributes Data Structure revision number: 10
Vendor Specific SMART Attributes with Thresholds:
ID# ATTRIBUTE_NAME FLAG VALUE WORST THRESH TYPE UPDATED WHEN_FAILED RAW_VALUE
1 Raw_Read_Error_Rate 0x000f 114 099 006 Pre-fail Always - 66811863
3 Spin_Up_Time 0x0003 097 097 000 Pre-fail Always - 0
4 Start_Stop_Count 0x0032 098 098 020 Old_age Always - 2878
5 Reallocated_Sector_Ct 0x0033 100 100 036 Pre-fail Always - 0
7 Seek_Error_Rate 0x000f 078 060 030 Pre-fail Always - 70502101
9 Power_On_Hours 0x0032 097 097 000 Old_age Always - 3294
10 Spin_Retry_Count 0x0013 100 100 097 Pre-fail Always - 0
12 Power_Cycle_Count 0x0032 099 099 020 Old_age Always - 1439
184 End-to-End_Error 0x0032 100 100 099 Old_age Always - 0
187 Reported_Uncorrect 0x0032 097 097 000 Old_age Always - 3
188 Command_Timeout 0x0032 100 100 000 Old_age Always - 0
189 High_Fly_Writes 0x003a 093 093 000 Old_age Always - 7
190 Airflow_Temperature_Cel 0x0022 055 044 045 Old_age Always In_the_past 45 (0 109 45 32)
194 Temperature_Celsius 0x0022 045 056 000 Old_age Always - 45 (0 13 0 0)
195 Hardware_ECC_Recovered 0x001a 048 039 000 Old_age Always - 66811863
197 Current_Pending_Sector 0x0012 100 100 000 Old_age Always - 0
198 Offline_Uncorrectable 0x0010 100 100 000 Old_age Offline - 0
199 UDMA_CRC_Error_Count 0x003e 200 200 000 Old_age Always - 0
</pre>

NOTE:- If an external Hard disk Drive is found on boot up the Internal Hard disk will be /dev/sdb, If no External Hard Disk drive is found at boot up the the internal Hard disk will be /dev/sda

==SQLite3==

SQlite is a database file handler, e.g. files that typically end in *.db can be opened, edited etc. With readline support (arrow key editing and history)

==SRT==

The Humax is able to play subtitles for MP4 and AVI files if the subtitle information is contained in an *.srt file, the following conditions must be met :-

*The srt file must have the same title as the video file e.g. Fawlty-Towers-S1E3.srt for Fawlty-Towers-S1E3.avi
*The .srt file needs to be saved as a text file specifically with ANSI encoding to avoid using fonts that are licensed

'''Notes'''

1) Windows Notepad will produce a ANSI encoded srt file

2) Saving the .srt file with UTF-7 encoding is reported to be more compatible with the Humax

3)A method for extracting SRT files from a Humax *.TS file has been documented on the Hummy.tv forum [http://hummy.tv/forum/threads/quick-guide-to-extract-dvb-subtitles-from-ts-hd-file-and-convert-to-srt-in-minutes.6625/ '''HERE''']

==SSMTP==

SSMTP is a program to deliver an E-mail from your Humax to a mail host or mail hub, It will not handle incoming E-Mail

==Status==

A Command line (Telnet) command that shows what the Humax is (and will be) doing, e.g. :-

<pre>
humax# status
Recording Pretty Woman_20121201_2310
Watching 12: Dave - Would I Lie to You? (23:00 - 23:40) [7%]
Will record 'The Omen' on Film4 at 23:15
</pre>
Note :- The same information is also displayed automatically on several Web-If screens e.g. The Main Screen and the Remote screen

==Strace==

Strace (System Trace) is a diagnostic, debugging and instructional userspace utility for Linux. It is used to monitor interactions between processes and the Linux kernel, which include system calls, signal deliveries, and changes of process state.

==Stripts==
This utility removes portions of a recording (*.TS File) that aren't required and can account for up to 20% of its space, this process will remove freeview EIT packets from the recording, it also updates the associated .nts sidecar file on the fly so that the trick play functions still work on the resulting recording

<pre>
Humax TS Stripper Tool v1.4.2, by af123, 2012-18.

Syntax: stripts [options] <input> [output]
-a Analyse an input file.
-A Quickly analyse an input file.
-c Check if there are any EIT packets.
-C Show address of first EIT packet.
-D Dump NTS file.
-E Check if file is encrypted.
-f Also fix PAT packets.
-F Only fix PAT packets.
-T Dump TS file.
-v Verbose.
-X Add bookmarks at programme start/end.
-Z Extract EPG data from recording (incomplete).
-z Analyse entire TS file.
-@ <key> Decrypt recording with <key>.
-/ <key> Check encryption key against recording.
-d [level] Increase debug level or set debug level.
</pre>

 stripts -F filename HI = Fix file

 stripts -f filename HI = remove redundant EIT packets

 stripts -v filename HI = Verbose

 stripts -S filename HI = demux the raw audio stream into a file-name.audio file

'''NOTE'''
Version 1.4.0 and above of strips also has a file decryption facility, this facility works on both Standard Definition and High Definition recordings and does not require Hi-Def recordings to have the 'ENC' flag removed with the Auto-Unprotect package, it does not require a DLNA URL to be allocated or the DLNA server to be running on the Humax, here is an example of a command line decryption using Stripts :-

<pre>
stripts -@@ <input> <output>

stripts -@ 000378bd11f336333731303434393630 "input file name" "output file name"

stripts -/ 000378bd11f336333731303434393630 "input file name"
Encryption key is correct for this recording.
</pre>

1) In the first example above -@@ automatically inserts the resident Humax encryption key

2) The Second example above is used when the decryption is being carried out on a file recorded on a different Humax unit, this unit's encryption key must be entered, e.g :- for a MAC address of 00-03-78-bd-11-f3 and a serial number of 6371044960-1234, enter 000378bd11f3 followed by the first 10 digits of the serial number in hexidecimal e.g. 36333731303434393630

3) The third example above uses -/ to Check the encryption key against a recording

"input file name" and "output file name" are full *.ts file names, up to, but not including the .ts (Quotes are required for name with spaces)

There are versions of stripts that can perform offline decryption on various computer platforms including :- Linux, MacOSX and Windows etc. [https://wiki.hummy.tv/wiki/Customised_Firmware_-_Features_Available#Miscellaneous_Software_Utilities '''See Link HERE''']

==Swapper==

Swapper is a utility to change the Humax's swap file size to 128

==Sweeper==

Sweeper is a package which re-locates recordings under My Video and files them away automatically for you according to specified criteria, Sweeper can also replicate the Series Filer and flatten packages

There is a comprehensive guide to the Sweeper Graphical User Interface [[sweeper | '''HERE''']]

'''Command Line operation'''

Sweeper rules can also be generated manually by editting the /mod/etc/sweeper.conf file, available from Web-If >> Diagnostics >> File editor

Example 1)

 action {move "archive/miscellaneous"} HI = Move all single files into a folder called archive/miscellaneous (which must exist)

 action {movecreate "archive/miscellaneous"} HI = Move all single files into a folder called archive/miscellaneous (folder will be created)

Example 2)

 lcn {>= 70} lcn {<= 79} action {move Children/Miscellaneous} HI = Move single files from channels 70 - 79 to Children/Miscellaneous folder

 action {move _misc} HI = Move all remaining single files into a folder called _misc

Example 3)

 action {movecreate(Test-%genre-%definition-%title-%channel-%lcn-%duration-%timestamp)} HI = Expanded to Test-Entertainment-SD-Tim Minchin and the Heritage...-Channel 4-4-87-20130824233802]

Example 4)

 folder title {Octonauts} action {move "Children/Octonauts/Series 3"} HI = Move the contents of a series created folder to an existing sub folder e.g. from /Octonauts to /Children/Octonauts/Series 3

Example 5)

 folder action {fileunder ""} HI = emulates the old seriesfiler package

Example 6)

Notes :-
*lines starting with '#' are comments
*A full list of commands are detailed in the Sweeper Guide [[sweeper | '''HERE''']]

<pre>
# Sweep single Big Bang episodes into the series folder
lcn 4 title "Big Bang" action {move "The Big Bang Theory"}
# Move anything recorded from a children's channel to the Miscellaneous folder
lcn {>= 70} lcn {<= 79} duration {>= 90} lock 1 action {move Children/Films}
lcn {>= 70} lcn {<= 79} genre Film lock 1 action {move Children/Films}
lcn {>= 70} lcn {<= 79} action {move Children/Miscellaneous}
folder title {Octonauts} action {move "Children/Octonauts/Series 3"}
folder lcn {>= 70} lcn {<= 79} action {fileundercreate Children}
title {Formula 1} action {move F1}
</pre>

==Subtitles==
[[Custom_Firmware_Package_Notes#SRT | '''See SRT''']]

==Swifi==

A utility that can retrieve and display your current Wi-fi configuration, it's location is :- /sbin/swifi

==Sysmon==
[[File:HDD-Temp.png|right|150px]]
[[File:CPU.png|right|150px]]
[[File:network.png|right|150px]]
A System Monitoring Utility, the Web-If main page has a System Monitoring icon, selecting this icon displays the following options :-

*Hard Disk Temperature

Displays a graph showing the hard disk temperature, This feature uses the [[Custom_Firmware_Package_Notes#Smartmontools | '''Smartmontools''']]
package, options are to display last 2 / 5 hours or 1 / 10 / 30 Days. All graphs have a zoom feature which is implemented with a mouse 'click / drag' or a touchscreen 'pinch / expand'

*CPU Utilisation

Displays a graph showing CPU Utilisation for Idle, Wait, User and System, options are to display last 2 / 5 hours or 1 / 10 / 30 Days

*Network Utilisation

Displays a graph showing Network Utilisation for Inbound, Outbound, In-Errors and Out-Errors, options are to display last 2 / 5 hours or 1 / 10 / 30 Days

The data used to build the graphs is held in file /mod/monitor/monitor.db, currently the tables include :-
#SMART = Hard disk sector relocation information (Not currently displayed as a graph)
#Temp = the Hard Disk Temperature information
#Vmstat = CPU Utilisation data for Idle, Wait, User, System
#Net = Network Utilisation for Inbound, Outbound, In-Errors and Out-Errors
#State = state (Not currently displayed as a graph)

'''Note''' You can reset the database with Web-If >> Diagnostics >> sysmon/purge >> Run Diagnostic

==System Flush==

The System Flush Update File is a package that is installed in the same way as a firmware update to perform a full system flush and reset, it reformats the areas of flash used for persistent data like the schedule, there are two of these flash areas and they use the JFFS2 filesystem.

The package is designed to assist recovery from crash/reboot loops.Your recordings will not be affected.'NB: This will also clear most CFW package settings.

==TCL Check==

Utilities for syntax checking TCL (or Jim) files

==Tcpfix==

This package Modifys the TCP stack to fix download problems that appears to be related to RFC1323 TCP window scaling in the Linux 2.6.18 kernel that the Humax uses

==TCP Ping==

Simple TCP ping utility.

==Telnet==

Telnet is built into the default Custom Firmware package, To communicate Via Telnet from a P.C. you will need a program such as [http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html '''PuTTY'''], Select connection type Telnet and enter the IP address of your Humax into the Host Name box, Then select OPEN, You will be presented with a new Telnet Window and if connection is successful you will see the humax# prompt.

It is also possible to use Telnet supplied in some versions Microsoft Windows e.g. Start >> Run >> CMD >> Telnet

See ''' RED ''' set-up notes below, to prevent errors when entering text

Telnet is available in Windows XP, However Vista and Windows 7 will require Telnet to be enabled with Control Panel >> Programs and Features >> Turn Windows Features On / Off >> 'Tick' Telnet

Follow [[Telnet |'''THIS LINK''']] for more details on the various ways of obtaining a Telnet connection

Here is an example of Windows XP Telnet for ls -al 

<pre>
C:\> telnet

Welcome to Microsoft Telnet Client Escape Character is 'CTRL + ]'

open 10.0.0.200

humax# ls -al
total 17
drwxr-xr-x 18 root root 192 Jan 10 09:10 .
drwxr-xr-x 18 root root 192 Jan 10 09:10 ..
drwxr-xr-x 2 root root 474 Jan 10 09:10 bin
.......
drwxr-xr-x 4 root root 88 Jan 10 09:10 var
humax#

to exit from humax# enter Ctrl + d

Microsoft Telnet >
to exit from Telnet enter q
C:\>
</pre>

NOTES
*Telnet command lines on this WiKi are identified by a Yellow Background 
*''' [Putty] Telnet >> Connection >> Telnet >> return Key sends Telnet New Line instead of ^M should be 'un-Ticked' '''
*''' [Windows] Telnet >> unset crlf '''
*The Humax has a Built-In Telnet Welcome Screen, See [[Custom_Firmware_Package_Notes#Tmenu | '''Tmenu''']] for details

==Telnet Commands==

The majority of Unix / Linux command line keywords can be used on the Humax, if you are not familiar with them, there are a few of the more basic commands and their meanings here :-
* cd = change directory, used to navigate around the file structure
* cd "/media/My Video" = navigate to the top level of My Video
* pwd = print working directory, tells you where you are in the file structure
* ls -al = list contents of the current directory
* touch "/media/My Video/dummy.ts" = create an empty file called dummy.ts in the My Video directory

==Tempmon==

This package checks the HDD temperature every three minutes and will raise a warning if a configurable thresholds is exceeded, the warning is displayed on the HDR-Fox T2's front panel and the centre 'button' flashes. The Setting >> Tempmon page shows the current Hard Disk temperature and has defaults as follows :- Alert If = 50, Attempt to go into standby if = 60 and Immediate power off If = 70 Deg C

'''Note''' If the Fan package is not installed the normal Humax routine will turn the fan on at 56 Deg C, so it is suggested that 'Alert If' should be set to 60 Deg C and the other two parameters are set to 65 and 70 Deg C

==Text Editors==

There is a built-in GUI Text editor in the Web-If (details [[Custom_Firmware_Package_Notes#File Editor |'''HERE''']]). In addition to this editor, There is a basic version of [[Custom_Firmware_Package_Notes#Vi |'''Vi''']] built into the custom [[Custom_Firmware_Package_Notes#BusyBox |'''Busybox''']] package (not in the Busybox version included in the vendor's firmware). There are also several packages that can be installed to suit your editing preferences e.g. [[Custom_Firmware_Package_Notes#Vim_Basic |'''Vim Basic''']], [[Custom_Firmware_Package_Notes#Vim_Standard | '''Vim Standard''']], [[Custom_Firmware_Package_Notes#Joe | '''Joe''']] and [[Custom_Firmware_Package_Notes#Nano | '''Nano''']].

If you've only installed the basic custom firmware (using the upgrade path with USB), then there's
[[Custom_Firmware_Package_Notes#Sed | '''sed''']]

==Tmenu==

This built-in package adds a menu to the Telnet Login screen Menu

Enter 0000 for system PIN. Note:- this is the default
<pre>
Menu Version 1.13
Enter System PIN :

/-------------------------\
| T E L N E T M E N U |
\-------------------------/

[ Humax HDR-Fox T2 (humax) 1.03.12/3.03 ] or [Humax HD-Fox T2 (humaxhd) 1.02.29/2.15]

1 - Restart into maintenance mode.
2 - Remove web interface password.
stat - Show what the box is currently doing.
x - Exit and close connection.
rset - Reset custom firmware environment.
srma - Set return-to-manufacturer (RMA) mode.
diag - Run a diagnostic.
cli - System command line (advanced users).

Please select option:

</pre>

NOTE :- It is possible to skip the above Menu and go directly to the Command Line Interface by selecting Expert mode telnet server = On in the Web-If >> Settings >> Advanced Settings

==Tnftp==

The Humax HDR has a built-in FTP Server for transfer of files from Humax to a remote client and an improved FTP Server called [[Custom_Firmware_Package_Notes#Betaftpd|'''Betaftpd''']] to replace it in the HDR, and to add it to the HD, the Tnftp package provides an FTP Client for file transfer from a remote FTP server to the Humax

tnftp is a port of the NetBSD FTP client.

==Transmission (Bit Torrent)==

The Transmission program will download files from the internet using the a torrent protocol, Downloads using this system are usually fed from multiple sites at the same time in parallel, Because of this many URL’s may be used in the download process, These URLs are packaged together into a single *.torrent file, Transmission re-constructs fragments of the file/s from these various URLs into their original format.

Transmission needs to be supplied with the *.Torrent file, it does not have a Torrent file search facility, one possible torrent source is torrentz.eu, download your selected *.Torrent file to the P.C. you run the Web-iF from

For command line access enter :-

 transmission-remote 

/mod/etc/transmission/settings.json contains settings such as default = speed-limit mode, this can be changed to fast downloading etc. settings info. [https://trac.transmissionbt.com/wiki/EditConfigFiles '''HERE''']

*Go into service control and start Transmission
*Set it to auto start if you want it to come on whenever the box is on
*Go to the Web-If main menu and click the transmission icon at the bottom left
*Select 'Open' (the folder at the top left)
*Select browse in the window and highlight the previously downloaded *.torrent file
*When highlighted select 'Open'
*Select 'Upload'
*If the 'Start when added' box is checked the download will start immediately
* A new directory will be created at /media/ My Video/torrent/ containing successful downloads

===Blocklist===

The torrent system is a 'two-way' process which can allow other users to access your downloaded files, this access can cause a security risk and it is suggested that a block list is set up to prevent this, the Block list contains a set of IP address's not allowed access.

To create or add to a blocklist go to Transmission >> Preferences (Bottom left 'Spanner') >> Peers >> Blocklist and Enable Blocklist, then go to a block list site such as http://www.iblocklist.com/lists.php and copy an Update URL e.g. http://list.iblocklist.com/?list=bt_level1&fileformat=p2p&archiveformat=gz from there to the Block list URL box and click on Update, This process can be repeated to build up bigger lists

It is also possible to place *.txt files containing blocklists into the /mod/etc/transmission/blocklists folder, these files must be smaller than 5Mbs, They will be processed by the Transmission program when first run and *.bin files will be created in the same folder, if the files are successfully processed an indication of the number of ‘Blocked’ URL will be displayed e.g. Block List Has 598940 Rules

'''Notes'''
*When the block lists are initially being converted into *.bin files, transmission uses an excessive amount of CPU time, this could cause errors in recording, so it is suggested that this is done when the Humax is idle.

==Trm==

Trm is a version of the Unix rm command (ReMove), This version removes files in blocks using Truncate (hence Truncate ReMove) rather than all at once, In order to reduce demand on system resources

==TSTools==

A set of tools for manipulating TS files, they include :-
[[File:Tstools.jpg|left|400px]]

==TTYSnoop==

TTYSnoop allows you to snoop on login tty's through another tty-device or pseudo-tty. The snoop-tty becomes a 'clone' of the original tty, redirecting both input and output from/to it.

==Tunefix==
[[File:tunefix.png|right]]
Tunefix restores a user's settings after a retune has been run, the 5 Keywords are :-

*'''REGION''' to be used (channels from other regions will be removed)
*'''LCN''' (s) by number and/or range will be removed
*'''NAME''' services by name will be removed
*'''MUX''' (s) (all channels from these MUXs will be removed)
*'''FORCE''' named services to the correct LCN

'''Note''' Multiple Regions, LCNs, MUXs are separated by commas

==Tunefix Update==

Automatic channel deletion and fixing after a retune.

==TV Diary==

tvdiary is an add-on to the web interface. It tracks the TV programs you record and watch, and presents a diary view through the web interface, See Full Guide[[ TV_Diary | '''HERE''']]

==Uinput==

User-space input kernel module

==Unencrypt==

New Note:- This package is no longer supported, with the addition to the Web-If of [[Custom_Firmware_Package_Notes#Enable_Auto-Dedup|'''auto-decrypt''']] and [[Custom_Firmware_Package_Notes#Enable_Recursive_Auto-Decrypt|'''recursive auto-decrypt''']] these new functions are recommended in place of Unencrypt due to them being more robust and having more sanity checks

The function will unencrypt all files in a designated directory (or all files in My Video) automatically, Files are decrypted at the same location e.g. 'decrypt in place' and are processed at the rate of one file every 30 Mins. max. so don't expect instant results

To setup Unencrypt install the package and then via [[Custom_Firmware_Package_Notes#Telnet|'''Telnet''']] enter one of the lines below :-

 unencryptsetup "Bob's Videos" HIDE process a single directory

 unencryptsetup HIDE process all files in 'My Video'

 unencryptsetup disable HIDE Turn off unencrypt

This will update the cron table and schedule the program to run every 30 minutes (at Mins 01 and 31) indefinitely. Every time it runs, it will check that there isn't already another job running and then decrypt the first encrypted file that it finds in the directory you specified, therefore gradually working its way through your files, If you don't specify a directory, it will default to decrypting all of your recordings.

NOTES:-
* '''Due to CPU overloading this feature only works between 1AM and 6AM the Humax must be out of standby during this time using an Auto On / Auto off timer''' 

*It is possible to change when Unencrypt runs by editing the cron job that controls it, Via the Web-If goto Diagnostics >> File Editor >> Open >> /mod/var/spool/cron/crontabs/ and replace 1-6 with a * to force an Unecrypt start every 30 Mins. that the Humax is out of stand-by
<pre>
1,31 * * * * /mod/sbin/unencrypt "/mnt/hd2/My Video/archive" > /mod/tmp/unencrypt.log 2>&1
</pre>

*Auto-Unprotect must be running
*[[Custom_Firmware_Package_Notes#Content_Sharing |'''Content sharing''']] must = on e.g. Menu >> Settings >> System >> Internet Settings

See Decryption flow chart [[Encryption | '''HERE''']]

==Undelete==

Redirects deleted recordings to a dustbin folder called [Deleted Items] and then automatically removes them from this new folder 7 days later, The Folder Name and delay before deletion is carried out (1 to 30 days) is configurable in the Web-If Setting area. It's a batch process which runs once per day. It runs 6 minutes after the first boot of the day or, if you keep your box on all the time, at 2am.
It scans the bin and removes anything that was put there over x * 24 hours ago, Where x = no. of days (strictly, anything that was last modified over x * 24 hours ago)

Settings can be changed in :- Web-If >> Settings >> Undelete Settings, e.g. :-

*Dustbin Name
*Remove files from dustbin after 1,2,3,4,5,6,7,10,15,20 days
*Reduce retention time to 0 days if disk space < 10GiB (configurable)

A Log records delete activity at /mod/tmp/empty_dustbin.log

Setting are contained in /mod/webif/plugin/undelete/user.conf

==Version==

Command line (Via Telnet) utility to display various Web-If version numbers, e.g. :-
<pre>
humax# version

Humax HDR Fox T2 (humax)
Humax Version: 1.03.12 (kernel HDR_CFW_3.00)
Custom firmware version: 3.00 (build 2137)
Web interface version: 1.2.1
Serial Number: 12 3456789 12345

humax#
</pre>

==Vfdtest==
[[File:front-icons2.png|right|200px]]

This utility turns on all segments of the Humax front display (Vacuum Fluorescent Display)

Web-If >> Diagnostics >> Run Diagnostic >> vfdtest (available in pull down menu). This will force the display to set all segments to 'on' for 30 seconds, followed by all segments off

'''NOTE:- ''' normal display will return after the Humax is placed in standby

Command Line Version :-

 vfdtest on HIDE Set Display to All segments On

 vfdtest off HIDE Set Display to All Segments off

==Vi==

Text Editor, See [[Custom_Firmware_Package_Notes#Text_Editors | '''Text Editors''']]. A basic version of Vi is built into the custom [[Custom_Firmware_Package_Notes#BusyBox |'''Busybox''']] package (it's not included in the version of Busybox in the vendor's firmware).

==Vim Basic==

Text Editor, See [[Custom_Firmware_Package_Notes#Text_Editors | '''Text Editors''']]

==Vim Standard==

Text Editor, See [[Custom_Firmware_Package_Notes#Text_Editors | '''Text Editors''']]

==Virtual-Disk==

One way to decrypt content which has been recorded by the Humax is to copy to an external disk, This is usually a slow process as the
external disk must be connected via one of the USB ports. This package creates a virtual disk on the system to which content can
be copied. It is much faster since it is based on the internal hard disk. The virtual disk is shared by the MediaTomb package by default, giving a
fairly straightforward method of sharing recorded content on the network. In conjunction with the 'auto-unprotect' package, high definition content can also be shared. Any copy to Virtual Disk MUST be by Remote Control OPT+ copy for decryption to take place

'''Note:- For new installations, Virtual-Disk2 is now recommended in place of this package'''

==Virtual-Disk2==

The original Virtual-Disk package (See Above) required a physical USB drive to be in place before the virtual drive could be seen, this new version removes this requirement by creating a drive called 'Virtual-USB', as with a 'real' USB drive, you will get an on-screen display each time the system is started, giving USB options

==Web IF ==

[[Web_Interface_Screenshots |'''Screen Shots''']] HIDE [[Webif_release_notes |'''Release Notes''']]

An evolving web interface for the Humax. This package provides a means of accessing the Humax using a web browser on any device connected to the
network (including mobile 'phones and iPads). The interface allows easy viewing of recorded programme details as well as allowing basic
manipulation to be performed. Additionally the EPG can be viewed and searched from within the web browser

Within the Web-IF are the following Built-In Functions :-

===Backup/Restore Schedule===
[[File:Backup.png|70px|thumb|right]]

Web-If MAIN >> Scheduled Events >> Backup / Restore Scheduled Recordings / Events

This feature provides an automatic daily backup of recording schedule, It is also possible to force an extra manual backup at any time. Any stored backups can then be selected for restoration from the backup folder e.g. /mod/var/backup/auto-2013-Feb-22-18:06.rbk

===Change Channel===

Web-If >> EPG >> Grid Style or Now and Next >> Click on a Channel Logo icon

A Change Channel? question box will pop-up, if you click on 'Yes' the Humax will change the 'Live' tuned channel to the selected channel

Note :- This option requires that the ir Custom Firmware package is installed

===Change Folder===

Web-If MAIN >> Scheduled Events >> (Click on 'More' for a Series Recording) >> Change Folder

Allows the name of a Series Recording folder to be changed, not valid on a single recording

===Cleanup Old Recording (Schedules)===

Web-If MAIN >> Scheduled Events >> Cleanup Old Recordings (at the bottom of the screen)

Allows all entries in the schedule that have no Start Time to be deleted, Humax normally auto-deletes these entries after 12 Weeks.

'''Note:-''' As the EPG is only 7/8 days long caution should be used when deleting scheduled entries that are transmitted less frequently e.g. fortnightly

===Clipboard===

Used in conjunction with Copy, Cut and Paste, The clipboard is an area that files / Folders can be temporarily held in while a new destination is selected. It emulates a Windows Clipboard

===Create Folder===

Web-If MAIN >> Scheduled Events >> More >> Create Folder

Create a new folder destination for future recordings, See also [[Custom_Firmware_Package_Notes#Change_Folder | ''' Change Folder]] where you can change the default folder name

===Copy===

See [[Custom_Firmware_Package_Notes#Clipboard | '''Clipboard''']]

===Crop===
[[File:crop.png|200px|thumb|right]]
Web-If MAIN >> Browse Media Files >> (Select Single File) >> OPT+ >> Crop

See Edit on Box link [[Edit_On_Box#Editing_Via_Web-If |'''HERE''']]

===Cut===

See [[Custom_Firmware_Package_Notes#Clipboard | '''Clipboard''']]

===Delete===

Remove file, folder, item from a recording schedule etc., depending on where the option is encountered

===Decrypt===

Web-If MAIN >> Browse Media Files >> (Select Single File) >> OPT+ >> Decrypt

This Function will move the file to an _original folder and then stream a new copy to the present location, The new copy will be Decrypted and can be played on a P.C.. NOTES:-
* both High Definition AND Standard definition need to be Decrypted
* Decrypt requires [[Custom_Firmware_Package_Notes#Content_Sharing |'''Content sharing''']] to be turned on

===De-duplicate / Tidy this folder===
[[File:Webif-media-ded.png|70px|thumb|right]]
[[File:Webif-media-ded2.png|70px|thumb|right]]

Web-If MAIN >> Browse Media Files >> De-duplicate / Tidy this folder

This Function will search a folder and re-name files with more meaningful titles, It will also separate duplicates into a new folder

See Tidy (Re-name) Example >>

This Function will search a folder and re-name files with more meaningful titles

It will Also separate duplicates into a new folder

See De Duplicate (to new folder) Example >>

===Detect Adverts===

Web-If MAIN >> Browse Media Files >> (Select Single File) >> OPT+ >> Detect Adverts

Add bookmarks to a recording where adverts are detected, so that they can be cropped

===Disable AR===

Web-If MAIN >> Scheduled Events >> (Click on 'More' for a Recording) >> Disable AR

Allows the default [[Padding_versus_Accurate_Recording|'''Accurate Recording''']] feature to be replaced with Padding on a 'per-recording' basis, in a further drop down menu start and stop padding times can be entered

===Download===

Web-If MAIN >> Browse Media Files >> (Select Single File) >> OPT+ >> Download

This function will download with decryption an SD file (or Hi-Def File if the 'ENC' flag is removed) and place it into the default download folder on your P.C., The following items may inhibit it functioning correctly :-

# The File type *.TS must not be associated with a program such as a media player on your P.C., If it is, Remove the association
# Your browser must allow re-direction of addresses

===Enable Auto-Audio===

Web-If MAIN >> Browse Media Files >> Folder >> Enable Auto-Audio

Automatically extract an MP3 audio file from all recordings placed in this folder

===Enable Auto-Dedup===

Web-If MAIN >> Browse Media Files >> Folder >> Enable Auto-Dedup

Set contents of a folder for Auto-De-Duplication of files every 10 Mins. (See also [[#Dedup_.28Command_Line.29 |'''Dedup''']])

===Enable Auto-Decrypt===

Web-If MAIN >> Browse Media Files >> Folder >> Enable Auto-Decrypt

Set contents of a folder for Auto-Decryption of TS files every 10 Mins. (See also [[#Decrypt |'''Decrypt''']])

===Enable Auto Expire===
[[File:autoexp.png|200px|thumb|right]]
Web-If MAIN >> Browse Media Files >> Folder >> Enable Auto-Expire

Automatically delete files in a selected folder a pre-set number of days after recording e.g.1 to 999 days or when above a total number of recordings, Note :- If the Undelete package is installed, the files will be placed in the [Deleted folder] first

===Bookmarks===
[[File:bookmarks.png|right|150px]]
Add, remove and edit bookmarks manually

Web-If MAIN >> Browse Media Files >> (Select Single File) >> OPT+ >> Bookmarks

===Enable Auto-MPG===

Web-If MAIN >> Browse Media Files >> Folder >> Enable Auto-MPG

Automatically extract MPG copys of the *.TS files in the same folder, the MPG versions strips out control frames relating to things which were on the same Mux as the recorded program, resulting in a smaller file. The following conditions must be met :-

*The file must be decrypted (Displays a DEC against it)
*ffmpeg package must be installed
*Extract to MPG is only available from Standard Definition Files
===Enable Auto-Shrink===

Web-If MAIN >> Browse Media Files >> Folder >> Enable Auto-Shrink

Set contents of a folder for Auto-Shrinking of TS files every 10 Mins. (See also [[#Shrink_.28stripts.29 |'''Shrink''']])

===Enable Recursive Auto-Shrink===

As above but it but it also works on all folders below the selected folder

===Enable Recursive Auto-Decrypt===

As above but it but it also works on all folders below the selected folder

===Enable Recursive Auto-Dedup (command line)===

NOTE :- This is not available from the Web-If as it may not be a good idea. Not all series are amenable to auto-dedup and if the broadcaster uses the same programme title for each episode then all but one will be flagged as duplicates.

However, if you wish, you can enable this option from the command line by creating an .autodedupr file, e.g.

touch "/mod/My Video/Kids/.autodedupr" 

===Extract Audio===

Web-If MAIN >> Browse Media Files >> (Select Single File) >> OPT+ >> Extract Audio

This function will produce an MP3 file containing the stereo audio track contained in a standard Def. Video file (or radio recording), The following conditions must be met :-

*The file must be decrypted (Displays a DEC against it)
*ffmpeg package must be installed
*Standard Def. recording only (Hi-Def 2 Ch or 6 Ch sound won't be decoded)
*The extracted MP3 file is in a format sometimes called MPEG-2 Audio, not the more common Layer 3 audio, although some MP3 players will accept this format, a greater number of MP3 players require the layer 3 format, transcoding to layer 3 is not carried out on the Humax due to amount of CPU usage required

===Extract To MPG===

Web-If MAIN >> Browse Media Files >> (Select Single File) >> OPT+ >> Extract To MPG

This function will produce an MPG copy of the *.TS file in the same folder, the MPG version strips out control frames relating to things which were on the same Mux as the recorded program, resulting in a smaller file. The following conditions must be met :-

*The file must be decrypted (Displays a DEC against it)
*ffmpeg package must be installed
*Extract to MPG is only available from Standard Definition Files

===Enable Auto-mpg===

Web-If MAIN >> Browse Media Files >> (Select Folder) >> OPT+ >> Enable Auto-mpg

As above but working on every file in a selected folder

===File Editor===

Web-If MAIN >> Diagnostics >> File Editor >> Open >> [Navigate to desired file]

===Lock===

Mark a file as locked, e.g. protected against deletion

===Mark as Watched===

Tag a file with a 'Watched' symbol

===Manual Event===
[[File:manual-event.png|thumb|right]]
Web-If MAIN >> Scheduled Events >> Manual Event

Allows the set up of a manual recording or reminder, options include:-
*Create : One-off, Daily, weekly,Weekday, Weekend
*Create : Recording or Reminder
*From : Date/Time to: Date/Time
*Channel : Number / Name
*Event Title : Defaults to Channel Name

===Multi Mode Recording===

This option built into the Web-If allows the user to enable a mix of both Accurate Recording and Padding on a per program basis, See [[Multi-mode_Recording|'''Guide Here''']]

===Network Settings===
[[File:network-settings.png|thumb]]
Web-If MAIN >> Settings >> Network Settings

This option provides a Web-If alternative to entering Ethernet Interface and Wireless Interface parameters into the standard Humax Settings screen. The Web-If Wireless Interface screen has several advantages over the standard Humax one e.g :-
*Allows a wider range of ascii characters e.g. "%#<>" to be entered for passwordphrases
*Overcomes time restrictions when entering long passphrases / Keys
'''Notes'''
*Web-If 1.2.0-3 or later must be running
*To enable a wireless network when an Ethernet cable is connected, run /sbin/wifi-up from [[Custom_Firmware_Package_Notes#CLI |'''CLI''']]
*To enable a wireless network when an Ethernet cable is connected and Wireless Helper is installed run /mod/sbin/wifi-up from [[Custom_Firmware_Package_Notes#CLI |'''CLI''']] to shutdown the Ethernet interface when bringing up the wireless interface

===New Folder===

Web-If MAIN >> Browse Media Files >> New Folder

Creates a new empty folder, into which recorded files can be moved

===Paste===

See [[Custom_Firmware_Package_Notes#Clipboard | '''Clipboard''']]

[[File:Webif-media-detail.png|100px|thumb|right]]

===Play===

This function provides an in-browser playback function for the Humax, It requires that you have the VLC plug-in installed for your browser

Web-If MAIN >> Browse Media Files >> (Click on Single File) >> Play

===Rename (File)===

Web-If MAIN >> Browse Media Files >> Click on Single File) >> Rename

Enables the following fields to be changed / added to a single file :-

*New Filename
*New Medialist Title
*New Synopsis
*New Guidance Text
*New Genre

===Rename (Folder)===

Web-If MAIN >> Browse Media Files >> Folder >> Rename

Enables a folder to be re-named

===Reset New Flag===

Web-If MAIN >> Browse Media Files >> Folder >> Reset New Flag

Mark a Folder as containing new material

===Save Last Streamed Content===

Web-If MAIN >> Browse Media Files >> Save Last Streamed Content

This Function will make a permanent MP4 copy of any content that has been viewed using the Humax TV portal e.g. I-Player / You Tube and place it into the 'My Video' folder. The Telnet equivalent Syntax is as follows :-

cp /mnt/hd3/Streamer_down_file "/media/My Video/theclip.mp4" 

NOTE:- The Portal screen must remain open until the entire file has been downloaded (It is not performed in the background), The amount of time the download takes will vary with broadband speed

===Set Thumbnail===

Web-If MAIN >> Browse Media Files >> (Select Single File) >> OPT+ >> Set Thumbnail

Change the current on-screen Thumbnail picture for one of 5 pictures covering a 2.5 Second time frame, the centre frame time can be offset from 0 - 99999 seconds, there is also a -30, -5, +5 and +30 second 'nudge' that can be added to the offset.

'''Notes'''
* The Set Thumbnail option will be greyed out if the file is not decrypted first
* High Definition files have 3 pictures covering a 1.5 Second time frame
* Thumbnails may take some time to generate on Hi-Def Files
* If a bookmark is present the thumbnail selections will centre on it

===Sidecar Files===

see [[Custom_Firmware_Package_Notes#Sidecar | '''Sidecar''']]

===Split===

Web-If MAIN >> Browse Media Files >> (Select Single File) >> OPT+ >> Split (45m parts)

This Function (only available on files over 4GB) will split the file into 45 Minute parts with a 2 Minute overlap, It can be used to stream large files without hitting the 4GB stream bug present on the Humax.

The New files will have segment numbering e.g. 1/3. E.T. The Extra-Terrestrial

===Shrink (stripts)===

Web-If MAIN >> Browse Media Files >> (Select Single File) >> OPT+ >> Shrink

Clicking on Shrink in the OPT+ menu lets you remove portions of a recording that aren't required and can account for up to 20% of its space, this option uses the stripts package to remove freeview EIT packets from the recording, it also updates the associated .nts sidecar file on the fly so that the trick play functions still work on the resulting recording

===Sweeper Rules===

Web-If MAIN >> Browse Media Files >> Folder >> OPT+ >> Sweeper Rules

View / Edit the Sweeper Rules for this folder. Note this option will only be displayed if the sweeper package is installer

===Toggle no-sweep flag===

Web-If MAIN >> Browse Media Files >> Folder >> OPT+ >> Toggle no-sweep flag

Disable / enable the sweeper rule generated for this folder

===View Thumbnail===

Web-If MAIN >> Browse Media Files >> (Select Single File) >> OPT+ >> View Thumbnail

View current on-screen Thumbnail picture

==Web-IF Channel Icons==

A set of PNG picture files used to display the T.V. channel icons in the Web-Interface, they reside in /mod/var/mongoose/html/img/channels

==Webif-Charts==

Chart modules for the web interface

==Webif-iphone==

A cut-down web interface, optimised for display on the iPhone and other mobile devices

See Screenshots [[Smartphone_Web_Interface_Screenshots | '''HERE''']]

==Webif Style Sheet==

The web interface allow you to set your own style overrides in a style sheet file called EXTRA.css, it is located at /mod/webif/html/css/EXTRA.css and is selectable from the Web-If >> Diagnostics >> File Editor drop down menu. Lines added to this file can change some aspects of how the Web Interface is presented to the user e.g. the following lines will prevent genre, guidance (all occurrences) or channel icons being displayed :-
<pre>
img.genre { display: none; }
img[src^="/img/Guidance"] { display: none; }
img.browsechannel { display: none; }
</pre>

Change the size of the pie chart:-

<pre>
#tbdiskpie
{
width: 100px;
height: 100px;
}

.tbdiskpie
{
top: 7px !important;
}
</pre>

Add Borders to Web-If Pages :-
<pre>
table.schedule { border-spacing: 2px; }
table.schedule tr > * { border: 1px solid; }
</pre>

Change font colour or size :-
<pre>
table.schedule td * { color: black; }
table.schedule td { font-size: 1.1em; }
</pre>

Change Icon size
<pre>
img.button { height: 50px; }
</pre>

Remove EPG 'Go to Top' arrow :-

<pre>
#toTop, #toTopHover
{
background: transparent !important;
display: none !important;
opacity: 100 !important;
}
</pre>

Remove EPG ENC icons

<pre>
img.epgenc { display: none; }
</pre>

==Webshell==

After installing this package, an extra icon will be added to the Main Menu >> Diagnostics page at the bottom right, after a re-boot, this will allow access to a Humax Command line similar to using Telnet access

==webm==

This is an audiovisual media file format, if you download files in this format from YouTube (See Youtube-dl), the video and audio may be separated into two files, It is possible to merge these files using ffmpeg, if you download the *.webm video only file and rename it in_vid.webm and download the *.m4a file and rename it in_aud.m4a then the following ffmpeg command line will merge them for you :-
<pre>
ffmpeg -i in_aud.m4a -i in_vid.webm -acodec copy -vcodec copy output.avi
</pre>

==wget==

Retrieve files via HTTP or FTP

'''Notes:-'''
*There is already a version of wget in Busybox which is loaded automatically, However it may be necessary to install the stand alone package as it will be a newer version
*Both the Busybox and the current stand alone versions of wget (1.12) may fail on websites that demand newer versions of TLS/SSL than the ones supported

When attempting to download a Custom Firmware package specifying a version number, an error will be produced unless the -U option is used, eg :-
<pre>
wget -U "" http://hummypkg.org.uk/hdrfoxt2/base/at_3.1.18_mipsel.opk
</pre>

The use of "opkg download" with a specifed version number will also fail

==Wireless Helper==

Wireless network helper - brings wireless up even when just booted to make a recording. Helps with communications to the Remote Scheduling server via USB Wi-Fi dongle

==WOL==

Wakeup On Lan is a feature that can be used to take out of stand-by any item on the LAN that will respond to it. The 'Magic Packet' is broadcast over the LAN e.g. it is sent to every IP address and uses the unique MAC address of the unit to identify which unit is to be woken-up. From Telnet send the following command line where 00:01:02:03:04:05 must be replaced by the MAC address of the item to be woken, e.g.
<pre>
ether-wake 00:01:02:03:04:05
</pre>
To add this feature to the Humax start-up enter the following from Telnet :-
<pre>
echo /mod/bin/busybox/ether-wake 00:01:02:03:04:05 > /mod/etc/init.d/S30wol
chmod 755 /mod/etc/init.d/S30wol
</pre>
NOTES:-
*WOL is also built into [[Custom_Firmware_Package_Notes#Network_Shares_Automount|'''Network_Shares_Automount''']]
*The Humax itself cannot be switched out of Standby using Wake-up On Lan, as the LAN connector is not powered during Stand-by

==Xtra1 Portal==

See Guide [[Custom_TV_Portal| '''HERE''']]

==Youtube-dl==

This pacakage uses a command line to download videos from Youtube, BBC Iplayer, ITV Hub etc., in the following example, a 4K test video is downloaded from YouTube :-

<pre>
Humax2# youtube https://www.youtube.com/watch?v=SlLFOrWvY_M
</pre>

The above downloads a 720 line version of the file which is pretty useless when testing 2176 lines, however it is possible to list all available video formats using the -F option :-

<pre>
Humax2# youtube -F https://www.youtube.com/watch?v=SlLFOrWvY_M

[youtube] SlLFOrWvY_M: Downloading webpage
[youtube] SlLFOrWvY_M: Downloading video info webpage
[info] Available formats for SlLFOrWvY_M:
format code extension resolution note
249 webm audio only DASH audio 3k , opus @ 50k, 26.87KiB
250 webm audio only DASH audio 3k , opus @ 70k, 26.87KiB
251 webm audio only DASH audio 3k , opus @160k, 26.87KiB
171 webm audio only DASH audio 6k , vorbis@128k, 22.21KiB
140 m4a audio only DASH audio 145k , m4a_dash container, mp4a.40.2@128k, 932.03KiB
278 webm 256x144 144p 34k , webm container, vp9, 13fps, video only, 184.31KiB
242 webm 426x240 240p 44k , vp9, 25fps, video only, 248.03KiB
160 mp4 256x144 144p 50k , avc1.42c00c, 13fps, video only, 257.52KiB
134 mp4 640x360 360p 74k , avc1.4d401e, 25fps, video only, 417.64KiB
243 webm 640x360 360p 78k , vp9, 25fps, video only, 433.50KiB
133 mp4 426x240 240p 87k , avc1.4d4015, 25fps, video only, 480.96KiB
244 webm 854x480 480p 116k , vp9, 25fps, video only, 633.67KiB
135 mp4 854x480 480p 117k , avc1.4d401e, 25fps, video only, 656.08KiB
136 mp4 1280x720 720p 191k , avc1.4d401f, 25fps, video only, 1.04MiB
247 webm 1280x720 720p 203k , vp9, 25fps, video only, 1.08MiB
137 mp4 1920x1080 1080p 312k , avc1.640028, 25fps, video only, 1.71MiB
248 webm 1920x1080 1080p 357k , vp9, 25fps, video only, 1.89MiB
271 webm 2560x1440 1440p 609k , vp9, 25fps, video only, 3.20MiB
313 webm 3840x2160 2160p 1122k , vp9, 25fps, video only, 5.88MiB
17 3gp 176x144 small , mp4v.20.3, mp4a.40.2@ 24k, 272.97KiB
36 3gp 320x180 small , mp4v.20.3, mp4a.40.2, 1004.79KiB
43 webm 640x360 medium , vp8.0, vorbis@128k, 589.88KiB
18 mp4 640x360 medium , avc1.42001E, mp4a.40.2@ 96k, 1.61MiB
22 mp4 1280x720 hd720 , avc1.64001F, mp4a.40.2@192k (best)
</pre>

you can then select the required version of the video with the -f option

<pre>
Humax2# youtube -f "313" https://www.youtube.com/watch?v=SlLFOrWvY_M
[youtube] SlLFOrWvY_M: Downloading webpage
[youtube] SlLFOrWvY_M: Downloading video info webpage
[download] Destination: /mnt/hd2/My Video/TobyFree.com - 4K UHD Test Pattern H.264 MP4.webm
[download] 100% of 5.88MiB in 00:12
</pre>

NOTE:- the required download file is named *.webm this file won't be visible from the remote control OPT+ copy/move lisings, but is visible via Telnet / FTP etc., you can rename the file to something like 4K-test.mp4 before viewing directly on your 4K TV (not via the HD only Humax)

To combine video only and audio only files into a single file use the following option (Video MUST be the first item, e.g. 313)

<pre>
Humax2# youtube -f "313+171" https://www.youtube.com/watch?v=SlLFOrWvY_M

[youtube] SlLFOrWvY_M: Downloading webpage
[youtube] SlLFOrWvY_M: Downloading video info webpage
[download] Destination: /mnt/hd2/My Video/TobyFree.com - 4K UHD Test Pattern H.264 MP4.f313.webm
[download] 100% of 5.88MiB in 00:12
[download] Destination: /mnt/hd2/My Video/TobyFree.com - 4K UHD Test Pattern H.264 MP4.f171.webm
[download] 100% of 22.21KiB in 00:00
[ffmpeg] Merging formats into "/mnt/hd2/My Video/TobyFree.com - 4K UHD Test Pattern H.264 MP4.webm"
Deleting original file /mnt/hd2/My Video/TobyFree.com - 4K UHD Test Pattern H.264 MP4.f313.webm (pass -k to keep)
Deleting original file /mnt/hd2/My Video/TobyFree.com - 4K UHD Test Pattern H.264 MP4.f171.webm (pass -k to keep)
</pre>

Youtube-dl has a config file at :- /mod/etc/youtube-dl.conf

Full reference notes are here :-

[https://github.com/rg3/youtube-dl/blob/master/README.md#readme '''Github Notes''']

A list of websites claimed to be working for the Windows version of Youtube-DL is here :-

[https://rg3.github.io/youtube-dl/supportedsites.html '''Available Sites''']

'''Mainsteam sites Working on the Humax Version'''

Youtube, BBC Iplayer, ITV-Hub, dplay

'''Mainstream sites Not Working on the Humax Version'''

Channel4, My5, UKTVPlay

==Zeroconf==

mDNS Responder, Will create a humax.local name which can be seen by anything running mDNS

After installation the zeroconf package will participate in mDNS-like traffic so you can access the box by name from most operating systems. On some, like Apple and Linux, you would access it as humax.local (assuming humax is the hostname) and on others, like Windows, you can just use humax. Windows can also pick up the name to IP address mapping if you have Samba installed and running.

==Zip==

zip utilities for compressing files :-
<pre>
Humax HDR-Fox T2 (humax) 1.03.12/3.03

humax# zip
Copyright (c) 1990-2008 Info-ZIP - Type 'zip "-L"' for software license.
Zip 3.0 (July 5th 2008). Usage:
zip [-options] [-b path] [-t mmddyyyy] [-n suffixes] [zipfile list] [-xi list]
The default action is to add or replace zipfile entries from list, which
can include the special name - to compress standard input.
If zipfile and list are omitted, zip compresses stdin to stdout.
-f freshen: only changed files -u update: only changed or new files
-d delete entries in zipfile -m move into zipfile (delete OS files)
-r recurse into directories -j junk (don't record) directory names
-0 store only -l convert LF to CR LF (-ll CR LF to LF)
-1 compress faster -9 compress better
-q quiet operation -v verbose operation/print version info
-c add one-line comments -z add zipfile comment
-@ read names from stdin -o make zipfile as old as latest entry
-x exclude the following names -i include only the following names
-F fix zipfile (-FF try harder) -D do not add directory entries
-A adjust self-extracting exe -J junk zipfile prefix (unzipsfx)
-T test zipfile integrity -X eXclude eXtra file attributes
-y store symbolic links as the link instead of the referenced file
-e encrypt -n don't compress these suffixes
</pre>

Custom Firmware Package Notes

2020-06-07T22:27:56Z

MymsMan: Add Schedchk package

'''BRIEF NOTES FOR CUSTOM FIRMWARE PACKAGES'''
{{Note|Some Functions of the Web Interface are 'Built-In' and do not require any additional packages to be installed. These features are covered in the Web If section of this page.

Some packages require a reboot (Hard disk spin down) before they take effect.}}

Also, see Forum Links [[Forum_Links|'''HERE''']]

==7Zip==

Command line utility that can pack and unpack zip type files

*Supported Packing / unpacking formats = 7z, XZ, BZIP2, GZIP, TAR, ZIP and WIM
*Supported Unpacking only = ARJ, CAB, CHM, CPIO, CramFS, DEB, DMG, FAT, HFS, ISO, LZH, LZMA, MBR, MSI, NSIS, NTFS, RAR, RPM, SquashFS, UDF, VHD, WIM, XAR and Z.

==Arbookmarks==

Adds bookmarks into automatically or manually padded recordings, bookmarks are placed at [[Padding_versus_Accurate_Recording | '''Accurate Recording''']] start and stop points to all files in folders marked as Auto Decrypt, the following conditions must be met before the Bookmarks will be added :-
* The Arbookmarks package must be installed
* Files must be in a folder that is marked for auto-decryption ([[Icons#Media_Browser_-_Folders|'''open lock icon''']] present)
* Files must be DLNA indexed (automatically done by the Humax periodically, [[Icons#Media_Browser_-_Files|'''lime green circular icon''']] present)
* Files must not be recorded using AR i.e. the AR flags are not at start and end of file
* AR flags must be present i.e. recordings made in the middle of a programme won't contain AR flags

==At==

at, batch, atq, atrm - queue, examine or delete jobs for later execution. This is the UNIX at command and atd daemon, which allow for scheduling of one-off commands to be run when specified.

More notes [http://en.wikipedia.org/wiki/At_%28Unix%29 '''HERE''']

==Auto Schedule Restore==

This package checks whether the schedule is present on each boot, If a schedule is in place it is backed up to flash, otherwise the schedule and any favourites list are restored from the flash backup. The schedule will be deemed to be present if there is at least one schedule item or one reservation item existing

'''NOTES:-'''
* After a re-boot the restore process will start and "Schedule Restored . . . Rebooting" will be displayed on the front display
* A second re-boot will take place automatically after 15 seconds to finalise the restoration process
* The Web-if will display "The recording schedule has been automatically restored" after the second re-boot

==Auto-Unprotect==

The Auto-Unprotect package runs in the background and automatically removes the Encryption Protected flag on High Definition recordings on the HDR-Fox T2. This is the flag which prevents the file from being decrypted in the same way as a Standard Definition file. On first installation, the hard disk will be scanned for any High Definition recordings and they will be unprotected. Thereafter, new recordings will have the flag removed as they are completed. See reset_unprotect [[Diagnostic_Utilities | '''HERE''']] to fix any 'missed files'.

Auto, Auto-Unprotect makes a change to the DLNA index so that High Definition files can be streamed without DTCP, Note, Foxy does not remove DTCP which is required for DLNA decryption

NOTES:-
*The removal of the ENC flag does not decrypt the file, however it does make decryption possible by the same means as for a Standard Definition file - see flow chart [[Encryption |'''HERE''']].
*Auto-Unprotect on the HD-Fox T2 will not allow decryption unless the HD-Fox T2 is running in BootHDR mode

==Auto-Update==

This package automatically keeps the installed packages up to date by checking for any new releases daily and automatically downloading and installing them. It will check once per day at the earliest power on - for most people probably the 04:30 boot.

==Badnts==

Utility to fix a recording error where a full size TS file is recorded but the associated NTS file generated by the Humax is of zero length, this results in the the Humax rejecting the file on playback. After the recording is decrypted in a folder that is marked for auto-decyption, the utility will look for a zero length NTS file and if found the NTS, THM and HMT files will all be deleted (or moved to the [Deleted] folder), this will make the TS file playable on the Humax,however as the 'sidecar' files have been removed there will be some play-back
limitations, e.g. transport controls etc.
'''Notes'''
*This utility only works on HDR-Fox T2 not HD-Fox T2
*Only files stored in an auto-decrypt folder will be fixed

==Bash==

Bourne Again SHell is an enhanced [[Custom_Firmware_Package_Notes#Sh | '''Sh (Shell)''']] Command line / scripting language. [http://www.gnu.org/software/bash/manual/bashref.html '''See Reference Guide''']

==Betaftpd==

===For HDR-Fox T2===

The HDR-FOX T2 has a built-in FTP server. The default server will still be available after the Custom Firmware is installed, however only files under ‘Media’ are visible. Betaftpd has two possible Logins. If login = humaxftp and password = 0000 is used then only ‘Media’ is visible. If login = root and password = 0000 is used then the entire file system is accessible. If the remote password has been changed from 0000 then the new password must be used.

NOTE:- The Built-in FTP server must be turned off if Betaftpd is used with Menu >> Settings >> System >> Internet Settings >> FTP Server = OFF

===For HD-Fox T2===

Betaftpd will add an FTP server to the Humax after installation. Betaftpd has two possible Logins. If login = humaxftp and password = 0000 is used then only ‘Media’ is visible. If login = root and password = 0000 is used then the entire file system is accessible. If the remote password has been changed from 0000 then the new password must be used.

==Blocklist==

See Transmission (torrent) Block List notes [[Custom_Firmware_Package_Notes#Blocklist_2|'''HERE''']].

==Bookmark==

The Humax Bookmarks used to place 'jump-to' points within a recording are also used by several Custom Firmware packages, as Follows:-
*[[Edit_On_Box|'''Edit On Box''']] . . . A single or multiple bookmarks are used as cut and join points for editing a recording in the Web-If [[#Crop|'''Crop''']] option
*[[#Set_Thumbnail|''' Set Thumbnails''']] . . . Uses the the first bookmark in a recording as a central point from which to pick a new thumbnail
*[[#Arbookmarks|'''Arbookmarks''']] . . . Bookmarks are automatically added to a recording at [[Padding_versus_Accurate_Recording|'''Accurate Recording''']] start and stop points so that a [[#Crop|'''Crop''']] can be performed

==BootHDR==

<big>'''This package is for the HD-FOX T2 only (NOT for HDR-Fox T2</big>''') 

It allows the HD-FOX T2 to run the software for the HDR-FOX T2, to allow decryption of recordings by copying to a volume. BootHDR can be installed from the Web-If packages screen (of the HD-Fox T2 only). Here is the equivalent command line (Telnet) :-

 opkg install wget 

 opkg install boothdr --force-reinstall 

Once the package is installed you can run in HDR-Fox T2 mode, while in this mode, the front panel display will freeze and the box will be incapable of making new recordings. To initiate HDR-Fox T2 mode copy the *Modsettings/TriggerHDR folder to the root of drive1 and then re-boot the HD-Fox T2

Installing the BootHDR package also adds the command line keyword bootHDRmode, this can be used to invoke HDR mode

There is a Guide to using BootHDR on the Wiki [[Decrypt_recordings_on_the_HD-FOX_T2 | '''HERE''']]

==Boot_Settings==

Set system parameters to specified values on every boot. [Update settings]

==Bsed==

Binary-safe search/replace utility.

==BusyBox==

Your Humax box has a ‘Unix’ operating system. Busybox is a package that provides 158 common Unix [[Custom_Firmware_Package_Notes#Sh_.28SHell.29 | '''Sh (Shell)''']] commands that can be used in Telnet sessions. The list below shows the available commands. There is no 'man' command that would explain what they do, but most commands can have a -? or -h extension to get some help e.g. ls -?

A command look up table can be found [http://busybox.net/downloads/BusyBox.html '''HERE'''].

NOTE:- It is not a good idea to 'Play' with these commands if you don't know what you are doing.

<div style="column-count:8;-moz-column-count:8;-webkit-column-count:8">
*[
*[[
*ar
*arp
*arping
*ash
*awk
*base64
*basename
*bunzip2
*bzcat
*bzip2
*cal
*cat
*catv
*chgrp
*chmod
*chown
*chroot
*cksum
*clear
*cmp
*comm
*cp
*cpio
*cut
*date
*dc
*dd
*df
*diff
*dirname
*dos2unix
*du
*echo
*ed
*egrep
*env
*ether-wake
*expr
*false
*fgrep
*find
*fold
*free
*ftpget
*ftpput
*fuser
*grep
*gunzip
*gzip
*hd
*head
*hexdump
*ifconfig
*insmod
*install
*iostat
*kill
*killall
*killall5
*last
*less
*ln
*logname
*ls
*lsmod
*lsusb
*lzcat
*lzma
*md5sum
*mkdir
*mkfifo
*mknod
*mktemp
*modinfo
*modprobe
*more
*mpstat
*mv
*nc
*netstat
*nice
*nmeter
*nohup
*nslookup
*od
*patch
*pgrep
*ping
*pkill
*pmap
*printenv
*printf
*ps
*pstree
*pwd
*pwdx
*readlink
*realpath
*renice
*rm
*rmdir
*rmmod
*route
*rpm
*sed
*sendmail
*seq
*sh
*sha1sum
*sha256sum
*sha512sum
*sleep
*sort
*split
*stat
*strings
*stty
*sum
*sync
*sysctl
*tail
*tar
*tee
*telnet
*test
*tftp
*time
*top
*touch
*tr
*traceroute
*true
*tty
*uname
*uniq
*unix2dos
*unlzma
*unxz
*unzip
*uptime
*usleep
*uudecode
*uuencode
*vi
*watch
*wc
*wget
*which
*who
*whoami
*xargs
*xz
*xzcat
*yes
*zcat
</div>

==Channeldel==

Note: now superseded by tunefix

Automatic channel deletion. select TV channels to be permanently removed from the group TV list in Web-If >> Settings >> Automatic Channel Deletion, selected channels, plus a set of 9 unavailable channels known to cause problems will be automatically deleted the next time the Humax is booted, and following any retune

Select all but one file and press delete to reduce the current list in /mod/boot/chandel.conf, the remaining file can be deleted later

==ChaseDecrypt==

Retrieve and decrypt recording whilst recording is still in progress, uses Chaseget

See [[ChaseDecrypt]] for further details

==Chaseget==

Retrieve and decrypt recording, can run whilst recording is still in progress

This is intended to be used as part of other packages (such as detectads) rather than installed and used standalone

Runs as first stage of pipeline, output is always to stdout

Usage= /mod/bin/chaseget recording.ts start_offset logfile > output.ts

==CIFS==

The Common Internet File System. The cifs package provides the Humax with the ability to remotely access files shared from PCs using Windows file sharing. This package adds the support to the running system but mounting remote file systems must currently be performed from the command line. Example :-

 mkdir /media/NAS 

 mkdir "/media/My Video/NAS" 

 mount -t cifs //server/share /media/NAS -o user=abc,password=def 

 mount -t cifs //server/share "/media/My Video/NAS" -o user=abc,password=def 

==CLI==

This is an acronym for Command Line Interface, a CLI can be established by Telnetting into the Humax and being presented with a CLI prompt, If the Tmenu is displayed there will be a 'cli' option to gain the CLI prompt e.g. humax#

==Content Sharing==

Menu >> Settings >> System >> Internet Settings >> Content Sharing = On

Content Sharing is an in-built DLNA / UPnP server that allows the HDR to stream content over it's LAN connector to a DNLA / UPnP client, this feature is also used by the Custom Firmware to provide decryption of both Standard Definition and High Definition content

==Crashdiag==

Captures a memory dump (core file) when the main Humax process crashes,The dump files will end up in /mod/core/ called humaxtv.<UNIX timestamp> and a reboot is required following package installation in order to activate it

==Crash Log==

The Mulitenv 1.4 package contains a procedure that monitors the behaviour of running processes, If the Humax crashes a file will be generated under /mod/tmp/ called crash.log, it can be examined from Web-If >> Diagnostics >> View Log Files. The Crash log will tell you if Custom Firmware plug-ins are being disabled as a result of the crash, To re-start undelete, redring and ir packages, run Web-If >> Diagnostics >> fix-flash-packages >> Run Diagnostic. To prevent the crash log auto disabling plug-ins, create a file with the following command :-
<pre>
touch /var/lib/humaxtv/mod/no_plugin_autodisable
</pre>

==Cron==

Cron is a time-based job scheduler that will auto-run tasks for you. It is built into Busybox which is a standard utility on your Humax, so Cron does not need to be installed. The tasks are held in a Cron table or crontab. Here is an example crontab :-

<pre>
humax# cd /mod/var/spool/cron/crontabs/
humax# cat root
0 2 * * * /mod/sbin/anacron -s -d
1,31 * * * * /mod/sbin/unencrypt "/mnt/hd2/My Video/archive" > /mod/tmp/unencrypt.log 2>&1
*/10 * * * * /mod/sbin/rs_process >> /mod/tmp/rs.log 2>&1
humax#

</pre>

Each line of crontab has the following structure:

<Minute> <Hour> <Day> <Month> <Day of Week> <Command line> Note :- * = All or Every

The three examples above will run
#at 2AM every day
#at 1 Minute and 31 Minutes of every Hour every day
#every 10 Minutes continuously

It is possible to display all cron jobs with the following command line:-

 crontab -l 

To add a new cron job edit file /mod/var/spool/cron/crontabs/root and add a new line

==Cryptokey==

This is the unique key that is used by the Humax HDR / HD to encrypt and decrypt all recordings on the hard disk, it is made up from the MAC address of the unit (6 pairs of hexadecimal) followed by the first 10 digits of the unit's serial number (also in hexadecimal)

The cryptokey can be examined, changed and reset (Cleared) to the original by sending the following [[Custom_Firmware_Package_Notes#Nugget | '''nugget''']] command line options :-

<pre>
humax# nugget cryptokey
Native key: dc d3 21 01 02 03 36 33 37 31 30 35 37 36 33 30
Using key: <no custom key in use>

humax# nugget cryptokey 01.01.01.01.01.01.01.01.01.01.01.01.01.01.01.01
Using key: 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01

humax# nugget cryptokey
Native key: dc d3 21 01 02 03 36 33 37 31 30 35 37 36 33 30
Using key: 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01

humax# nugget cryptokey -clear
Cleared custom encryption key.

humax# nugget cryptokey
Native key: dc d3 21 01 02 03 36 33 37 31 30 35 37 36 33 30
Using key: <no custom key in use>
</pre>

The cryptokey is used by the [[Custom_Firmware_Package_Notes#Stripts | '''Stripts Package''']] when decrypting files on the Humax

==Curl Command==

curl command line utility.

==Custom TV Portal==

An extension to the Humax TV Portal that adds more features.

Full Guide[[Custom_TV_Portal | '''HERE''']]

==DB Update==

General boot-time database update utility

==Dedup (Command Line)==
[[File:Webif-media-ded.png|right|150px]]
[[File:Webif-media-ded2.png|right|150px]]
The dedup package adds a command line utility which can consolidate recordings within a single folder so that duplicates are removed and the remaining episodes are renamed so that the episode name and number (if available) are displayed in the Media Browser.

Note:- There is a 'built-in' version of Dedup in the [[Custom_Firmware_Package_Notes#Web_IF | '''Web-If ''']] that effectively replaces the command line package. However if the dedup package is installed it is possible to perform the following Telnet commands from the folder you have navigated to:-

 dedup HIDE lists the recordings there and shows what they would be renamed to

 dedup -yes HIDE perform the changes as detailed below :-

*Renames the files on disk to match the episode name
*Changes the title shown in the media list to match the episode name
*Identifies duplicate episodes and moves them to a sub-folder called dup/

==Dedup (Series Helper File)==

It is possible to create a series helper file that Dedup can use to enhance the re-naming of series, the file should be placed in the directory containing the series and named series.info, Dedup will look for this file and automatically use it, an example of a series.info file is shown below :-

<pre>
Pilot ==> S1-01
Pilot The Big Bang Theory ==> S1-01
The Big Bran Hypothesis ==> S1-02
The Fuzzy Boots Corollary ==> S1-03
The Luminous Fish Effect ==> S1-04
The Hamburger Postulate ==> S1-05
The Middle Earth Paradigm ==> S1-06
The Dumpling Paradox ==> S1-07
The Grasshopper Experiment ==> S1-08
The Cooper-Hofstadter Polarization ==> S1-09
</pre>

The above 'full' file is stored here :- [http://hummypkg.org.uk/series/tbbt.series.info '''http://hummypkg.org.uk/series/tbbt.series.info''']

==DeRMA==

After a Web-If >> Diagnostics >> Set-Return-to-manufacturer (RMA) Mode operation has been carried out, standard Humax software should be re-installed, this should leave the Humax in an 'out-of-the-box' state, however if for any reason the 'RMA' message is still being displayed, then loading this package onto a USB stick and inserting it into the Humax, while it is running, will remove the RMA message

==Detectads==

This package will attempt to add bookmarks to a recording to indicate the start and end of advert breaks, so that the adverts can be removed with a crop function, cropping can optionally be performed automatically within the package,

Using the new 'Detect while recording' function the detection process runs in parallel with the actual recording so the processing completes within a few seconds of the recording finishing. You can even, with some limitations, start to watch your program adfree whilst it is still recording.

See [[DetectAds]] for more information about this package

==Disable DSO==

Disable automatic retuning in response to Digital-Switch-Over events. When the Humax carries out a retune all recording Schedule events and all Favourites Lists will be erased, however recorded programmes will not be erased. DSO events are sent to the Humax by the TV broadcasters when they need to change some aspect of the Electronic Programme Guide, such as changing a channel number or adding extra channels

==Disable OTA==

Disable OTA inhibits any Over The Air software updates transmitted by Humax by deleting OTA schedules created by the Humax, it also has a "Create Reminder to cover OTA Period = Y / N" option in the Settings page, this will create a reminder on the Red Button (channel 200) to cover the OTA period, if you want it to use a different channel or on / off time, you can edit the reminder using the standard Humax on-TV menus, you can also disable the reminder option completely, however if this is done there is a small possibility that an OTA search may still be actioned on your Humax

'''Note''' The OTA service for software updates is no longer in operation

==Display==

A command that can be used to display a message on the HDR-Fox T2 front panel, any alpha-numerics (Max 12 characters) can be displayed, scrolling is not available. The new message will be displayed until the unit is rebooted or changed by the Humax, example :-

 /sbin/display 'Twelve Chars' 

The display can be blanked with :-

 /sbin/display ' ' 

The display of the HD-Fox T2 (Max 4 characters + colon) can also be used by adding '$' to the string e.g. :-

 /sbin/display '$he:lp' 

'''NOTE''' If the Humax updates the display e.g. after a channel change or is scrolling the display then your message will be removed

==DLNA-Filter==

Filters out DLNA server network traffic to prevent other DLNA servers from crashing the Humax. File /mod/etc/init.d/S02dlna-filter contains rule="-p tcp --dport 50001 -j DROP". From default the package works on all IP addresses, however in Web-If >> Settings >> Settings for DLNA-Filter package, it is possible to restrict operation to one or more specified IP addresses

'''NOTES'''
*DLNA-Filter requires Custom Firmware Version 3.00 or later
*DLNA-Filter will block access to the Humax DLNA server if the Settings for DLNA-Filter package is left blank

==DLNA-Servername==

This package enables Humaxs on the same network to be given a unique Media Server Name. It requires that Custom Version 2.20 or above be installed

==Dropbear SSH==

A secure shell (ssh) server for the Humax. This package provides remote command line access over an encrypted session and is a secure alternative to using Telnet
to gain command line access - although it causes the box to do more work. Also allows the use of ''scp'' (secure copy) as a secure alternative to FTP.

Login with username=root, password=humax

Create file /mod/.ssh/authorized_keys containing a list of public keys

Note :- chmod 700 /mod/.ssh and chmod 600 /mod/.ssh/authorized_keys

==Dropbear SFTP==

Greenend-sftp is a plugin for dropbear-ssh which provides SFTP server functionality.SFTP is often used to provide remote virtual filesystem (VFS) access to the Humax's filesystem, e.g. via FUSE. For further info. click link [http://www.greenend.org.uk/rjk/sftpserver/ '''HERE''']

==DUMA==

D.U.M.A. - Detect Unintended Memory Access - A Red-Zone memory allocator. It can detect memory leaks and buffer overruns (or underruns) in a malloc() / new memory buffer. DUMA is a fork of Bruce Perens' Electric Fence library.

==Dvbsnoop==

Utility for inspecting DVB files. Some more info [http://dvbsnoop.sourceforge.net/ '''HERE'''].

Note that one cannot inspect live streams off air on the Humax, as the Humax doesn't provide the required software interface to its DVB hardware.

==E2fs_Progs==

Ext2/3/4 File system Utilities. The Linux File Disk system used on the Humax. Useful for formatting a USB Flash drive in EXT2 to avoid journalling. First allow the Humax to format the drive as EXT3 then follow the procedure [[FAQs#How_do_I_convert_a_drive_to_EXT2.3F|'''HERE''']].

==[Eject]==
[[File:Eject.png|left|50px]]
The Eject icon is displayed (If a USB Device is detected), on all Web-if Headers adjacent to the FREEVIEW icon, when the user clicks on this icon, a list of USB devices attached to the Humax will be displayed with the following information (from Left to Right) :-

*USB interface name
*USB Device name
*Format type, e.g. FAT32, NTFS, EXT3 etc.
*Device % used
*Device capacity
*Eject Option

To the far right there is an eject icon, when the user clicks on this icon, an option will be displayed, e.g. "Eject USB-1? - OK or Cancel, If OK is selected the USB device will be unmounted, this is similar to the Windows option "Safely Remove Hardware"

If 'Device not mounted' is displayed, the user can click on the recycle icon (far right) to display a 'Rescan OK/Cancel' option, this will allow a rescan and the USB device will be re-mounted

'''NOTES'''
*This feature is only present on the HDR-FOX T2, not the HD-FOX T2

==EPG==

The command line utility used by the Electronic Program Guide in the Web-If e.g. :-

<pre>
humax# epg
Humax EPG Tool v1.0.8, by af123, 2011.

Syntax: epg [options] [filters] <command>...

Options:
-b Brief output.
-d[level] Set debug level.
-f<file> Specify alternate EPG data file.
-h Show help text.
-p Parsable output.

Filters: (can be specified multiple times, all must be true)
-C<CRID> Show only events with this CRID.
-D<descriptor type> Show only selected descriptor type.
-E<event id> Show only selected event.
-R<SCRID> Show only events with this Series ID.
-S<service id> Show only selected service.
-T<content type> Show only selected content types.
-@<unix timestamp> Show only programmes at time.
-/<unix timestamp> Show only programmes on day.
-/<days> Show only programmes on day.
-=<start>:<end> Show only programmes in time period.

Commands:
dump Show a parsed summary of the EPG.
dumpraw Show raw data from the EPG.
sqldump Produce SQL statements from EPG data.
sqlitedump <file> Create SQLite database from EPG data.
now Show what is currently on.
first Show the time of the earliest record.
last Show the time of the latest record.
parse Parse the EPG, no output.
search <text> Search programme names for text.
searchall <text> Search programme names/descriptions for text.
</pre>

==Epgfix==

epgfix causes a channel change once a day (by default at 4am) for 3 minutes before restoring the original channel it was tuned to. This is enough to trigger the Humax software to keep the EPG up to date when the Humax is on 24/7, (it has no advantage when the unit has a daily on/standby cycle).

You need at least a single service on an alternative mux. to the one the box is tuned to for it to work. Changing to a different service on the same mux. was found not to work reliably enough.

There is no user interface, no settings and nothing to configure. The only thing you can change is the time of operation if it is not suitable!
You have to do this manually by editing the /mod/bin/epgfix entry in the /mod/var/spool/cron/crontabs/root file. This is easily available using the File Editor on the WebIf's Diagnostics page.

==Epg Keywords (Web-If)==

This package was a web interface plugin which allowed a list of keywords to be configured and when found an email was sent Weekly to a specified email address detailing any programmes in the EPG which matched the keywords.

NOTE:- The EPG Keywords functionality has now been moved to [[Remote_Scheduling_Auto | '''Remote Scheduling Auto''']].

Initial Setup :-
*Web-If MAIN >> SETTINGS >> Email address >> myname@talktalk.co.uk
*Web-If MAIN >> SETTINGS >> SMTP >> smtp.talktalk.co.uk
*Web-If MAIN >> SETTINGS >> SEND TEST EMAIL

==Epgpatch==

Utility for patching EPG information in a completed recording, it is used to fix problems in TV areas that use non standard EPG data e.g. Ireland Saorview

==Enable Telnet==

This USB loaded package will re-enable telnet for the Custom Firmware, it performs the following command lines :-

<pre>
rm -f /var/lib/humaxtv/mod/notelnet
/etc/init.d/S50telnet start << /dev/null >> /dev/null 2>&1
</pre>

==Exfat==

This package adds support for reading and writing files in the Exfat format

Please take the time to read the [http://en.wikipedia.org/wiki/ExFAT '''Wikipedia'''] article on exFAT

==Exfat Builder==

'''See Exfat above'''

[[File:exfat-panel.png|right]]
'''Note that this package does not add exFAT support to your system, only provides a simple method for you to do it yourself.''' This is because there are licence and patent issues around exFAT and if we were to make the compiled exFAT code available in the repository then we would be in violation of at least some of them.

The package provides a web page (accessible from the standard web interface settings screen) from which you can download, build and install the required files in a single step. It will:

*Download an open-source exFAT implementation from Google Code;
*Unpack and modify the code to support the Humax;
*Compile the files into binaries which can run on the Humax;
*Install the compiled binaries on your system;
*Add hooks to automatically mount exFAT disks when they are detected.

==EXTRA.css==

See [[Custom_Firmware_Package_Notes#Webif_Style_Sheet|'''Webif Style Sheet''']]

==Fan==

the default fan speeds set by humax are :-
*70% - once the HDD temperature reaches 55°C
*65% - when the temperature drops to 54°C
*55% - when the temperature drops to 51°C
*0% - when the temperature drops to 49°C

This utility allows the user to set a minimum continuous fan speed between 0% and 100%, By setting a minimum fan speed higher than zero it is possible to prevent the fan reaching the noisier 70% setting. If the Humax requests a higher speed setting, this higher speed will be used

'''Notes'''

*After an initial Humax restart, this package can change the minimum fan speed on-the-fly every two minutes
*The fanspeed (0 - 255) is stored in the /mod/boot/fanspeed file
*Changes made by this package will be displayed in the /tmp/humaxtv.log file, if Diagnostics >> debugtv >> Run Diagnostic has been run

<pre>
Editing /tmp/humaxtv.log
Sun Sep 15 10:42:36 2013 Applying minimum fan speed = 255 (ff)
Sun Sep 15 10:44:36 2013 Applying minimum fan speed = 0 (0)
</pre>

==Ffmpeg==

FFmpeg will record, convert, extract and stream audio and video. It includes libavcodec - the leading audio/video codec library. It also displays information about video and audio files. See Link [http://ffmpeg.org/ffmpeg.html '''HERE''']

NOTE:- Ffmpeg operations performed on the Humax can be very demanding on CPU time, especially when performing conversions rather than extractions. The following examples were carried out using a version of Ffmpeg running on a P.C.rather than on the Humax.

Convert an extracted MP3 audio file in MP2 format to the more common MP3:-

 ffmpeg -i input.ts -vn -ar 44100 -ac 2 -ab 192000 -f mp3 output.mp3

Extract an MPG file from a Hi-Definition TS file from the Humax :-

 ffmpeg -i input.ts -target pal-dvd -vcodec copy -acodec copy output.mpeg

There is also a GUI from end available for the P.C. version of ffmpeg [http://avanti.arrozcru.org/'''HERE''']

==Fix-disk==

Fix-Disk is a disk partition repair utility (built into Custom Firmware Ver 2.12 and above) for the Humax HDR-Fox T2. It does a full file system check, repairing minor faults automatically as it goes. It will also allow you to fix the delete loop problem. A fix-disk.log file will be generated in /mod/tmp/ and can be viewed using Web-If >> Diagnostics >> View Log Files

To invoke the Fix-Disk utility follow the Maintenance Mode Guide [[Maintenance_Mode | '''HERE''']]

==Fix-disk (USB)==

As fix-disk is now built into Custom Firmware 2.12 and is therefore already resident on your hard drive, the USB version is no longer recommended or supported. However it is still available [[http://www66.zippyshare.com/v/44898524/file.html '''HERE''']].

==Flatten==

This feature changes how recorded programs are displayed on screen in the 'Media - My Video' menu. Series of programs are normally grouped into a sub-folder. Flatten will move the contents of sub-folders to the main 'Top' folder and remove empty sub-folders. After installing flatten the Web-If will have an option under OPT+ which lets you toggle directories between flatten and no-flatten.

'''NOTES'''
#All directories will default to have flatten turned on unless they are changed
#Flatten runs every 15 Minutes when the box is not in standby

'''Exceptions'''

* Folders marked as no flatten using the OPT+ option will not be flattened
* Folders whose names are bounded by square brackets e.g. [NOT THIS ONE] will not be flattened
* Folders containing a file called .noflatten will not be flattened (Note:- Create this file Via Telnet)

==Flatview==

FlatView is an alternative to flatten, it provides both a flattened view and a hierarchical view at the same time by creating a new top-level directory (called " [FlatView]" by default). Recordings appear in both without using any additional disk space

'''NOTES'''

*Recordings deleted from the flattened view area are automatically removed from the original location in the hierarchy and the original folder will be removed if it is empty;
*Recordings deleted from the hierarchical view will be automatically removed from the flattened area too;
*If a recording is renamed in either area, then the change will be reflected in the other (there may be a small delay);
*Changes in flags such as 'Unwatched' and the resume point are synchronised across the two locations;
*If you move a recording out of the flattened view area, the system will think that it has been deleted and will remove the corresponding recording from the hierarchical view area;
*If you move a recording into the flattened view area, it will be left untouched
*Command line option = /mod/webif/plugin/flatview/run

'''Exceptions'''

*The contents of folders marked as no flatten using the OPT+ option will not appear in [Flatview]
*The contents of folders with names in square brackets [Like This] will not appear in [Flatview]
*The contents of folders containing a file named .noflatten will not appear in [Flatview]

==Flexget==

FlexGet is a multi-purpose automation tool for content like torrents, nzbs, pod-casts, comics, series, movies, etc. It can use different kinds of sources like RSS-feeds, html pages, csv files, search engines and there are even plugins for sites that do not provide any kind of useful feeds.

A Typical Cron entry for Flexget would be :-

 */1 * * * * /mod/bin/flexget -c /mod/.flexget/config.yml --cron 

* Flexget Documentation [http://flexget.com '''HERE''']

==Flexview==

FlexView is intended to offer an alternative to the traditional webif to allow you to view an manage your recording inventory in whatever way suits you

[[FlexView | '''See a Guide to Flexview''']]

==Forcedate==

This utility forces the date on your Humax to 16 November 2011 12:34:56. It is required if the Humax can't get Time / Date info Over The Air. After using Forcedate it is possible to set time / date to internet time automatically on boot-up using [[Custom_Firmware_Package_Notes#Ntp_Client | '''NTP Client''']].

==Foscam==

See Guide [[Custom_TV_Portal#Portal_Foscam | '''HERE''']].

==FTP==

File Transfer Protocol is a method of transferring files to and from your Humax. The Humax HDR-Fox T2 has a built-in FTP server for access to the media folders only. See the [[Custom_Firmware_Package_Notes#Betaftpd |'''Betaftpd package''' ]] for access to the full Humax file structure or to add an FTP server to the HD-Fox T2. To use FTP on a P.C. a program that handles FTP is required. Internet Explorer and Windows (file) Explorer will allow FTP access by entering ftp://10.0.0.200 into the address bar, although access may be restricted to media folders only, even when using the Betaftpd package. If access to the whole file structure is required, programs like Filezilla or WS_FTP_Pro can be used.

Notes :-
* To use the Built-In Humax FTP server MENU >> Settings >> System >> Internet Settings >> FTP Server = ON
* When using Betaftpd MENU >> Settings >> System >> Internet Settings >> FTP Server = OFF
* 10.0.0.200 needs to be replaced with your own Humax IP address
* login = humaxftp
* password = 0000 (your Remote Pin default). If the remote password has been changed from 0000 then the new password must be used

==Foxlink==

Helper package for linking a HD Fox-T2 to a HDR, See [[Foxlink|'''Guide Here''']]

==Fuse==

With FUSE it is possible to implement a fully functional filesystem in a userspace program.

==Genre Icons==

It is possible to inhibit the Genre Icons displayed in the Web-If, see [[Custom_Firmware_Package_Notes#Webif_Style_Sheet | ''' Web-If Style Sheet''']]

==Git==

Distributed version control system designed to handle everything from small to very large projects with speed and efficiency.

==Grep==

Grep is built into Busybox and is used to search through a file or files looking for specified blocks of text. The output can be displayed on-screen or sent to a new file. [http://unixhelp.ed.ac.uk/CGI/man-cgi?egrep Syntax Here]

Associated utilities = Egrep, Fgrep

<pre>
humax# cat original-file.txt

-H Add 'filename:' prefix
-h Do not add 'filename:' prefix
-n Add 'line_no:' prefix
-l Show only names of files that match
-L Show only names of files that don't match
-c Show only count of matching lines
-o Show only the matching part of line
-q Quiet. Return 0 if PATTERN is found, 1 otherwise
-v Select non-matching lines
-s Suppress open and read errors
-r Recurse
-i Ignore case
-w Match whole words only
-F PATTERN is a literal (not regexp)
-E PATTERN is an extended regexp
-m N Match up to N times per file
-A N Print N lines of trailing context
-B N Print N lines of leading context
-C N Same as '-A N -B N'
-e PTRN Pattern to match
-f FILE Read pattern from file

humax# grep match original-file.txt
-l Show only names of files that match
-L Show only names of files that don't match
-c Show only count of matching lines
-o Show only the matching part of line
-v Select non-matching lines
-e PTRN Pattern to match
humax#
</pre>

==Gnu Fdisk==

GNU fdisk.

==Hdparm==

hdparm is a command line utility for setting and viewing ATA hard disk drive hardware parameters. It can set parameters such as drive caches, sleep mode, power management, acoustic management, and DMA settings.

==HMT==

This package displays information on, and allows editing of, the Humax *.hmt file, which is a small 'side-car' file created alongside the main *.ts video file.

From a Telnet session, navigate to a directory containing an *.hmt file, then enter hmt {filename}

 hmt KAISER_CHIEFS_DD5_1_20110410_0147.hmt 

'''hmt Options List'''
<pre>
humax# hmt
Humax HMT Tool v2.0.6, by af123, 2011-2015.

Syntax: hmt [command] <filename> [filename] ...
Commands:
+/-new Mark/unmark recording as new.
+/-lock Mark/unmark recording as locked.
+/-guidance Mark/unmark recording as having guidance.
+/-protect Enable/disable protection (prevents decryption on copy).
+/-encrypted Mark/unmark recording as encrypted.
+/-shrunk Mark/unmark recording as shrunk.
+/-dedup Mark/unmark recording as deduped.
+/-detectads Mark/unmark recording as ad-detection-done.
-p Display parseable file information (see *).
-list Display file information (default).
-bookmarks Display bookmarks.
+addbookmark=<seconds>[:<seconds>]...
+setbookmarks=<seconds>[:<seconds>]...
+clearbookmarks
+settitle=<new title>
+setsynopsis=<new synopsis>
+setguidance=<new guidance>
+setfolder=<new folder> (patch hmt only)
+setfilename=<new filename> (patch hmt only)
+setgenre=<genre> (can just specifiy initial part)
+setresume=<resume point (seconds)> (-seconds to set from end)

Generic patch commands:
+patch8=offset:value patch 8-bit value
+patch16=offset:value patch 16-bit value
+patch32=offset:value patch 32-bit value
Offset and value can be preceeded with 0x to indicate hex.

Generic read commands:
+read8=offset read 8-bit value
+read16=offset read 16-bit value
+read32=offset read 32-bit value
Offset can be preceeded with 0x to indicate hex.

* Parseable output is tab delimited and contains the following fields:
Title, Synopsis, HD/SD, LCN, Channel Name,
Start time, End time, Flags, Guidance, Bookmark count,
Scheduled start, Scheduled duration, Genre code,
Resume point, Status/Reason.

</pre>

'''Notes'''
*+addbookmark=100:200:300 = Add to existing bookmark list
*+setbookmarks=100:200:300 = replace bookmark list with this new ones
*+setbookmarks= = same as +clearbookmarks i.e. remove all bookmarks

==hmt-linux==

A version of hmt compiled to run on a Linux platform (not for the Humax)

==hmt-solaris==

A version of hmt compiled to run on a Solaris platform (not for the Humax)

==Hrwconv==

Wrapper script for ffmpeg and sidecar packages to convert 9200T/9150T/9300T files to HDR format

It is recommended that you create a new directory and move your existing 9200T/9150T/9300T files and their sidecars into it, Hrwconv will not make any changes to the originals but will create new files so you will need to ensure that you have enough free disk space.

After installing the package, connect to the Humax via Telnet, change directory 'cd' to the new directory and then run:-

<pre>hrwconv *.ts</pre>

After a few hours the new files will have been created in the subdirectory 'new'

==HTTPS==

HyperText Transfer Protocol Secure is an extra layer built into the normal HTTP protocol used to access the Web-Interface for the Humax, It provides a more secure connection to the Humax. An HTTPS Server can be enabled in Web-If >> Settings >> General Settings >> HTTPS web server = On

==Humaxrw==

Utility to copy recordings from a Humax 9200T/9150T/9300T hard disk that is connected to the HDR via USB. The files recorded on 9000 series Humaxs are playable on the HDR, however the HDR can't directly read a hard disk formatted on a 9000 series, Humaxrw will allow the transfer of files between 9000 series and the HDR.

After installing Humaxrw, access to the utility is by [[Custom_Firmware_Package_Notes#Telnet | '''Telnet''']] command line.

<pre>
humax# humaxrw -h
Host <-> Humax disk
===================
Usage: humaxrw [options] HUMAXDISK

-b backup all recordings from Humax disk to current directory
-d <list> delete recordings
-g <list> get recordings to current directory
-h help (this text)
-i <list> get info for recordings
-l list recordings
-p <filename> put recording(s) onto Humax disk
-u <list> unprotect recordings
-v version
-x extended listing for humaxdiag
-w pause at the end waiting for a keypress
-y answer yes to all prompts

Advanced Options
-D Delete time shift recording buffers
-E Update all synopsis/info data for version 1.00.20 or later
-H <list> get hre files for recordings
-M <n> modify recording number n (use with -O & -V options)
-O <n> offset for modify recording (use with -M & -V options)
-V <n> modify recording value (use with -M & -O options)
-Z Delete EPG save data

Humax disk -> Humax disk
========================
Usage: humaxrw [options] SRCHUMAXDISK DESTHUMAXDISK

-b backup all recordings from source Humax disk
and copy to destination Humax disk
-g <list> get recordings from source disk
and copy to destination Humax disk

Recovery mode - use if record list is missing/corrupt
=============
Usage: humaxrw -r [options] HUMAXDISK

-i <list> get info for recordings
-l list recordings
-n no info - use if corruption is really bad
-g <list> get recordings to current directory as recover_nnnn.ts

Example of a list: 10-20,30,41-42
</pre>

==Humidify==

A utility for manipulating Humax Download Format (HDF) files.
<pre>
humax# humidify
HDF Tool v1.0.4, by af123, 2011-2015.

Syntax: humidify [options] <filename>
-C Skip checksum validation.
-c <arguments> Create HDF file ('-c help' for more).
-d<level> Enable debugging at level.
-l Show contents of HDF file (default).
-o Use old-style checksum blocks when creating.
-r Don't compress blocks when creating.
-S<section> Extract only the numbered section.
-t Test archive (validate checksums).
-x Extract files.
-s Also show/extract member checksums.

Examples:

View HDF: humidify file.hdf
Test HDF: humidify -t file.hdf
Extract HDF: humidify -x file.hdf
Create HDF: humidify -c file.hdf (run 'humidify -c help' for more)

</pre>

A cross platform version of Humidify can be downloaded from the packages page, [[Customised_Firmware_-_Features_Available#Miscellaneous_Software_Utilities | '''HERE''']]
It contains the following files:-

[[File:Humidify-1.0.2.zip.jpg]]

==Hwctl==

Hardware control utility - Use with caution ! ! !

==Id3v2==

A command line ID3v1.1 tagger for MP3 files. See also See also [[#Popol |'''Popol''']].

Available commands:

<pre>
-h, --help Display this help and exit
-f, --list-frames Display all possible frames for id3v2
-L, --list-genres Lists all id3v1 genres
-v, --version Display version information and exit
-l, --list Lists the tag(s) on the file(s)
-R, --list-rfc822 Lists using an rfc822-style format for output
-d, --delete-v2 Deletes id3v2 tags
-s, --delete-v1 Deletes id3v1 tags
-D, --delete-all Deletes both id3v1 and id3v2 tags
-C, --convert Converts id3v1 tag to id3v2
-1, --id3v1-only Writes only id3v1 tag
-2, --id3v2-only Writes only id3v2 tag
-a, --artist "ARTIST" Set the artist information
-A, --album "ALBUM" Set the album title information
-t, --song "SONG" Set the song title information
-c, --comment "DESCRIPTION":"COMMENT":"LANGUAGE"
Set the comment information (both
description and language optional)
-g, --genre num Set the genre number
-y, --year num Set the year
-T, --track num/num Set the track number/(optional) total tracks

You can set the value for any id3v2 frame by using '--' and then frame id
For example:
id3v2 --TIT3 "Monkey!" file.mp3
would set the "Subtitle/Description" frame to "Monkey!".
</pre>

==Inadyn==
A Dynamic DNS client with web configuration plug-in (see webif settings page). The log file is blanked whenever the box set to standby and a new one created when switched from standby.

For freedns.afraid.org the hostname in settings should be of the form:
xxxx.xxxxxxxx.xxxxx, <user name hash>
Where <user name hash> is obtained from the freedns website, when logged on

==In Use==

Utility for checking whether a recording is in use.

==I-Phone Interface==

An iphone optimised web interface for the Humax.

Screen Shots [[Smartphone_Web_Interface_Screenshots | '''HERE''']].

==Ir (Web-If Remote Controller)==

This package adds a fully functioning Remote Controller to the Web Interface. Full Details [[WebIf_Remote_Controller|'''HERE''']].

==lsof==

This unix command stands for LiSt of Open Files. With no extensions it will default to 'All' open files, but it is probably more useful when used with a filter as shown in the examples :-

 lsof | grep humaxtv HIDE All files opened by the main Humax TV process

 lsof | cut -f 1 -d' ' | sort | uniq HIDE List all processes that have opened files

 lsof | grep epg HIDE All files opened by the EPG process

<pre>humax# lsof | grep epg
epg 596 root cwd 0000 31,0 1307722938 21474853357 /dev
epg 596 root rtd 0000 31,0 1321652395 77309428205 /
epg 596 root txt 0000 8,18 1322689164 4295000557 /mnt/hd2/mod/bin/epg
epg 596 root mem REG 8,18 9226050 /mnt/hd2/mod/bin/epg (path inode=4295000557)
epg 596 root mem REG 31,0 174 /lib/ld-uClibc-0.9.29.so (path inode=4295000557)
epg 596 root mem REG 8,18 9225846 /mnt/hd2/mod/lib/libsqlite3.so.0.8.6 (path inode=4295000557)
epg 596 root mem REG 31,0 169 /lib/libuClibc-0.9.29.so (path inode=4295000448)
epg 596 root mem REG 31,0 216 /lib/libpthread-0.9.29.so (path inode=4295000448)
epg 596 root mem REG 31,0 186 /lib/libdl-0.9.29.so (path inode=4295000448)
epg 596 root 0 0000 31,0 1307722935 4294975926 /dev/null
epg 596 root 1 0000 0,13 1322848876 4295000502 /tmp/epgd.log
epg 596 root 2 0000 0,13 1322848858 4295000502 /tmp/modinit.log
</pre>

==Jim==

Jim is a form of the programming language TCL (Tool Command Language) that runs on the Humax unix platform.

==Jpnevulator==

Serial Port Sniffer.

==Joe==

Text Editor. See [[Custom_Firmware_Package_Notes#Text_Editors | '''Text Editors''']].

==Kernels==

An alternative Kernel for the HDR-Fox T2 is loadable via USB upgrade, the zip files contains copies of the standard kernels and a version with GUID/EFI support

==Lighttpd==

Lighttpd is a replacement for the mongoose Web server used on the Humax to handle it's Web-If pages. [[Web_Interface_Screenshots | '''SEE EXAMPLES''']]

For more information on lighttpd click [http://www.lighttpd.net/ '''HERE''']

==LDD==

ldd prints the shared libraries required by each program or shared library specified on the command line

==Libpcre==

Perl-compatible Regular Expressions Library

==Libunwind==

Utility used with the Crashdiag package

==LibParted==

Library for the [[#Parted|'''Parted''']] package

==Libsndfile==

A C library for reading and writing files containing sampled sound.

==Loaders==

{{Warning|title=WARNING !|Although the installation of a new loader only takes a few seconds (unlike a full firmware change), it is imperative that there is no power interruption during the process as this could cause the Humax to become permanently inoperative (bricked)}}

The Loader - sometimes called the Boot Loader is a small routine that the Humax runs on start-up, the version of your Loader is displayed in the lower left hand corner of the Humax screen immediately after the unit is taken out of standby, there are currently 4 loader versions known to be installed on the HDR-Fox T2, they are :-
a730, a731, a733 and a734.

Different versions of loader may improve 'Green Screen' HDMI handshake problems found on some televisions, a link to the hummy.tv discussion can be found [https://hummy.tv/forum/threads/hdmi-issue-with-bravia.8203/page-2#post-116204 '''HERE''']

==M4==

GNU M4 is an implementation of the traditional Unix macro processor. More notes [http://www.gnu.org/software/m4/ '''HERE''']

==Maintenance Mode==

This is as special mode that the Humax can be placed in, to carry out checks etc. on the system. See Guide [[Maintenance_Mode|'''HERE''']]

==Mediatomb==
A UPnP Media Server, This package allows the HD T2 to stream content to other devices on your network, as the HD T2 does not have this facility built-in. There is a user Guide [http://mediatomb.cc/pages/documentation '''HERE''']

==Mongoose==

Mongoose was the Webserver that the Custom Firmware Package used to present Web pages, it has been replaced by Lighttpd.

==Multienv==

Helper utility for modifying the set top environment, Used by other packages.

==Multi-mode==

[[Multi-mode_Recording | '''See Guide HERE''']]

==Mvdisks==

Mounts external drives (connected via USB) under "My Video" to allow export by the DLNA server (HDR only)
Note:- It is possible to change the name of the moved USB directory from 'usb-disk' to another name by using Web-If >> Diagnostics >> File Editor and replacing 3 of the 4 'usb-disk's with a new name in the file /mod/etc/mdev/rmvdisks.The second occurrence of 'usb-disk' does not need changing

*Allows recording directly to a USB drive on the HDR
*Allows files on a USB drive to be served via DLNA (HDR only)

==Network Shares Automount==

Automatic mounting of remote nfs or smb directories, with configuration on the box, using special "settings" directories to add and configure shares. Remote host(s) are "pinged" regularly, and shares are mounting / unmounting automatically with host availability

Folders on a computer or NAS box can be shared with other devices on the same network. On the Humax box with custom firmware we can add support for two protocols - smb (used by Windows, pre-Lion OsX, linux running Samba), and nfs (Linux, OsX, common with NAS boxes). smb support is provided by the cifs package. We can "mount" the remote shared folder(s) so they appear as if they were part of the local file system on the Humax

This packages uses directory names in the "*Modsettings/smb" and/or "*Modsettings/nfs" folders to configure as many shares as you like. For example to set up a new smb share, use the opt+ button to create a new directory within the smb folder. Name it what you want the mount to be called (eg "MyPc") Wait about 10 seconds, and navigate into the new folder. The script should have created a load of template "configuration directories" for you to rename (host IP address, foldername, user, password etc).

'''Notes'''

#The "_" symbol is used instead of "." in IP names and "/" in folder names as these can't be input (or if they can I think the box changes them to a "_")
#Once configured, the script will regularly ping the host computer to see if it is available. If it is then the shared folder will be mounted and should be browsable. If the host goes offline, the folder will be unmounted, preventing the box from locking up.
#Wake up On LAN (WOL) is available to automatically power up compatible (newer) NAS boxes, The user must supply the MAC address of the NAS box and set wakeNow? to remove the '?' for a single wake or wakeConstantly? to remove the '?' to repeat every few seconds. A script called wakecmd in mod/sbin is now called up that contains both ether-wake and the WOL script
#If option ShareFolder = off, the mount will appear in the USB section and either a real USB device or virtual2 must be installed
#If option ShareFolder = on, the mount will appear under 'My Video'
[[File:warning-anim.gif|100px|left]]
''' DELETING THE MY VIDEO/[SHARES] FOLDER WILL DELETE FILES ON YOUR REMOTE COMPUTER / LAPTOP/ NAS ETC. '''

To safely remove the [Shares] DO NOT DELETE folder :-
#Delete the configuration file created in [ModSettings]/NFS or [Modsettings]/SMB
#reboot the Humax
#Ensure there are no active shares in the [Shares] folder
#Turn off the remote device holding the shared files
#Delete the [Shares] DO NOT DELETE folder

==Nano==

Text Editor, See [[Custom_Firmware_Package_Notes#Text_Editors | '''Text Editors''']]

==New Portal==

This package adds a new front-end to the standard Humax TV Portal, See guide [[Custom_TV_Portal | ''' HERE''']]

==Newk==

This utility will create a folder on the hard disk with a chosen prefix removed, in order to tidy-up the folder title, so for example when recording a new series called "New: The Walking Dead" a folder will be created called "The Walking Dead" and all new recordings will be placed into it, if the prefix "New: " is placed in Webif >> Settings >> Automatic Series Prefix Removal settings.

Note:- Existing series folder will not be renamed by the Newk package

==Nicesplice==

A recorded program editing utility, See [[Edit_On_Box | '''Edit On box Guide''']], Nicesplice also 'Shrinks' the file using [[Custom_Firmware_Package_Notes#Stripts|'''Stripts''']]

==Nsplice==

Nsplice is supplied with the '''[[DetectAds]]''' package, it is a version of the Nicesplice program modified to accept commands from stdin instead of the command line and to make the output recording visible as it is processed to permit chase playing. The .nts for the -dec file input to splice is a hard link to the .nts for the input recording.

==NTFS 3g==

Read/write NTFS disk access. Out of the box the Humax can only read NTFS formatted drives but this package upgrades that support to full read/write access

==NTFS Progs==

This utility contains diagnostic tools and a utililty to format a partition as NTFS

==Ntp Client==

Network Time Protocol sets the Humax clock from an Internet time server on each boot. Useful if you do not have an aerial connection or your Humax doesn't keep good time. Ntpclient runs with the -l option which also adjusts the time in between system boots.

Note :- This utility may also need [[Custom_Firmware_Package_Notes#Forcedate | '''Forcedate''']] to be loaded, In order to get the date near the current as NTP won't change a time / Date that is too far out. More notes [http://doolittle.icarus.com/ntpclient/ '''HERE''']

==Nugget==

Nugget framework, handles a number of utilities sent from the commeand line, current option are :-

<pre>
nugget <command>
ping - Test nugget connectivity.
status - Show nugget status and version.
schedule.load - Load recording schedule from disk.
schedule.save - Save recording schedule to disk.
schedule.slot - Update timers for schedule slot.
schedule.db - sqlite3 database handle info.
schedule.epg - Display EPG information for slot.
schedule.timers - Show internal timers.
cryptokey - Set or display encryption key.
</pre>

==OPKG==

Open PacKaGe Management is the tool used to handle Custom Firmware packages, Here Are some examples :-

opkgHID= list all opkg commands

opkg install http://hummypkg.org.uk/hdrfoxt2/base/auto-unprotect_1.0.6_mipsel.opk HID= Install a remote package

opkg download auto-unprotect HID= download current version of a remote package (Version number not allowed)

opkg listHID= list of available packages

opkg list-installedHID= list of installed packages

opkg remove auto-unprotectHID= uninstall a package Note: No version numbers

 opkg install undelete --force-reinstall HID= Force a package reinstall

 opkg whatdepends anacron HID= Show dependants

==Opkg-beta==

When this package is installed beta versions of installed packages will be made available in 'Package Management >> Upgrades' screen

==Parted==

GNU Partition Editor. On-line User Manual [http://www.gnu.org/software/parted/manual/parted.html#Introduction '''HERE]

==Popol==

A command line ID3v1.1 tagger for MP3 files, If is possible to insert the following fields into an MP3 ID3 header. See also See also [[#Id3v2 |'''Id3v2''']]

<pre>

-s, --songname set songname
-a, --artist set artist
-l, --album set album
-c, --comment set comment
-y, --year set release year
-t, --tracknum set track number

</pre>

==Portal Foscam==

See [[Custom_TV_Portal#Portal_Foscam | '''GUIDE''']]

==Portal Xtra1==

See Guide [[Custom_TV_Portal#Portal_Xtra1 | '''HERE''']]

==Portal Xtra1 (USB)==

This is a version of the Portal Xtra1 that runs in Flash memory, this package was built to run on the Humax HD-Fox T2 without an External Hard Disk Drive and is installed Via USB only. See Guide [[Custom_TV_Portal#Portal_Xtra1 | '''HERE''']]

==Poweron-Channel==

NOTE:- This package was replaced by the Boot-Settings package with the release of Webif 1.4

This Utility forces the Humax to always power up on a selected TV channel regardless of the last channel viewed, After installing the Poweron-Channel package, select options in Web-If >> Settings >> Settings for poc package >> Click here for settings

*Power-On Channel = Selected TV Channel for start-up (See note 1)
*Volume = 0-20 or Last Audio Volume
*Power-On Channel Group = Select Favourites List or None

*Disable Subtitles on every boot (See Note 3)
*Turn the DLNA server on at every boot (See Note 3)

'''NOTES'''
# Ensure that the selected Poweron TV channel is included in the selected Favourite group
#A scheduled wake-up will use the channel set in the on-TV menus at Settings>>Preferences>>Time>>Channel not the Power-On Channel settings
# Only available by editing /mod/boot/pox using Diagnostics >> File Editor (details below)
# The parameters set by Poweron-Channel are contained in the /var/lib/humaxtv/setup.db database, other items may be added to the pox file from this database, but please use extreme caution, their functions are not fully understood
<pre>
humax# cat /mod/boot/pox
# Poweron-channel additional options.

# Example: uncomment the following line to disable subtitles on every boot
#TBL_MENUCONFIG:SUBTITLE_DISPLAY_F:1

# Example: uncomment the following line to turn the DLNA server on at each
# boot in case it has been turned off.
#TBL_MENUCONFIG:DMS_START_ON:1

</pre>

==Procps==

procps is the package that has a bunch of small useful utilities that give information about processes using the /proc file system. The package includes the programs ps, top, vmstat, w, kill, free, slabtop, and skill.Version 3 includes NPTL thread support, a rewritten top, many bug fixes, performance improvements, and new features. Link [http://procps.sourceforge.net/ '''HERE''']

==Prog Backup==

Utility for backing up recordings and side-car files to locally attached drives, A search of attached drives will be made so that the user can choose. Both Hi-Def and Standard definition recordings will be de-crypted so they can be played on a P.C. or copied back to a different Humax. Command line examples Below :-

 progbackup HIDE Backup everything under My Video

 progbackup "/mnt/hd2/My Video/BOB's Films/" HIDE Backup files in a specified folder

'''NOTE:-''' Make sure to use the quotation marks around the directory name.

==Python==

A package that adds the Python programming language

==Python Setuptools==

Setup tools including Easy_Install for the Python programming language, see notes [[http://pypi.python.org/pypi/setuptools#using-setuptools-and-easyinstall|'''HERE''']]

==Qtube==

Simple webif to queue youtube downloads to run in the Auto process queue, see [[Custom_Firmware_Package_Notes#Youtube-dl | '''Youtube-dl''']]

==Recmon==

Utility for executing another process whenever a recording starts or finishes

Recmon runs every script in /mod/etc/recmon.d in response to events. The order that they are run in is not guaranteed (they actually run in parallel).
The commands are run with two arguments, a switch saying which event triggered this and the base name of the recording file (no extension).

e.g.

/mod/etc/recmon.d/test -start "/media/My Video/path/to/recording"

Flags are -start, -stop, -move and -delete. Usually -move is called twice, once for the source location and once for the destination.

Examples
<pre>
/mod/etc/recmon.d/auto-unprotect -start "/media/My Video/The Resident_20150520_0007"
/mod/etc/recmon.d/auto-unprotect -stop "/media/My Video/The Resident_20150520_0007"
</pre>

==Rc app bridge==

Utility that enables the Humax HDR-Fox T2 to be controlled by the TV Remote App. (supplied by Humax) that runs on the I-Phone, the same App. is also available on the Android platform, however version HMARG 1.0.4 does not appear to work with this package

'''Notes'''
* This package requires Content Share to be enabled

==Real Time Scheduling (RTS)==

When the Custom Firmware was developed, Scheduled events created in the Web-If or Via Remote Scheduling were placed into a pending queue and only moved into the main schedule on the next boot or reboot, In Web-If version 1.3.2-1 and later, it is possible to automatically progress from the 'Pending' stage directly to a fully scheduled stage without the Humax having to perform a boot cycle. This option can be enabled / disabled with the :- Settings >> Advanced Settings >> Real Time Scheduling Yes / No option

==Redring ==

Causes the Humax to display a Red LED ring when recording in standby, plus various other front panel options detailed in the table below. The new settings are configurable using the Web-If >> Settings >> Redring Settings

{| border="1"
|+ '''GENERAL SETTINGS'''
! width="250"| Humax Status
! width="100"|Humax Default
! width="150"|With Redring
! width="100"|Redring Setting
|-
! align="left" |Show Purple When dual Recording
! 11% Amber
! bgcolor=#ffbbbb | Purple
! bgcolor=#ffbbbb | On / Off
|-
! align="left" |Enable Debugging Log
! N/A
! bgcolor=#ffbbbb | Debug
! bgcolor=#ffbbbb | On / Off
|}

{| border="1"
|+ '''WHEN FULLY AWAKE i.e. TV Display = On'''
! width="250"|Humax Status
! width="100"|Humax Default
! width="150"|With Redring
! width="100"|Redring Setting
|-
! align="left" |Disable Screen Scrolling
! Scrolling On
! bgcolor=#ffbbbb | Scrolling Off
! bgcolor=#ffbbbb | On / Off
|-
! align="left" |Enable Clock
! Clock Off
! bgcolor=#ffbbbb | Clock On
! bgcolor=#ffbbbb | On / Off
|-
! align="left" |Show Elapsed Time During Playback
! N/A
! bgcolor=#ffbbbb | Elapsed Time
! bgcolor=#ffbbbb | On / Off
|-
! align="left" |Show Play HH:MM Instead of Clock
! N/A
! bgcolor=#ffbbbb | HH:MM
! bgcolor=#ffbbbb | On / Off
|-
! align="left" |Override LED Ring Brightness
Blue Brightness

Red Brightness
! Fixed
100% > 50%

after 3 Mins.
! bgcolor=#ffbbbb | Switchable Override
Variable

Variable
! bgcolor=#ffbbbb | On / Off
0% to 100%

0% to 100%
|-
! align="left" |Override Display Brightness
Brightness
! Fixed
Fixed
! bgcolor=#ffbbbb | Switchable Override
Variable
! bgcolor=#ffbbbb | On / Off
0% to 100%
|-
! align="left" |Override Playback Display Brightness
Brightness
! Fixed
Fixed
! bgcolor=#ffbbbb | Switchable Override
Variable
! bgcolor=#ffbbbb | On / Off
0% to 100%
|}

{| border="1"
|+ '''WHEN HALF AWAKE i.e. Waiting / Recording from standby or OTA Search'''
! width="250"|Humax Status
! width="100"|Humax Default
! width="150"|With Redring
! width="100"|Redring Setting
|-
! align="left" |Show Blue LED Ring
Brightness
! Fixed
11% Amber
! bgcolor=#ffbbbb | Switchable Blue
Variable
! bgcolor=#ffbbbb | On / Off
10% to 100%
|-
! align="left" |Show Red LED Ring (Recording)
Brightness
! Fixed
11% Amber
! bgcolor=#ffbbbb | Switchable Red
Variable
! bgcolor=#ffbbbb | On / Off
10% to 100%
|}

{| border="1"
|+ '''WHEN IN STANDBY i.e. Hard Disk Not Spinning'''
! width="250"|Humax Status
! width="100"|Humax Default
! width="150"|With Redring
! width="100"|Redring Setting
|-
! align="left" |Override LED Ring Brightness
Brightness
! Fixed
11% Amber
! bgcolor=#ffbbbb | Switchable Override
Amber Brightness
! bgcolor=#ffbbbb | On / Off
0% to 100%
|-
! align="left" |Override Display Brightness
Brightness
! Fixed
11%
! bgcolor=#ffbbbb | Switchable Override
Variable
! bgcolor=#ffbbbb | On / Off
0% to 100%
|}

 HIDE ** = Change from Humax default

'''Notes'''

*Redring can cause slight delay of Remote Control key presses, e.g. Pause etc.
*Problems writing to the /mod/tmp/redring.log will be listed in the /var/log/humaxtv.log after diagnostics >> debugtv is run

==Renumber==
[[File:renumber.png|200px|thumb|right]]
Channel re-numbering support, for each channel that you wish to change, enter a new number into the box and save changes. Next time you reboot your Humax, the channel numbers will change around. If you ever rescan the channels on your box then the next time you reboot they will be automatically changed to match your saved preference. Once installed, a new option will be shown in the Web Interface Settings screen, probably near the bottom.

Renumbering channels is useful for people who want to swap the high-definitions services with their standard-definition counterparts, e.g. swap BBC ONE for BBC ONE HD putting BBC ONE HD on channel 1, and can also be used to re-order channels (e.g. move BBC HD to channel 8) to be closer to the start of the EPG. Of course another way to achieve this is to use the standard favourites feature in the Humax software to define your own list of channels and order them to suit.

'''Notes'''

*The renumber settings appears under the "reorder" section of the settings page on the Web-If
*The [[Custom_Firmware_Package_Notes#Tunefix | '''Tune Fix''']] package has replaced the Renumber package

==Reset Webif==

Reset Webif will clear out all of the custom firmware packages and files without affecting your recordings or scheduled recordings. It is designed to be executable by booting from a Flash USB device loaded with the Reset Webif utility and is useful when the 'Web-If >> Diagnostics >> Remove All Custom Firmware packages and settings' is not available, Wait for the light to stop flashing then remove the disk and reboot the Humax (using the remote control). If you point a web browser at the Humax then you'll be back at the initial installation interface.

==Remote Scheduling (RS)==

Remote Scheduling Service. Links your device to the remote scheduling portal so you can manage your scheduled recordings list from anywhere with an Internet connection and web browser

Full Guide[[Remote_Scheduling | '''HERE''']]

==Remote Scheduling Auto==

Full Guide[[Remote_Scheduling_Auto | '''HERE''']]

==Remote Scheduling Muti-Mode==

Full Guide[[Multi-mode_Recording#Multi-Mode_Recording_Via_RS_Portal | '''HERE''']]

==Remote Scheduling Mobile==

Full Guide[[Remote_Scheduling_Mobile_Edition#Multi-Mode_Recording_Via_RS_Portal | '''HERE''']]

==rs==

Command line tool that carries out a number of functions relating to the Remote Scheduling service, e.g. :-

<pre>
humax# rs
Humax Remote Scheduling Tool v1.3.1, by af123, 2011-2015.

Syntax: rs [options] <command>...

Options:
-d[level] Set debug level.
-D<seconds> Sleep for random(seconds).
-h Show help text.
-i Show detected machine info.
-q Be more quiet.

Commands:
register <email> Register this device.
push Push scheduled events.
cmd Retrieve next queued command.
ack <id> Acknowledge command <id>.
status Show device registration status.
log <msg> Send log message to server.
epg Distributed EPG management.

</pre>

==rs time==

Command line utility that returns a number in seconds, that indicates the time offset between your Humax unit and the Remote Servers time

==RMA==

The Return to MAnufacturer Web-If option under [[Diagnostic_Utilities |'''Diagnostics''']] removes Custom Firmware files from the internal hard disk drive of the HDR Fox T2, following an RMA the user should re-install a version of official Humax Software to complete the 'Out of the Box' status of the Humax

'''Notes'''
* After running the procedure, 'RMA' will be displayed in the front panel display, this message should be removed after the official Humax Software is installed, however if the message is still present, it is possible to remove it by running the [[#DeRMA | '''DeRMA''']] USB package
* More options for removing the Custom Firmware are detailed in the [[Remove_Modified_Firmware | '''Remove Modified Firmware''']] page

==Rsvsync==

Boot-time reservation sync service

==Rsync==

A fast, versatile, remote (and local) file-copying tool, example :-

 rsync -avr --progress --delete --exclude 'Tsr/' mnt/hd2/ root@synology ip::NetBackup 

This [[Custom_Firmware_Package_Notes#Cron|'''cronjob''']] example would run at 01:05 each day, keeping the internal and external disks in sync - you just need to ensure the box is on at that time via a reminder or other mechanism.

 5 1 * * * /mod/bin/rsync --archive --delete-after --log-file=/mod/tmp/rsync.log /media/My\ Video/ /media/drive1/Video/ 

The Custom Firmware and Humax setup can be copied from an existing Humax to a new Humax by installing the rsync and dropbear packages on both units and then entering Maintenance Mode on the new Humax and sending the following two command lines :-

 rsync -avr <ip address of old humax>:/var/lib/humaxtv/ /var/lib/humaxtv/ 

 rsync -avr <ip address of old humax>:/mnt/hd2/mod/ /mnt/hd2/mod/ 

[http://ss64.com/bash/rsync.html '''More Info.''']

==rt3070==

This package was a replacement wireless driver which allowed for a wider range of wireless dongle vendor types, it was removed from the packages list because version 1.0 is not compatible with the latest 1.03.XX versions of Custom firmware

==Safe Mode==

Safe Mode is a package loaded onto the Humax via USB in the same way as a software upgrade, it temporarily switches off most Custom Firmware components (apart from a small web server that allows you to get back out of safe more when you want), there is a package called enablesafemode.spk to turn this feature on and another called disablesafemode.spk to turn it back off, they are available frrom the [[Firmware_Downloads | '''Firmware Download page''']]

'''Note''' if you have altered the encryption keys on your humax that any recordings made in safe mode will be made using the standard encryption and won't be, automatically, viewable when you return to normal mode.

==Samba==

Windows compatible file sharing. Allows access to the Humax file system from a computer on the same network. The file system is shared using Windows compatible sharing so can be access from Windows, MacOSX and most other operating systems. Samba operates using 'Server Message Block' (SMB), also known as Common Internet File System (CIFS) protocols

To map a network drive in windows :-

#Click Start, click My Network Places, click Entire Network, and then double-click Microsoft Windows Network.
#Double-click the domain that you want to open.
#Double-click the computer that has the shared resource you want to map. All the shared resources for that computer automatically appear in the window.
#Right-click the shared drive or folder that you want to map, and then click Map Network Drive.
#Click the drive letter that you want to use, and then specify whether you want to reconnect every time that you log on to your computer.
#Note Network drives are mapped by using letters starting from the letter Z. This is the default drive letter for the first mapped drive you create. However, you can select another letter if you want to use a letter other than Z.

Drive sizes can be incorrectly reported, to avoid this set path = /media/My Video in the /mod/etc/smb.conf file

'''Tips'''

#Ensure Samba is enabled in Web-If >> Service Management
#If the Windows 'WORKGROUP' has been changed from default, edit file /mod/etc/smb.conf to match the new name

==Schedchk==

Check scheduled recordings against EPG and reschedule, if possible, entries that don't match the EPG
See the [[Schedchk|user guide]] for further details

==Scons==

SCons is an Open Source software construction tool—that is, a next-generation build tool. Think of SCons as an improved, cross-platform substitute for the classic Make utility with integrated functionality similar to autoconf/automake and compiler caches such as ccache. In short, SCons is an easier, more reliable and faster way to build software

==Screensaver==

If you pause live TV for more than 3 Mins. you will see the current time displayed on the TV screen, This is a screensaver and is designed to prevent ‘burn-in’ on flat panel TVs. The digits are made up of a series of pictures that are stored on the Humax in this read only area :- /opt/share/images/blue/821-4, It is possible to change these pictures to remove the screensaver completely (Black) or use a different font. After a new screensaver package is loaded, it will automatically become the new screensaver, you can select from installed screensaver plug-ins using the Web-If >> Settings screen

When screensaver is first installed only ‘Humax default’ is present, this is the 'flip Clock' default screensaver, If Black is installed then a completely Blank screen will be displayed. All screensaver plug-ins can be installed separately from the Web-If, e.g. the first screensaver Plug-in shown below is called screensaver-3X5, here is a list of plug-ins available :-

{| border="1"
|-
!3X5
>>>
|[[File:3X5.png|200px]]
!Neon
>>>
|[[File:neon.png|200px]]
!Avatar
>>>
|[[File:avatar.png|200px]]
|-
! 7Seg
>>>
| [[File:7Seg.png|200px]]
! Neon-Blue
>>>
| [[File:neon-blue.png|200px]]
!Wedge
>>>
|[[File:Wedge.png|200px]]
|-
! Dot
>>>
| [[File:Dot.png|200px]]
! Agen
>>>
| [[File:Agen.png|200px]]
!Cursor
>>>
|[[File:Cursor.png|200px]]
|-
! VFD
>>>
| [[File:VFD.png|200px]]
! Glass-Blue
>>>
| [[File:glass-b.png|200px]]
!Maze
>>>
|[[File:Maze.png|200px]]
|}

'''screensaver-all''' = Install all current screensavers from the package server

''' screensaver-random''' = Randomly select from the list of installed screensavers

Telnet selection of installed screensaver Plug-ins as follows e.g.:-

<pre>
humax# screensaver
1: 3X5
2: 7Seg
3: Black
4: Cursor
5: Humax Default
6: Neon
7: Neon-Blue
8: VFD
Choose option [1-8]:</pre>
'''NOTES:-'''
*The Humax will need to be placed into stand-by before the new screensaver will be displayed
*If screensaver-all is installed, it must be uninstalled before other screensaver plug-ins are uninstalled
*If any of the screensaver Plug-ins are uninstalled the display will default to Humax Default

==Sed==

GNU Stream Editor, A stream editor is used to perform basic text transformations on an input stream, application notes [http://www.gnu.org/software/sed/manual/sed.html '''HERE'''] or [http://www.grymoire.com/Unix/Sed.html#uh-0 '''HERE''']

==Series Filer==

'''NOTE'''

'''The Series Filer package is no longer supported, the functions it carried out can be replicated by the [[sweeper | '''Sweeper''']] package, the following notes have been retained for reference only.'''

This utility will re-locate series folders created at the top level of My Video to Selected Sub-Directories so that they can be grouped together. After a New series folder has been created by the Humax at the top level, Simply move this series folder to a Sub-directory that you have created e.g. move the Doctor Who series folder to a sub-folder called ‘His Video’. When the next instalment of Doctor Who is transmitted the Humax will create another Doctor Who folder at the top level again, However, If Series Files is running the new instalment will be moved to the ‘His Video / Doctor Who’ automatically. Program names will also be re-named (if possible) to give more detail of each episode

'''NOTE:-'''

The early versions of Series Filer were not compatible with the Undelete package because the [deleted] directory was not handled correctly. Please DO-NOT run Series Filer versions before 0.2.2 with any version of the Undelete package, version 0.2.2 and above are safe to use

==Service Control==

A command line utility allowing easy control of installed services. Run the 'service' command from the command line for help.

From a Telnet command line prompt send the following :-

 service 
<pre>
humax# service

Name Installed Autostart Running
---- --------- --------- -------
mediatomb No No No
dropbear No No No
transmission No No No
samba No No No
cifs No No No
mongoose Yes Yes Yes

Syntax:
service start <service>
service stop <service>
service auto <service> (toggles autostart) </pre>

==Sh (SHell)==

Sh or Shell is a command line / scripting language built into Busybox that is roughly equivalent to the Windows DOS (Disk Operating System) utility. It is however a lot more powerful than DOS and is a true language

==Sidecar==

Web-If MAIN >> Browse Media Files >> (Select Single File) >> OPT+ >> Sidecar Files

Recreates sidecar files .hmt and .nts from a .ts source file.

Command line options :-
<pre>
sidecar v2.5, a utility for the Humax HD/HDR Fox T2, by raydon (c) 2014-2018
Usage: sidecar [-options] <recording name minus .ts extension>

-n : Create new .nts file
-h : Create new or update existing .hmt file
-x : Exclude Prog/PMT ID's from .hmt file
-c : <Channel number for .hmt file>
-t : <Channel name for .hmt file>
-p : Display progress bar
-i : Display infomation

Enclose recording or channel name in quotes if they contain spaces or special characters e.g. &.

humax#
</pre>

'''NOTES'''
# The Sidecar package must be installed using the Web-If >> Main screen >> Package Management >> Available screen
# TS files must be decrypted before running Sidecar, If the TS is encrypted see note 5 below
#Source video not native to the HDR/HD Fox T2, or that has been processed using some third party application may not be compatible
#There are versions of sidecar complied for Linux and Windows platforms [[Customised_Firmware_-_Features_Available#Miscellaneous_Software_Utilities | '''Here''']]
# if the ts file is encrypted, the package will create dummy hmt and nts files to allow the file to be decrypted i.e :-
*Use Sidecar to create the dummy hmt and nts files
*Once indexed by the DLNA server, manually decrypt via 'Opt+' menu in Web-If
*When the TS file is decrypted, simply run Sidecar again to create hmt and nts files providing full transport control.
*There is no need to delete the dummy hmt or nts files since sidecar will detect these, and replace them with valid files
*Sidecar can recreate valid hmt and nts file for both video and radio recordings

==Smartmontools==

This utility will report on the condition of the S.M.A.R.T. hard disk drive, After installing the package enter the following command line using Telnet :-

 mod/bin/smartctl /dev/sdb -A 

or

 mod/bin/smartctl /dev/sdb -a HIDE for more details

Documentation [http://sourceforge.net/apps/trac/smartmontools/wiki/TocDoc'''HERE''']
<pre>

humax# /mod/bin/smartctl /dev/sdb -A
smartctl 5.41 2011-06-09 r3365 [7405b0-smp-linux-2.6.18-7.1] (local build)
Copyright (C) 2002-11 by Bruce Allen, http://smartmontools.sourceforge.net

=== START OF READ SMART DATA SECTION ===
SMART Attributes Data Structure revision number: 10
Vendor Specific SMART Attributes with Thresholds:
ID# ATTRIBUTE_NAME FLAG VALUE WORST THRESH TYPE UPDATED WHEN_FAILED RAW_VALUE
1 Raw_Read_Error_Rate 0x000f 114 099 006 Pre-fail Always - 66811863
3 Spin_Up_Time 0x0003 097 097 000 Pre-fail Always - 0
4 Start_Stop_Count 0x0032 098 098 020 Old_age Always - 2878
5 Reallocated_Sector_Ct 0x0033 100 100 036 Pre-fail Always - 0
7 Seek_Error_Rate 0x000f 078 060 030 Pre-fail Always - 70502101
9 Power_On_Hours 0x0032 097 097 000 Old_age Always - 3294
10 Spin_Retry_Count 0x0013 100 100 097 Pre-fail Always - 0
12 Power_Cycle_Count 0x0032 099 099 020 Old_age Always - 1439
184 End-to-End_Error 0x0032 100 100 099 Old_age Always - 0
187 Reported_Uncorrect 0x0032 097 097 000 Old_age Always - 3
188 Command_Timeout 0x0032 100 100 000 Old_age Always - 0
189 High_Fly_Writes 0x003a 093 093 000 Old_age Always - 7
190 Airflow_Temperature_Cel 0x0022 055 044 045 Old_age Always In_the_past 45 (0 109 45 32)
194 Temperature_Celsius 0x0022 045 056 000 Old_age Always - 45 (0 13 0 0)
195 Hardware_ECC_Recovered 0x001a 048 039 000 Old_age Always - 66811863
197 Current_Pending_Sector 0x0012 100 100 000 Old_age Always - 0
198 Offline_Uncorrectable 0x0010 100 100 000 Old_age Offline - 0
199 UDMA_CRC_Error_Count 0x003e 200 200 000 Old_age Always - 0
</pre>

NOTE:- If an external Hard disk Drive is found on boot up the Internal Hard disk will be /dev/sdb, If no External Hard Disk drive is found at boot up the the internal Hard disk will be /dev/sda

==SQLite3==

SQlite is a database file handler, e.g. files that typically end in *.db can be opened, edited etc. With readline support (arrow key editing and history)

==SRT==

The Humax is able to play subtitles for MP4 and AVI files if the subtitle information is contained in an *.srt file, the following conditions must be met :-

*The srt file must have the same title as the video file e.g. Fawlty-Towers-S1E3.srt for Fawlty-Towers-S1E3.avi
*The .srt file needs to be saved as a text file specifically with ANSI encoding to avoid using fonts that are licensed

'''Notes'''

1) Windows Notepad will produce a ANSI encoded srt file

2) Saving the .srt file with UTF-7 encoding is reported to be more compatible with the Humax

3)A method for extracting SRT files from a Humax *.TS file has been documented on the Hummy.tv forum [http://hummy.tv/forum/threads/quick-guide-to-extract-dvb-subtitles-from-ts-hd-file-and-convert-to-srt-in-minutes.6625/ '''HERE''']

==SSMTP==

SSMTP is a program to deliver an E-mail from your Humax to a mail host or mail hub, It will not handle incoming E-Mail

==Status==

A Command line (Telnet) command that shows what the Humax is (and will be) doing, e.g. :-

<pre>
humax# status
Recording Pretty Woman_20121201_2310
Watching 12: Dave - Would I Lie to You? (23:00 - 23:40) [7%]
Will record 'The Omen' on Film4 at 23:15
</pre>
Note :- The same information is also displayed automatically on several Web-If screens e.g. The Main Screen and the Remote screen

==Strace==

Strace (System Trace) is a diagnostic, debugging and instructional userspace utility for Linux. It is used to monitor interactions between processes and the Linux kernel, which include system calls, signal deliveries, and changes of process state.

==Stripts==
This utility removes portions of a recording (*.TS File) that aren't required and can account for up to 20% of its space, this process will remove freeview EIT packets from the recording, it also updates the associated .nts sidecar file on the fly so that the trick play functions still work on the resulting recording

<pre>
Humax TS Stripper Tool v1.4.2, by af123, 2012-18.

Syntax: stripts [options] <input> [output]
-a Analyse an input file.
-A Quickly analyse an input file.
-c Check if there are any EIT packets.
-C Show address of first EIT packet.
-D Dump NTS file.
-E Check if file is encrypted.
-f Also fix PAT packets.
-F Only fix PAT packets.
-T Dump TS file.
-v Verbose.
-X Add bookmarks at programme start/end.
-Z Extract EPG data from recording (incomplete).
-z Analyse entire TS file.
-@ <key> Decrypt recording with <key>.
-/ <key> Check encryption key against recording.
-d [level] Increase debug level or set debug level.
</pre>

 stripts -F filename HI = Fix file

 stripts -f filename HI = remove redundant EIT packets

 stripts -v filename HI = Verbose

 stripts -S filename HI = demux the raw audio stream into a file-name.audio file

'''NOTE'''
Version 1.4.0 and above of strips also has a file decryption facility, this facility works on both Standard Definition and High Definition recordings and does not require Hi-Def recordings to have the 'ENC' flag removed with the Auto-Unprotect package, it does not require a DLNA URL to be allocated or the DLNA server to be running on the Humax, here is an example of a command line decryption using Stripts :-

<pre>
stripts -@@ <input> <output>

stripts -@ 000378bd11f336333731303434393630 "input file name" "output file name"

stripts -/ 000378bd11f336333731303434393630 "input file name"
Encryption key is correct for this recording.
</pre>

1) In the first example above -@@ automatically inserts the resident Humax encryption key

2) The Second example above is used when the decryption is being carried out on a file recorded on a different Humax unit, this unit's encryption key must be entered, e.g :- for a MAC address of 00-03-78-bd-11-f3 and a serial number of 6371044960-1234, enter 000378bd11f3 followed by the first 10 digits of the serial number in hexidecimal e.g. 36333731303434393630

3) The third example above uses -/ to Check the encryption key against a recording

"input file name" and "output file name" are full *.ts file names, up to, but not including the .ts (Quotes are required for name with spaces)

There are versions of stripts that can perform offline decryption on various computer platforms including :- Linux, MacOSX and Windows etc. [https://wiki.hummy.tv/wiki/Customised_Firmware_-_Features_Available#Miscellaneous_Software_Utilities '''See Link HERE''']

==Swapper==

Swapper is a utility to change the Humax's swap file size to 128

==Sweeper==

Sweeper is a package which re-locates recordings under My Video and files them away automatically for you according to specified criteria, Sweeper can also replicate the Series Filer and flatten packages

There is a comprehensive guide to the Sweeper Graphical User Interface [[sweeper | '''HERE''']]

'''Command Line operation'''

Sweeper rules can also be generated manually by editting the /mod/etc/sweeper.conf file, available from Web-If >> Diagnostics >> File editor

Example 1)

 action {move "archive/miscellaneous"} HI = Move all single files into a folder called archive/miscellaneous (which must exist)

 action {movecreate "archive/miscellaneous"} HI = Move all single files into a folder called archive/miscellaneous (folder will be created)

Example 2)

 lcn {>= 70} lcn {<= 79} action {move Children/Miscellaneous} HI = Move single files from channels 70 - 79 to Children/Miscellaneous folder

 action {move _misc} HI = Move all remaining single files into a folder called _misc

Example 3)

 action {movecreate(Test-%genre-%definition-%title-%channel-%lcn-%duration-%timestamp)} HI = Expanded to Test-Entertainment-SD-Tim Minchin and the Heritage...-Channel 4-4-87-20130824233802]

Example 4)

 folder title {Octonauts} action {move "Children/Octonauts/Series 3"} HI = Move the contents of a series created folder to an existing sub folder e.g. from /Octonauts to /Children/Octonauts/Series 3

Example 5)

 folder action {fileunder ""} HI = emulates the old seriesfiler package

Example 6)

Notes :-
*lines starting with '#' are comments
*A full list of commands are detailed in the Sweeper Guide [[sweeper | '''HERE''']]

<pre>
# Sweep single Big Bang episodes into the series folder
lcn 4 title "Big Bang" action {move "The Big Bang Theory"}
# Move anything recorded from a children's channel to the Miscellaneous folder
lcn {>= 70} lcn {<= 79} duration {>= 90} lock 1 action {move Children/Films}
lcn {>= 70} lcn {<= 79} genre Film lock 1 action {move Children/Films}
lcn {>= 70} lcn {<= 79} action {move Children/Miscellaneous}
folder title {Octonauts} action {move "Children/Octonauts/Series 3"}
folder lcn {>= 70} lcn {<= 79} action {fileundercreate Children}
title {Formula 1} action {move F1}
</pre>

==Subtitles==
[[Custom_Firmware_Package_Notes#SRT | '''See SRT''']]

==Swifi==

A utility that can retrieve and display your current Wi-fi configuration, it's location is :- /sbin/swifi

==Sysmon==
[[File:HDD-Temp.png|right|150px]]
[[File:CPU.png|right|150px]]
[[File:network.png|right|150px]]
A System Monitoring Utility, the Web-If main page has a System Monitoring icon, selecting this icon displays the following options :-

*Hard Disk Temperature

Displays a graph showing the hard disk temperature, This feature uses the [[Custom_Firmware_Package_Notes#Smartmontools | '''Smartmontools''']]
package, options are to display last 2 / 5 hours or 1 / 10 / 30 Days. All graphs have a zoom feature which is implemented with a mouse 'click / drag' or a touchscreen 'pinch / expand'

*CPU Utilisation

Displays a graph showing CPU Utilisation for Idle, Wait, User and System, options are to display last 2 / 5 hours or 1 / 10 / 30 Days

*Network Utilisation

Displays a graph showing Network Utilisation for Inbound, Outbound, In-Errors and Out-Errors, options are to display last 2 / 5 hours or 1 / 10 / 30 Days

The data used to build the graphs is held in file /mod/monitor/monitor.db, currently the tables include :-
#SMART = Hard disk sector relocation information (Not currently displayed as a graph)
#Temp = the Hard Disk Temperature information
#Vmstat = CPU Utilisation data for Idle, Wait, User, System
#Net = Network Utilisation for Inbound, Outbound, In-Errors and Out-Errors
#State = state (Not currently displayed as a graph)

'''Note''' You can reset the database with Web-If >> Diagnostics >> sysmon/purge >> Run Diagnostic

==System Flush==

The System Flush Update File is a package that is installed in the same way as a firmware update to perform a full system flush and reset, it reformats the areas of flash used for persistent data like the schedule, there are two of these flash areas and they use the JFFS2 filesystem.

The package is designed to assist recovery from crash/reboot loops.Your recordings will not be affected.'NB: This will also clear most CFW package settings.

==TCL Check==

Utilities for syntax checking TCL (or Jim) files

==Tcpfix==

This package Modifys the TCP stack to fix download problems that appears to be related to RFC1323 TCP window scaling in the Linux 2.6.18 kernel that the Humax uses

==TCP Ping==

Simple TCP ping utility.

==Telnet==

Telnet is built into the default Custom Firmware package, To communicate Via Telnet from a P.C. you will need a program such as [http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html '''PuTTY'''], Select connection type Telnet and enter the IP address of your Humax into the Host Name box, Then select OPEN, You will be presented with a new Telnet Window and if connection is successful you will see the humax# prompt.

It is also possible to use Telnet supplied in some versions Microsoft Windows e.g. Start >> Run >> CMD >> Telnet

See ''' RED ''' set-up notes below, to prevent errors when entering text

Telnet is available in Windows XP, However Vista and Windows 7 will require Telnet to be enabled with Control Panel >> Programs and Features >> Turn Windows Features On / Off >> 'Tick' Telnet

Follow [[Telnet |'''THIS LINK''']] for more details on the various ways of obtaining a Telnet connection

Here is an example of Windows XP Telnet for ls -al 

<pre>
C:\> telnet

Welcome to Microsoft Telnet Client Escape Character is 'CTRL + ]'

open 10.0.0.200

humax# ls -al
total 17
drwxr-xr-x 18 root root 192 Jan 10 09:10 .
drwxr-xr-x 18 root root 192 Jan 10 09:10 ..
drwxr-xr-x 2 root root 474 Jan 10 09:10 bin
.......
drwxr-xr-x 4 root root 88 Jan 10 09:10 var
humax#

to exit from humax# enter Ctrl + d

Microsoft Telnet >
to exit from Telnet enter q
C:\>
</pre>

NOTES
*Telnet command lines on this WiKi are identified by a Yellow Background 
*''' [Putty] Telnet >> Connection >> Telnet >> return Key sends Telnet New Line instead of ^M should be 'un-Ticked' '''
*''' [Windows] Telnet >> unset crlf '''
*The Humax has a Built-In Telnet Welcome Screen, See [[Custom_Firmware_Package_Notes#Tmenu | '''Tmenu''']] for details

==Telnet Commands==

The majority of Unix / Linux command line keywords can be used on the Humax, if you are not familiar with them, there are a few of the more basic commands and their meanings here :-
* cd = change directory, used to navigate around the file structure
* cd "/media/My Video" = navigate to the top level of My Video
* pwd = print working directory, tells you where you are in the file structure
* ls -al = list contents of the current directory
* touch "/media/My Video/dummy.ts" = create an empty file called dummy.ts in the My Video directory

==Tempmon==

This package checks the HDD temperature every three minutes and will raise a warning if a configurable thresholds is exceeded, the warning is displayed on the HDR-Fox T2's front panel and the centre 'button' flashes. The Setting >> Tempmon page shows the current Hard Disk temperature and has defaults as follows :- Alert If = 50, Attempt to go into standby if = 60 and Immediate power off If = 70 Deg C

'''Note''' If the Fan package is not installed the normal Humax routine will turn the fan on at 56 Deg C, so it is suggested that 'Alert If' should be set to 60 Deg C and the other two parameters are set to 65 and 70 Deg C

==Text Editors==

There is a built-in GUI Text editor in the Web-If (details [[Custom_Firmware_Package_Notes#File Editor |'''HERE''']]). In addition to this editor, There is a basic version of [[Custom_Firmware_Package_Notes#Vi |'''Vi''']] built into the custom [[Custom_Firmware_Package_Notes#BusyBox |'''Busybox''']] package (not in the Busybox version included in the vendor's firmware). There are also several packages that can be installed to suit your editing preferences e.g. [[Custom_Firmware_Package_Notes#Vim_Basic |'''Vim Basic''']], [[Custom_Firmware_Package_Notes#Vim_Standard | '''Vim Standard''']], [[Custom_Firmware_Package_Notes#Joe | '''Joe''']] and [[Custom_Firmware_Package_Notes#Nano | '''Nano''']].

If you've only installed the basic custom firmware (using the upgrade path with USB), then there's
[[Custom_Firmware_Package_Notes#Sed | '''sed''']]

==Tmenu==

This built-in package adds a menu to the Telnet Login screen Menu

Enter 0000 for system PIN. Note:- this is the default
<pre>
Menu Version 1.13
Enter System PIN :

/-------------------------\
| T E L N E T M E N U |
\-------------------------/

[ Humax HDR-Fox T2 (humax) 1.03.12/3.03 ] or [Humax HD-Fox T2 (humaxhd) 1.02.29/2.15]

1 - Restart into maintenance mode.
2 - Remove web interface password.
stat - Show what the box is currently doing.
x - Exit and close connection.
rset - Reset custom firmware environment.
srma - Set return-to-manufacturer (RMA) mode.
diag - Run a diagnostic.
cli - System command line (advanced users).

Please select option:

</pre>

NOTE :- It is possible to skip the above Menu and go directly to the Command Line Interface by selecting Expert mode telnet server = On in the Web-If >> Settings >> Advanced Settings

==Tnftp==

The Humax HDR has a built-in FTP Server for transfer of files from Humax to a remote client and an improved FTP Server called [[Custom_Firmware_Package_Notes#Betaftpd|'''Betaftpd''']] to replace it in the HDR, and to add it to the HD, the Tnftp package provides an FTP Client for file transfer from a remote FTP server to the Humax

tnftp is a port of the NetBSD FTP client.

==Transmission (Bit Torrent)==

The Transmission program will download files from the internet using the a torrent protocol, Downloads using this system are usually fed from multiple sites at the same time in parallel, Because of this many URL’s may be used in the download process, These URLs are packaged together into a single *.torrent file, Transmission re-constructs fragments of the file/s from these various URLs into their original format.

Transmission needs to be supplied with the *.Torrent file, it does not have a Torrent file search facility, one possible torrent source is torrentz.eu, download your selected *.Torrent file to the P.C. you run the Web-iF from

For command line access enter :-

 transmission-remote 

/mod/etc/transmission/settings.json contains settings such as default = speed-limit mode, this can be changed to fast downloading etc. settings info. [https://trac.transmissionbt.com/wiki/EditConfigFiles '''HERE''']

*Go into service control and start Transmission
*Set it to auto start if you want it to come on whenever the box is on
*Go to the Web-If main menu and click the transmission icon at the bottom left
*Select 'Open' (the folder at the top left)
*Select browse in the window and highlight the previously downloaded *.torrent file
*When highlighted select 'Open'
*Select 'Upload'
*If the 'Start when added' box is checked the download will start immediately
* A new directory will be created at /media/ My Video/torrent/ containing successful downloads

===Blocklist===

The torrent system is a 'two-way' process which can allow other users to access your downloaded files, this access can cause a security risk and it is suggested that a block list is set up to prevent this, the Block list contains a set of IP address's not allowed access.

To create or add to a blocklist go to Transmission >> Preferences (Bottom left 'Spanner') >> Peers >> Blocklist and Enable Blocklist, then go to a block list site such as http://www.iblocklist.com/lists.php and copy an Update URL e.g. http://list.iblocklist.com/?list=bt_level1&fileformat=p2p&archiveformat=gz from there to the Block list URL box and click on Update, This process can be repeated to build up bigger lists

It is also possible to place *.txt files containing blocklists into the /mod/etc/transmission/blocklists folder, these files must be smaller than 5Mbs, They will be processed by the Transmission program when first run and *.bin files will be created in the same folder, if the files are successfully processed an indication of the number of ‘Blocked’ URL will be displayed e.g. Block List Has 598940 Rules

'''Notes'''
*When the block lists are initially being converted into *.bin files, transmission uses an excessive amount of CPU time, this could cause errors in recording, so it is suggested that this is done when the Humax is idle.

==Trm==

Trm is a version of the Unix rm command (ReMove), This version removes files in blocks using Truncate (hence Truncate ReMove) rather than all at once, In order to reduce demand on system resources

==TSTools==

A set of tools for manipulating TS files, they include :-
[[File:Tstools.jpg|left|400px]]

==TTYSnoop==

TTYSnoop allows you to snoop on login tty's through another tty-device or pseudo-tty. The snoop-tty becomes a 'clone' of the original tty, redirecting both input and output from/to it.

==Tunefix==
[[File:tunefix.png|right]]
Tunefix restores a user's settings after a retune has been run, the 5 Keywords are :-

*'''REGION''' to be used (channels from other regions will be removed)
*'''LCN''' (s) by number and/or range will be removed
*'''NAME''' services by name will be removed
*'''MUX''' (s) (all channels from these MUXs will be removed)
*'''FORCE''' named services to the correct LCN

'''Note''' Multiple Regions, LCNs, MUXs are separated by commas

==Tunefix Update==

Automatic channel deletion and fixing after a retune.

==TV Diary==

tvdiary is an add-on to the web interface. It tracks the TV programs you record and watch, and presents a diary view through the web interface, See Full Guide[[ TV_Diary | '''HERE''']]

==Uinput==

User-space input kernel module

==Unencrypt==

New Note:- This package is no longer supported, with the addition to the Web-If of [[Custom_Firmware_Package_Notes#Enable_Auto-Dedup|'''auto-decrypt''']] and [[Custom_Firmware_Package_Notes#Enable_Recursive_Auto-Decrypt|'''recursive auto-decrypt''']] these new functions are recommended in place of Unencrypt due to them being more robust and having more sanity checks

The function will unencrypt all files in a designated directory (or all files in My Video) automatically, Files are decrypted at the same location e.g. 'decrypt in place' and are processed at the rate of one file every 30 Mins. max. so don't expect instant results

To setup Unencrypt install the package and then via [[Custom_Firmware_Package_Notes#Telnet|'''Telnet''']] enter one of the lines below :-

 unencryptsetup "Bob's Videos" HIDE process a single directory

 unencryptsetup HIDE process all files in 'My Video'

 unencryptsetup disable HIDE Turn off unencrypt

This will update the cron table and schedule the program to run every 30 minutes (at Mins 01 and 31) indefinitely. Every time it runs, it will check that there isn't already another job running and then decrypt the first encrypted file that it finds in the directory you specified, therefore gradually working its way through your files, If you don't specify a directory, it will default to decrypting all of your recordings.

NOTES:-
* '''Due to CPU overloading this feature only works between 1AM and 6AM the Humax must be out of standby during this time using an Auto On / Auto off timer''' 

*It is possible to change when Unencrypt runs by editing the cron job that controls it, Via the Web-If goto Diagnostics >> File Editor >> Open >> /mod/var/spool/cron/crontabs/ and replace 1-6 with a * to force an Unecrypt start every 30 Mins. that the Humax is out of stand-by
<pre>
1,31 * * * * /mod/sbin/unencrypt "/mnt/hd2/My Video/archive" > /mod/tmp/unencrypt.log 2>&1
</pre>

*Auto-Unprotect must be running
*[[Custom_Firmware_Package_Notes#Content_Sharing |'''Content sharing''']] must = on e.g. Menu >> Settings >> System >> Internet Settings

See Decryption flow chart [[Encryption | '''HERE''']]

==Undelete==

Redirects deleted recordings to a dustbin folder called [Deleted Items] and then automatically removes them from this new folder 7 days later, The Folder Name and delay before deletion is carried out (1 to 30 days) is configurable in the Web-If Setting area. It's a batch process which runs once per day. It runs 6 minutes after the first boot of the day or, if you keep your box on all the time, at 2am.
It scans the bin and removes anything that was put there over x * 24 hours ago, Where x = no. of days (strictly, anything that was last modified over x * 24 hours ago)

Settings can be changed in :- Web-If >> Settings >> Undelete Settings, e.g. :-

*Dustbin Name
*Remove files from dustbin after 1,2,3,4,5,6,7,10,15,20 days
*Reduce retention time to 0 days if disk space < 10GiB (configurable)

A Log records delete activity at /mod/tmp/empty_dustbin.log

Setting are contained in /mod/webif/plugin/undelete/user.conf

==Version==

Command line (Via Telnet) utility to display various Web-If version numbers, e.g. :-
<pre>
humax# version

Humax HDR Fox T2 (humax)
Humax Version: 1.03.12 (kernel HDR_CFW_3.00)
Custom firmware version: 3.00 (build 2137)
Web interface version: 1.2.1
Serial Number: 12 3456789 12345

humax#
</pre>

==Vfdtest==
[[File:front-icons2.png|right|200px]]

This utility turns on all segments of the Humax front display (Vacuum Fluorescent Display)

Web-If >> Diagnostics >> Run Diagnostic >> vfdtest (available in pull down menu). This will force the display to set all segments to 'on' for 30 seconds, followed by all segments off

'''NOTE:- ''' normal display will return after the Humax is placed in standby

Command Line Version :-

 vfdtest on HIDE Set Display to All segments On

 vfdtest off HIDE Set Display to All Segments off

==Vi==

Text Editor, See [[Custom_Firmware_Package_Notes#Text_Editors | '''Text Editors''']]. A basic version of Vi is built into the custom [[Custom_Firmware_Package_Notes#BusyBox |'''Busybox''']] package (it's not included in the version of Busybox in the vendor's firmware).

==Vim Basic==

Text Editor, See [[Custom_Firmware_Package_Notes#Text_Editors | '''Text Editors''']]

==Vim Standard==

Text Editor, See [[Custom_Firmware_Package_Notes#Text_Editors | '''Text Editors''']]

==Virtual-Disk==

One way to decrypt content which has been recorded by the Humax is to copy to an external disk, This is usually a slow process as the
external disk must be connected via one of the USB ports. This package creates a virtual disk on the system to which content can
be copied. It is much faster since it is based on the internal hard disk. The virtual disk is shared by the MediaTomb package by default, giving a
fairly straightforward method of sharing recorded content on the network. In conjunction with the 'auto-unprotect' package, high definition content can also be shared. Any copy to Virtual Disk MUST be by Remote Control OPT+ copy for decryption to take place

'''Note:- For new installations, Virtual-Disk2 is now recommended in place of this package'''

==Virtual-Disk2==

The original Virtual-Disk package (See Above) required a physical USB drive to be in place before the virtual drive could be seen, this new version removes this requirement by creating a drive called 'Virtual-USB', as with a 'real' USB drive, you will get an on-screen display each time the system is started, giving USB options

==Web IF ==

[[Web_Interface_Screenshots |'''Screen Shots''']] HIDE [[Webif_release_notes |'''Release Notes''']]

An evolving web interface for the Humax. This package provides a means of accessing the Humax using a web browser on any device connected to the
network (including mobile 'phones and iPads). The interface allows easy viewing of recorded programme details as well as allowing basic
manipulation to be performed. Additionally the EPG can be viewed and searched from within the web browser

Within the Web-IF are the following Built-In Functions :-

===Backup/Restore Schedule===
[[File:Backup.png|70px|thumb|right]]

Web-If MAIN >> Scheduled Events >> Backup / Restore Scheduled Recordings / Events

This feature provides an automatic daily backup of recording schedule, It is also possible to force an extra manual backup at any time. Any stored backups can then be selected for restoration from the backup folder e.g. /mod/var/backup/auto-2013-Feb-22-18:06.rbk

===Change Channel===

Web-If >> EPG >> Grid Style or Now and Next >> Click on a Channel Logo icon

A Change Channel? question box will pop-up, if you click on 'Yes' the Humax will change the 'Live' tuned channel to the selected channel

Note :- This option requires that the ir Custom Firmware package is installed

===Change Folder===

Web-If MAIN >> Scheduled Events >> (Click on 'More' for a Series Recording) >> Change Folder

Allows the name of a Series Recording folder to be changed, not valid on a single recording

===Cleanup Old Recording (Schedules)===

Web-If MAIN >> Scheduled Events >> Cleanup Old Recordings (at the bottom of the screen)

Allows all entries in the schedule that have no Start Time to be deleted, Humax normally auto-deletes these entries after 12 Weeks.

'''Note:-''' As the EPG is only 7/8 days long caution should be used when deleting scheduled entries that are transmitted less frequently e.g. fortnightly

===Clipboard===

Used in conjunction with Copy, Cut and Paste, The clipboard is an area that files / Folders can be temporarily held in while a new destination is selected. It emulates a Windows Clipboard

===Create Folder===

Web-If MAIN >> Scheduled Events >> More >> Create Folder

Create a new folder destination for future recordings, See also [[Custom_Firmware_Package_Notes#Change_Folder | ''' Change Folder]] where you can change the default folder name

===Copy===

See [[Custom_Firmware_Package_Notes#Clipboard | '''Clipboard''']]

===Crop===
[[File:crop.png|200px|thumb|right]]
Web-If MAIN >> Browse Media Files >> (Select Single File) >> OPT+ >> Crop

See Edit on Box link [[Edit_On_Box#Editing_Via_Web-If |'''HERE''']]

===Cut===

See [[Custom_Firmware_Package_Notes#Clipboard | '''Clipboard''']]

===Delete===

Remove file, folder, item from a recording schedule etc., depending on where the option is encountered

===Decrypt===

Web-If MAIN >> Browse Media Files >> (Select Single File) >> OPT+ >> Decrypt

This Function will move the file to an _original folder and then stream a new copy to the present location, The new copy will be Decrypted and can be played on a P.C.. NOTES:-
* both High Definition AND Standard definition need to be Decrypted
* Decrypt requires [[Custom_Firmware_Package_Notes#Content_Sharing |'''Content sharing''']] to be turned on

===De-duplicate / Tidy this folder===
[[File:Webif-media-ded.png|70px|thumb|right]]
[[File:Webif-media-ded2.png|70px|thumb|right]]

Web-If MAIN >> Browse Media Files >> De-duplicate / Tidy this folder

This Function will search a folder and re-name files with more meaningful titles, It will also separate duplicates into a new folder

See Tidy (Re-name) Example >>

This Function will search a folder and re-name files with more meaningful titles

It will Also separate duplicates into a new folder

See De Duplicate (to new folder) Example >>

===Detect Adverts===

Web-If MAIN >> Browse Media Files >> (Select Single File) >> OPT+ >> Detect Adverts

Add bookmarks to a recording where adverts are detected, so that they can be cropped

===Disable AR===

Web-If MAIN >> Scheduled Events >> (Click on 'More' for a Recording) >> Disable AR

Allows the default [[Padding_versus_Accurate_Recording|'''Accurate Recording''']] feature to be replaced with Padding on a 'per-recording' basis, in a further drop down menu start and stop padding times can be entered

===Download===

Web-If MAIN >> Browse Media Files >> (Select Single File) >> OPT+ >> Download

This function will download with decryption an SD file (or Hi-Def File if the 'ENC' flag is removed) and place it into the default download folder on your P.C., The following items may inhibit it functioning correctly :-

# The File type *.TS must not be associated with a program such as a media player on your P.C., If it is, Remove the association
# Your browser must allow re-direction of addresses

===Enable Auto-Audio===

Web-If MAIN >> Browse Media Files >> Folder >> Enable Auto-Audio

Automatically extract an MP3 audio file from all recordings placed in this folder

===Enable Auto-Dedup===

Web-If MAIN >> Browse Media Files >> Folder >> Enable Auto-Dedup

Set contents of a folder for Auto-De-Duplication of files every 10 Mins. (See also [[#Dedup_.28Command_Line.29 |'''Dedup''']])

===Enable Auto-Decrypt===

Web-If MAIN >> Browse Media Files >> Folder >> Enable Auto-Decrypt

Set contents of a folder for Auto-Decryption of TS files every 10 Mins. (See also [[#Decrypt |'''Decrypt''']])

===Enable Auto Expire===
[[File:autoexp.png|200px|thumb|right]]
Web-If MAIN >> Browse Media Files >> Folder >> Enable Auto-Expire

Automatically delete files in a selected folder a pre-set number of days after recording e.g.1 to 999 days or when above a total number of recordings, Note :- If the Undelete package is installed, the files will be placed in the [Deleted folder] first

===Bookmarks===
[[File:bookmarks.png|right|150px]]
Add, remove and edit bookmarks manually

Web-If MAIN >> Browse Media Files >> (Select Single File) >> OPT+ >> Bookmarks

===Enable Auto-MPG===

Web-If MAIN >> Browse Media Files >> Folder >> Enable Auto-MPG

Automatically extract MPG copys of the *.TS files in the same folder, the MPG versions strips out control frames relating to things which were on the same Mux as the recorded program, resulting in a smaller file. The following conditions must be met :-

*The file must be decrypted (Displays a DEC against it)
*ffmpeg package must be installed
*Extract to MPG is only available from Standard Definition Files
===Enable Auto-Shrink===

Web-If MAIN >> Browse Media Files >> Folder >> Enable Auto-Shrink

Set contents of a folder for Auto-Shrinking of TS files every 10 Mins. (See also [[#Shrink_.28stripts.29 |'''Shrink''']])

===Enable Recursive Auto-Shrink===

As above but it but it also works on all folders below the selected folder

===Enable Recursive Auto-Decrypt===

As above but it but it also works on all folders below the selected folder

===Enable Recursive Auto-Dedup (command line)===

NOTE :- This is not available from the Web-If as it may not be a good idea. Not all series are amenable to auto-dedup and if the broadcaster uses the same programme title for each episode then all but one will be flagged as duplicates.

However, if you wish, you can enable this option from the command line by creating an .autodedupr file, e.g.

touch "/mod/My Video/Kids/.autodedupr" 

===Extract Audio===

Web-If MAIN >> Browse Media Files >> (Select Single File) >> OPT+ >> Extract Audio

This function will produce an MP3 file containing the stereo audio track contained in a standard Def. Video file (or radio recording), The following conditions must be met :-

*The file must be decrypted (Displays a DEC against it)
*ffmpeg package must be installed
*Standard Def. recording only (Hi-Def 2 Ch or 6 Ch sound won't be decoded)
*The extracted MP3 file is in a format sometimes called MPEG-2 Audio, not the more common Layer 3 audio, although some MP3 players will accept this format, a greater number of MP3 players require the layer 3 format, transcoding to layer 3 is not carried out on the Humax due to amount of CPU usage required

===Extract To MPG===

Web-If MAIN >> Browse Media Files >> (Select Single File) >> OPT+ >> Extract To MPG

This function will produce an MPG copy of the *.TS file in the same folder, the MPG version strips out control frames relating to things which were on the same Mux as the recorded program, resulting in a smaller file. The following conditions must be met :-

*The file must be decrypted (Displays a DEC against it)
*ffmpeg package must be installed
*Extract to MPG is only available from Standard Definition Files

===Enable Auto-mpg===

Web-If MAIN >> Browse Media Files >> (Select Folder) >> OPT+ >> Enable Auto-mpg

As above but working on every file in a selected folder

===File Editor===

Web-If MAIN >> Diagnostics >> File Editor >> Open >> [Navigate to desired file]

===Lock===

Mark a file as locked, e.g. protected against deletion

===Mark as Watched===

Tag a file with a 'Watched' symbol

===Manual Event===
[[File:manual-event.png|thumb|right]]
Web-If MAIN >> Scheduled Events >> Manual Event

Allows the set up of a manual recording or reminder, options include:-
*Create : One-off, Daily, weekly,Weekday, Weekend
*Create : Recording or Reminder
*From : Date/Time to: Date/Time
*Channel : Number / Name
*Event Title : Defaults to Channel Name

===Multi Mode Recording===

This option built into the Web-If allows the user to enable a mix of both Accurate Recording and Padding on a per program basis, See [[Multi-mode_Recording|'''Guide Here''']]

===Network Settings===
[[File:network-settings.png|thumb]]
Web-If MAIN >> Settings >> Network Settings

This option provides a Web-If alternative to entering Ethernet Interface and Wireless Interface parameters into the standard Humax Settings screen. The Web-If Wireless Interface screen has several advantages over the standard Humax one e.g :-
*Allows a wider range of ascii characters e.g. "%#<>" to be entered for passwordphrases
*Overcomes time restrictions when entering long passphrases / Keys
'''Notes'''
*Web-If 1.2.0-3 or later must be running
*To enable a wireless network when an Ethernet cable is connected, run /sbin/wifi-up from [[Custom_Firmware_Package_Notes#CLI |'''CLI''']]
*To enable a wireless network when an Ethernet cable is connected and Wireless Helper is installed run /mod/sbin/wifi-up from [[Custom_Firmware_Package_Notes#CLI |'''CLI''']] to shutdown the Ethernet interface when bringing up the wireless interface

===New Folder===

Web-If MAIN >> Browse Media Files >> New Folder

Creates a new empty folder, into which recorded files can be moved

===Paste===

See [[Custom_Firmware_Package_Notes#Clipboard | '''Clipboard''']]

[[File:Webif-media-detail.png|100px|thumb|right]]

===Play===

This function provides an in-browser playback function for the Humax, It requires that you have the VLC plug-in installed for your browser

Web-If MAIN >> Browse Media Files >> (Click on Single File) >> Play

===Rename (File)===

Web-If MAIN >> Browse Media Files >> Click on Single File) >> Rename

Enables the following fields to be changed / added to a single file :-

*New Filename
*New Medialist Title
*New Synopsis
*New Guidance Text
*New Genre

===Rename (Folder)===

Web-If MAIN >> Browse Media Files >> Folder >> Rename

Enables a folder to be re-named

===Reset New Flag===

Web-If MAIN >> Browse Media Files >> Folder >> Reset New Flag

Mark a Folder as containing new material

===Save Last Streamed Content===

Web-If MAIN >> Browse Media Files >> Save Last Streamed Content

This Function will make a permanent MP4 copy of any content that has been viewed using the Humax TV portal e.g. I-Player / You Tube and place it into the 'My Video' folder. The Telnet equivalent Syntax is as follows :-

cp /mnt/hd3/Streamer_down_file "/media/My Video/theclip.mp4" 

NOTE:- The Portal screen must remain open until the entire file has been downloaded (It is not performed in the background), The amount of time the download takes will vary with broadband speed

===Set Thumbnail===

Web-If MAIN >> Browse Media Files >> (Select Single File) >> OPT+ >> Set Thumbnail

Change the current on-screen Thumbnail picture for one of 5 pictures covering a 2.5 Second time frame, the centre frame time can be offset from 0 - 99999 seconds, there is also a -30, -5, +5 and +30 second 'nudge' that can be added to the offset.

'''Notes'''
* The Set Thumbnail option will be greyed out if the file is not decrypted first
* High Definition files have 3 pictures covering a 1.5 Second time frame
* Thumbnails may take some time to generate on Hi-Def Files
* If a bookmark is present the thumbnail selections will centre on it

===Sidecar Files===

see [[Custom_Firmware_Package_Notes#Sidecar | '''Sidecar''']]

===Split===

Web-If MAIN >> Browse Media Files >> (Select Single File) >> OPT+ >> Split (45m parts)

This Function (only available on files over 4GB) will split the file into 45 Minute parts with a 2 Minute overlap, It can be used to stream large files without hitting the 4GB stream bug present on the Humax.

The New files will have segment numbering e.g. 1/3. E.T. The Extra-Terrestrial

===Shrink (stripts)===

Web-If MAIN >> Browse Media Files >> (Select Single File) >> OPT+ >> Shrink

Clicking on Shrink in the OPT+ menu lets you remove portions of a recording that aren't required and can account for up to 20% of its space, this option uses the stripts package to remove freeview EIT packets from the recording, it also updates the associated .nts sidecar file on the fly so that the trick play functions still work on the resulting recording

===Sweeper Rules===

Web-If MAIN >> Browse Media Files >> Folder >> OPT+ >> Sweeper Rules

View / Edit the Sweeper Rules for this folder. Note this option will only be displayed if the sweeper package is installer

===Toggle no-sweep flag===

Web-If MAIN >> Browse Media Files >> Folder >> OPT+ >> Toggle no-sweep flag

Disable / enable the sweeper rule generated for this folder

===View Thumbnail===

Web-If MAIN >> Browse Media Files >> (Select Single File) >> OPT+ >> View Thumbnail

View current on-screen Thumbnail picture

==Web-IF Channel Icons==

A set of PNG picture files used to display the T.V. channel icons in the Web-Interface, they reside in /mod/var/mongoose/html/img/channels

==Webif-Charts==

Chart modules for the web interface

==Webif-iphone==

A cut-down web interface, optimised for display on the iPhone and other mobile devices

See Screenshots [[Smartphone_Web_Interface_Screenshots | '''HERE''']]

==Webif Style Sheet==

The web interface allow you to set your own style overrides in a style sheet file called EXTRA.css, it is located at /mod/webif/html/css/EXTRA.css and is selectable from the Web-If >> Diagnostics >> File Editor drop down menu. Lines added to this file can change some aspects of how the Web Interface is presented to the user e.g. the following lines will prevent genre, guidance (all occurrences) or channel icons being displayed :-
<pre>
img.genre { display: none; }
img[src^="/img/Guidance"] { display: none; }
img.browsechannel { display: none; }
</pre>

Change the size of the pie chart:-

<pre>
#tbdiskpie
{
width: 100px;
height: 100px;
}

.tbdiskpie
{
top: 7px !important;
}
</pre>

Add Borders to Web-If Pages :-
<pre>
table.schedule { border-spacing: 2px; }
table.schedule tr > * { border: 1px solid; }
</pre>

Change font colour or size :-
<pre>
table.schedule td * { color: black; }
table.schedule td { font-size: 1.1em; }
</pre>

Change Icon size
<pre>
img.button { height: 50px; }
</pre>

Remove EPG 'Go to Top' arrow :-

<pre>
#toTop, #toTopHover
{
background: transparent !important;
display: none !important;
opacity: 100 !important;
}
</pre>

Remove EPG ENC icons

<pre>
img.epgenc { display: none; }
</pre>

==Webshell==

After installing this package, an extra icon will be added to the Main Menu >> Diagnostics page at the bottom right, after a re-boot, this will allow access to a Humax Command line similar to using Telnet access

==webm==

This is an audiovisual media file format, if you download files in this format from YouTube (See Youtube-dl), the video and audio may be separated into two files, It is possible to merge these files using ffmpeg, if you download the *.webm video only file and rename it in_vid.webm and download the *.m4a file and rename it in_aud.m4a then the following ffmpeg command line will merge them for you :-
<pre>
ffmpeg -i in_aud.m4a -i in_vid.webm -acodec copy -vcodec copy output.avi
</pre>

==wget==

Retrieve files via HTTP or FTP

'''Notes:-'''
*There is already a version of wget in Busybox which is loaded automatically, However it may be necessary to install the stand alone package as it will be a newer version
*Both the Busybox and the current stand alone versions of wget (1.12) may fail on websites that demand newer versions of TLS/SSL than the ones supported

When attempting to download a Custom Firmware package specifying a version number, an error will be produced unless the -U option is used, eg :-
<pre>
wget -U "" http://hummypkg.org.uk/hdrfoxt2/base/at_3.1.18_mipsel.opk
</pre>

The use of "opkg download" with a specifed version number will also fail

==Wireless Helper==

Wireless network helper - brings wireless up even when just booted to make a recording. Helps with communications to the Remote Scheduling server via USB Wi-Fi dongle

==WOL==

Wakeup On Lan is a feature that can be used to take out of stand-by any item on the LAN that will respond to it. The 'Magic Packet' is broadcast over the LAN e.g. it is sent to every IP address and uses the unique MAC address of the unit to identify which unit is to be woken-up. From Telnet send the following command line where 00:01:02:03:04:05 must be replaced by the MAC address of the item to be woken, e.g.
<pre>
ether-wake 00:01:02:03:04:05
</pre>
To add this feature to the Humax start-up enter the following from Telnet :-
<pre>
echo /mod/bin/busybox/ether-wake 00:01:02:03:04:05 > /mod/etc/init.d/S30wol
chmod 755 /mod/etc/init.d/S30wol
</pre>
NOTES:-
*WOL is also built into [[Custom_Firmware_Package_Notes#Network_Shares_Automount|'''Network_Shares_Automount''']]
*The Humax itself cannot be switched out of Standby using Wake-up On Lan, as the LAN connector is not powered during Stand-by

==Xtra1 Portal==

See Guide [[Custom_TV_Portal| '''HERE''']]

==Youtube-dl==

This pacakage uses a command line to download videos from Youtube, BBC Iplayer, ITV Hub etc., in the following example, a 4K test video is downloaded from YouTube :-

<pre>
Humax2# youtube https://www.youtube.com/watch?v=SlLFOrWvY_M
</pre>

The above downloads a 720 line version of the file which is pretty useless when testing 2176 lines, however it is possible to list all available video formats using the -F option :-

<pre>
Humax2# youtube -F https://www.youtube.com/watch?v=SlLFOrWvY_M

[youtube] SlLFOrWvY_M: Downloading webpage
[youtube] SlLFOrWvY_M: Downloading video info webpage
[info] Available formats for SlLFOrWvY_M:
format code extension resolution note
249 webm audio only DASH audio 3k , opus @ 50k, 26.87KiB
250 webm audio only DASH audio 3k , opus @ 70k, 26.87KiB
251 webm audio only DASH audio 3k , opus @160k, 26.87KiB
171 webm audio only DASH audio 6k , vorbis@128k, 22.21KiB
140 m4a audio only DASH audio 145k , m4a_dash container, mp4a.40.2@128k, 932.03KiB
278 webm 256x144 144p 34k , webm container, vp9, 13fps, video only, 184.31KiB
242 webm 426x240 240p 44k , vp9, 25fps, video only, 248.03KiB
160 mp4 256x144 144p 50k , avc1.42c00c, 13fps, video only, 257.52KiB
134 mp4 640x360 360p 74k , avc1.4d401e, 25fps, video only, 417.64KiB
243 webm 640x360 360p 78k , vp9, 25fps, video only, 433.50KiB
133 mp4 426x240 240p 87k , avc1.4d4015, 25fps, video only, 480.96KiB
244 webm 854x480 480p 116k , vp9, 25fps, video only, 633.67KiB
135 mp4 854x480 480p 117k , avc1.4d401e, 25fps, video only, 656.08KiB
136 mp4 1280x720 720p 191k , avc1.4d401f, 25fps, video only, 1.04MiB
247 webm 1280x720 720p 203k , vp9, 25fps, video only, 1.08MiB
137 mp4 1920x1080 1080p 312k , avc1.640028, 25fps, video only, 1.71MiB
248 webm 1920x1080 1080p 357k , vp9, 25fps, video only, 1.89MiB
271 webm 2560x1440 1440p 609k , vp9, 25fps, video only, 3.20MiB
313 webm 3840x2160 2160p 1122k , vp9, 25fps, video only, 5.88MiB
17 3gp 176x144 small , mp4v.20.3, mp4a.40.2@ 24k, 272.97KiB
36 3gp 320x180 small , mp4v.20.3, mp4a.40.2, 1004.79KiB
43 webm 640x360 medium , vp8.0, vorbis@128k, 589.88KiB
18 mp4 640x360 medium , avc1.42001E, mp4a.40.2@ 96k, 1.61MiB
22 mp4 1280x720 hd720 , avc1.64001F, mp4a.40.2@192k (best)
</pre>

you can then select the required version of the video with the -f option

<pre>
Humax2# youtube -f "313" https://www.youtube.com/watch?v=SlLFOrWvY_M
[youtube] SlLFOrWvY_M: Downloading webpage
[youtube] SlLFOrWvY_M: Downloading video info webpage
[download] Destination: /mnt/hd2/My Video/TobyFree.com - 4K UHD Test Pattern H.264 MP4.webm
[download] 100% of 5.88MiB in 00:12
</pre>

NOTE:- the required download file is named *.webm this file won't be visible from the remote control OPT+ copy/move lisings, but is visible via Telnet / FTP etc., you can rename the file to something like 4K-test.mp4 before viewing directly on your 4K TV (not via the HD only Humax)

To combine video only and audio only files into a single file use the following option (Video MUST be the first item, e.g. 313)

<pre>
Humax2# youtube -f "313+171" https://www.youtube.com/watch?v=SlLFOrWvY_M

[youtube] SlLFOrWvY_M: Downloading webpage
[youtube] SlLFOrWvY_M: Downloading video info webpage
[download] Destination: /mnt/hd2/My Video/TobyFree.com - 4K UHD Test Pattern H.264 MP4.f313.webm
[download] 100% of 5.88MiB in 00:12
[download] Destination: /mnt/hd2/My Video/TobyFree.com - 4K UHD Test Pattern H.264 MP4.f171.webm
[download] 100% of 22.21KiB in 00:00
[ffmpeg] Merging formats into "/mnt/hd2/My Video/TobyFree.com - 4K UHD Test Pattern H.264 MP4.webm"
Deleting original file /mnt/hd2/My Video/TobyFree.com - 4K UHD Test Pattern H.264 MP4.f313.webm (pass -k to keep)
Deleting original file /mnt/hd2/My Video/TobyFree.com - 4K UHD Test Pattern H.264 MP4.f171.webm (pass -k to keep)
</pre>

Youtube-dl has a config file at :- /mod/etc/youtube-dl.conf

Full reference notes are here :-

[https://github.com/rg3/youtube-dl/blob/master/README.md#readme '''Github Notes''']

A list of websites claimed to be working for the Windows version of Youtube-DL is here :-

[https://rg3.github.io/youtube-dl/supportedsites.html '''Available Sites''']

'''Mainsteam sites Working on the Humax Version'''

Youtube, BBC Iplayer, ITV-Hub, dplay

'''Mainstream sites Not Working on the Humax Version'''

Channel4, My5, UKTVPlay

==Zeroconf==

mDNS Responder, Will create a humax.local name which can be seen by anything running mDNS

After installation the zeroconf package will participate in mDNS-like traffic so you can access the box by name from most operating systems. On some, like Apple and Linux, you would access it as humax.local (assuming humax is the hostname) and on others, like Windows, you can just use humax. Windows can also pick up the name to IP address mapping if you have Samba installed and running.

==Zip==

zip utilities for compressing files :-
<pre>
Humax HDR-Fox T2 (humax) 1.03.12/3.03

humax# zip
Copyright (c) 1990-2008 Info-ZIP - Type 'zip "-L"' for software license.
Zip 3.0 (July 5th 2008). Usage:
zip [-options] [-b path] [-t mmddyyyy] [-n suffixes] [zipfile list] [-xi list]
The default action is to add or replace zipfile entries from list, which
can include the special name - to compress standard input.
If zipfile and list are omitted, zip compresses stdin to stdout.
-f freshen: only changed files -u update: only changed or new files
-d delete entries in zipfile -m move into zipfile (delete OS files)
-r recurse into directories -j junk (don't record) directory names
-0 store only -l convert LF to CR LF (-ll CR LF to LF)
-1 compress faster -9 compress better
-q quiet operation -v verbose operation/print version info
-c add one-line comments -z add zipfile comment
-@ read names from stdin -o make zipfile as old as latest entry
-x exclude the following names -i include only the following names
-F fix zipfile (-FF try harder) -D do not add directory entries
-A adjust self-extracting exe -J junk zipfile prefix (unzipsfx)
-T test zipfile integrity -X eXclude eXtra file attributes
-y store symbolic links as the link instead of the referenced file
-e encrypt -n don't compress these suffixes
</pre>

Schedchk

2020-06-04T15:06:06Z

MymsMan: remove 'Draft' designation

= [[File:Schedchk48.png|left]]Schedchk - Check and fix the Humax recording schedule =
== Introduction ==
While it is "only telly" it can be extremely annoying when we find that a programme we had scheduled to record fails to record correctly.
Some failures can be attributed to user errors but a considerable numbers of problems are attributable to the broadcasters and problems in the Humax software not anticipating the ever more creative ways the broadcasters find to make life complicated!

The origins of schedchk go back several years to a [https://hummy.tv/forum/threads/schedchk-auto-fix-schedule-changes-a-proposal.7988 forum post]where I proposed the idea of automatically detecting when programmes were delayed or moved to another channel (e.g. BBC One -> BBC Two) because of overrunning sporting events or breaking news events. Nothing much happened at that time since Wimbledon only last two weeks and other last minute programme changes are by their nature unpredictable making testing difficult.

However now we live in Interesting Times and the unpredictable has become routine, every day the BBC1 showing of Pointless is moved to BBC2 to make way for the Corona Virus Daily Update. One might think that after this long the BBC would take the hint and schedule Pointless on BBC2 but no they persist in scheduling it on BBC1 and only update the schedules 3-72 hours in advance!
Since Pointless is one of our favourite shows I was provoked into resurrecting the Schedchk idea and finally it is now ready for a wider audience though there may still be a few rough edges.

The program relies on the EPG being kept up-to-date to allow it to find alternative showings of programmes and, especially with last minute changes, that can't be relied upon and sometimes there are no alternate showings so it will not be infallible but hopefully it will help you avoid some missed recordings,

I have found several different categories of potential errors in the schedule and these are listed below with examples of how they can occur and action schedchk takes when attempting to fix them.
__TOC__
== Schedule Check Categories ==
=== EPG changes ===
The most basic form of schedule change is when the broadcaster changes the start time, duration or scheduled episode (event-CRID change).
Usually the Humax is quite good at spotting these changes but sometimes it doesn't immediately.

Schedchk will resolve this type of error by updating the schedule entry with the new details.

Checking for this type of problem can be by-passed by specifying the -noEPGchg option in settings or on the command line

=== Missing EPG entry ===
[[File:Schedchk-duplicateepisode.png|600px|frameless|right|Duplicate episode]]
Sometimes the event-id associated with a programme changes and the Humax is not good at resolving these, on occasion it can get very confused resulting in it scheduling two episodes of the same series at the same time!

Changes to the event-id can occur when a programme is moved another channel (e.g. Pointless moving from BBC1_>2), when a programme is added to the schedule (ITV assigned new event-ids to all programmes following the Queen's recent broadcasts), a different episode is scheduled (e.g, the duplicate example above) or if a programme is cancelled and replaced by something else.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead.
If there are no matches by event-CRID it will look for a programme of the same name scheduled for the same time in case the Broadcaster has changed event-id, event-CRID and series-CRID and scheduled an episode from a different series of the programme.
If duplicate episodes occur it will delete the episode that no longer appears in the EPG.

Checking for this type of problem can be by-passed by specifying the -noMissEPG option in settings or on the command line

=== Conflict resolution ===

Conflict arise when three of more programmes are scheduled to be recorded at the same time (Two or more on HD model).
This can arise if a user ignores conflict warnings when scheduling, when a news days EPG data is loaded, or if the EPG changes.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead. When considering alternatives schedchk will attempt to find a match on a channel with the same definition (HD or SD) as the original but if there is no match it will consider matches on channels with a different definition.

Schedchk is quite simple minded in its approach to conflict resolution and will not always choose the best solution for your viewing needs. For complex conflicts or where you want to select which programmes you don't want delayed you should attempt to manually resolve conflicts using the Visual Schedule displays in the webif or RS before schedchk attempts automatic resolution.

At the moment Split recordings are not considered for conflict resolution.

Checking for this type of problem can be by-passed by specifying the -noConflict option in settings or on the command line

=== Unscheduled episodes ===

The Humax normally manges to automatically schedule new episodes of a series but can sometimes miss changes that happen in the middle of the scheduled sequence

Schedchk checks the EPG by series-CRID and adds any missing

Checking for this type of problem can be by-passed by specifying the -noUnsched option in settings or on the command line

=== series-CRID changes ===

Often broadcasters change the series-CRID of a long running programme causing the next episodes of the programme to be not recorded. Sometimes this is because it has switched to another series of the programme (as if we really care whether it is repeats from series 51 or 55) but other times there is no obvious reason for the change.

Schedchk handles this by looking by programme name for a new series with matching name in the same time slot on the same channel and scheduling a new series recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes with variable time slots such as the F1 Grand Prix races
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the series-CRID check is liable to consider the +1 series a new unscheduled series

Checking for this type of problem can be by-passed by specifying the -noSCRID option in settings or on the command line

=== One-off episodes of a series ===

Sometimes broadcasters schedule episodes of a series as 1-off programmes without a series-CRID. Often this is deliberate when filling in a gap in the schedule but other times it is the result of broadcaster incompetence! Recently Pick broadcast several episodes of the Sherlock series as 1-off programmes 😥

Schedchk handles this by looking by programme name for a 1-off programme with matching name on the same channel and scheduling a recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the 1-off check is liable to search the +1 channel

Checking for this type of problem can be by-passed by specifying the -no1off option in settings or on the command line

=== Not Recording ===

Occasionally a programme fails to start recording. This can be due to an unresolved conflict, overrunning programmes, last minute schedule changes etc. but some failures are unexplained.

When a programme is due to be recording schedchk checks whether there is a file for the recording and whether it is growing in size. If the programme is not recording it searches by event-CRID for an alternative showing and, if a suitable alternate is found, schedules it as a 1-off recording.

Since some late starting is normal the checking starts a short while after the scheduled start. By default this is 300 seconds (5 minutes) but this can be modified by specifying the -recWait option in settings or on the command line

Checking for this type of problem can be by-passed by specifying the -noNotRec option in settings or on the command line

Note: Since active recording schedule entries are deleted on Humax start-up schedchk can't schedule alternates for recordings truncated by a power failure or Humax crash 😥.

=== Split Recordings ===

Split recordings are where a long programme such as a film has a shorter programme, often a news bulletin, in the middle of the longer programme. While they may appear to be a 2-epsidode series they are not treated as such by the broadcasters or the Humax and have their own (very badly designed) set of rules which the Humax only partially implements.
Split recordings contain #number at the end of their event-CRID (eg /X4454865#01) and both halves of the split recording are required to have the same number, known as an IMI (Instance Metadata ID). The problem arises when the same film is repeated later in the week with exactly the same event-CRID and IMI, under the rules if there is more than three hours between them they should be treated as different programmes but the Humax treats them all as additional parts of the same programme.

This is a particular problem on channels such as Sony Movies which split most films into 2 parts and regularly repeat films up to three times a week. So you can attempt to schedule just one showing of a film but the Humax will schedule all six parts and some of the unwanted recordings can cause schedule conflicts.

Schedchk handles split recordings by leaving those with one or two parts schedule alone, if there are more than two parts scheduled it checks whether there is more than a 3-hour gap and whether there are any conflicts. The first, non-conflicting, showing is kept with a dummy IMI to prevent the Humax rescheduling and the other showings are removed from the schedule.

Checking for this type of problem can be by-passed by specifying the -noSplit option in settings or on the command line

== Other controls ==

=== Threshold ===

The Threshold setting (-thresh) controls how far into the schedule schedchk should look for problems. The default, unless changed in setting is 36 hours which seems adequate for resolving potential problems.
You may wish to increase it on infrequently used machines.

=== No Auto ===

Normally schedchk runs as part of the regular Auto processing.
If you would prefer to run it on ad-hoc basis from a command line or set up your own [[Schedchk#Running via crontabs|schedule with ctontabs]] you can specify No Auto in the Schedchk section of the settings page.

=== No Alerts ===

Schedchk generates webif warnings when it makes changes to the recording schedule to let you know what has happened.
[[File:Schedchk-alert.png|frame|center|Alert messages]]
If you would prefer not to receive these pop-up messages you can specify the -noAlert option in settings or on the command line.

Note: The example shows that sometimes broadcasters makes changes and then reverse them in short order.

=== Test Mode ===

If you specify the -test option no schedule changes will actually be made

=== In-place updating ===

If you use the visual schedule webif/RS pages to "Record this showing instead" it will generate a skip entry for the current episode and a one-off recording entry for the replacement episode. Schedchk uses a different approach and where possible updates the existing series entry with the new episode details.

The main advantages of this approach is that the recording will automatically go into the series folder and any folder related webif settings (auto-decrypt, shrink, detectads etc) will be applied as usual. You will only have one entry in the recording schedule rather than many and you won't have to move recordings from the My Videos folder.

[[File:Schedchk-inplace.png|800px||right]]
[[File:Schedchk-inplace2.png|800px||right]]
It can look a bit odd to have episodes from different channels in the same series but both webif and RS handle this correctly

Which of the channels will show as the 'main' channel for the series depends on the channel of the next scheduled episode

Minor disadvantages are:
* The Humax won't add new episodes while the 'wrong' channel is main (but Schedchk 'Unscheduled episodes' will add them instead)
* Schedchk 'SCRID change' and '1-off episodes' will check the alternate channel when it is main (more work needs to be done in this area)

If you would prefer more traditional skip and 1-off scheduling you can specify the -noAlert option in settings or on the command line.

=== Progress Messages ===

The -d option controls the level of mesages produced:
* 0 - Schedule changes and errors only (also displayed as webif notifications)
* 1 - Intermediate level
* 2 - Detailed progress messages

== Schedchk settings ==

Initially all schedchk processing options are enabled but the default settings can be overridden on the webif Settings page, any changes made here become the new defaults for schedchk.

More detail on each of the options is given in the sections above.

[[File:Schedchk-settingspage.png|frame|center|SchedChk Settings Page ]]

== Schedchk command line ==

As well as running automatically every few minutes as part of the regular Auto process you can also run schedchk on demand from a command line. Options specified on the command line override values set on the settings page for this invocation of schedchk only, they don't change the default values.

<pre>
schedchk = Check for recording schedule issues and attempt to fix them

schedchk -h = produce this help
schedchk -rsv = scan the recording schedule

Options Default (unless changed in Settings)
-thresh 36 = Don't check for problems more than x hrs away from start
-d 0 = Produce more detailed output
-test n = Don't make updates
-noAuto n = Don't run regularly as part of Auto-Processing
-noAlert n = Don't generate webif alert messages for changes made
-noConflict n = Don't check for conflicts
-noUnsched n = Don't check for episodes missing from schedule
-noSCRID n = Don't check for series CRID changes
-no1off n = Don't check for episodes scheduled as one off programmes
-noNotRec n = Don't check for failures to record
-recWait 300 = Don't assume recording failed until x seconds late starting
-noMissEPG n = Don't resolve missing epg entries
-noEPGchg n = Don't resolve epg time/ duration/ event crid changes
-noSplit n = Don't resolve repeated split recordings
-noInplace n = Update reservation by skipping & 1-off rather than inplace

Note: Options are not case sensitive
</pre>
-noAuto has no effect when specified as a command option, it needs to be set via the settings page.

== Running via crontabs ==

As an alternative to running schedchk as part of the standard customised firmware Auto processing it also possible to schedule schedchk to run at different intervals using the crontabs file.

You might want to do this if:
* You normally disable Auto processing during recordings but would still like to take advantage of Not Recording checks
* You want some checks made at a different frequency from others
* You want process messages written to a dedicated log file

You can edit the crontabs file via webif->Diag->File Editor->Commonly edited files->/mod/var/spool/cron/crontabs/root
[[File:Schedchk-crontabs.png|frame|center|Editing crontabs file]]
In the example above schedchk will run a Not Recording check every 4 minutes and check for SCRID changes and 1-off recordings every 4 hours at 17 minutes past the hour, output will be written to schedchk.log

[https://www.thegeekstuff.com/2009/06/15-practical-crontab-examples/ Guides to crontabs time formats are available online]

== fmtrsv - Format a rsv.db table entry ==
Fmtrsv is a simple command line utility created to help with displaying the contents of the rsv.db where schedule entries are stored. It is included with the schedchk package to help in gathering information for debugging purposes. Entries displayed can be filtered with a number of options
<pre>
# fmtrsv -h
fmtrsv = Formats schedule entries from the rsv.db

fmtrsv options
no options will list all reservations

Options
-h produce this help
-n,-name xxx = select recording name contains
-s,-slot n = select slot
-l,-lcn n = select channel number
-c,-cname xxx = select channel name contains
</pre>
Sample output
<pre>
# fmtrsv -s 16
ulslot = 16
ersvtype = 3 Recording
hsvc = 131097
nsttime = 1590429600 25/05/2020 19:00
szsttime = 00000000000000
nduration = 3600 01:00
erepeat = 0 no repeats
usevtid = 12270
szevtname = i7Code-Breakers: Bletchley Park's... (Code-Breakers: Bletchley Park's...)
ulPreOffset = 0
ulPostOffset = 0
ulProgramId = 0
ulSeriesId = 0
ucVolume = 0
ucInputMode = 0
usChNum = 0
ucRecKind = 4 series
ucCRIDType = 50 series
szCRID = FP.BBC.CO.UK/B-3P5L5
szFPBRecPath = Code-Breakers: Bletchley Park's...
szRecordedProgCrid = 1FP.BBC.CO.UK/B/KZSO7|
szEventToRecord = 1FP.BBC.CO.UK/B/KOEPL|
aulEventToRecordInfo = {131097 1590429600 1590433200 12270}
bRecomRsv = 0
usLastRecordedEvtId = 0
eReady = 30
szSvcName = BBC TWO
usLcn = 2
Svcid Start End Evtid CRID
131097 1590429600 25/05/2020 19:00 1590433200 25/05/2020 20:00 12270 1FP.BBC.CO.UK/B/KOEPL
Skiplist Svcid:Evtid
131097:12390
========================================================

</pre>
== Other Stuff ==
=== Change history ===
{|border=1,
| '''Date'''||'''Version'''||'''Author'''||'''Description'''
|-
|2020-06-05 ||schedchk 0.1.0|| mymsman || Intial Version
* All new!
|}
=== Acknowledgements ===
;af123:For providing the cf framework that underlies everything and who's code I have copied and hacked.
;/df:For investigating the problems with Split recordings and writing the rsv set method
;everybody else:Who has assisted through the forums
=== Future Enhancements ===
* Detect and reschedule recordings active at time of crash
* Improve Series CRID change detection to reduce false positives

Schedchk

2020-05-30T18:24:10Z

MymsMan: /* Missing EPG entry */

= [[File:Schedchk48.png|left]]DRAFT Schedchk - Check and fix the Humax recording schedule DRAFT =
== Introduction ==
While it is "only telly" it can be extremely annoying when we find that a programme we had scheduled to record fails to record correctly.
Some failures can be attributed to user errors but a considerable numbers of problems are attributable to the broadcasters and problems in the Humax software not anticipating the ever more creative ways the broadcasters find to make life complicated!

The origins of schedchk go back several years to a [https://hummy.tv/forum/threads/schedchk-auto-fix-schedule-changes-a-proposal.7988 forum post]where I proposed the idea of automatically detecting when programmes were delayed or moved to another channel (e.g. BBC One -> BBC Two) because of overrunning sporting events or breaking news events. Nothing much happened at that time since Wimbledon only last two weeks and other last minute programme changes are by their nature unpredictable making testing difficult.

However now we live in Interesting Times and the unpredictable has become routine, every day the BBC1 showing of Pointless is moved to BBC2 to make way for the Corona Virus Daily Update. One might think that after this long the BBC would take the hint and schedule Pointless on BBC2 but no they persist in scheduling it on BBC1 and only update the schedules 3-72 hours in advance!
Since Pointless is one of our favourite shows I was provoked into resurrecting the Schedchk idea and finally it is now ready for a wider audience though there may still be a few rough edges.

The program relies on the EPG being kept up-to-date to allow it to find alternative showings of programmes and, especially with last minute changes, that can't be relied upon and sometimes there are no alternate showings so it will not be infallible but hopefully it will help you avoid some missed recordings,

I have found several different categories of potential errors in the schedule and these are listed below with examples of how they can occur and action schedchk takes when attempting to fix them.
__TOC__
== Schedule Check Categories ==
=== EPG changes ===
The most basic form of schedule change is when the broadcaster changes the start time, duration or scheduled episode (event-CRID change).
Usually the Humax is quite good at spotting these changes but sometimes it doesn't immediately.

Schedchk will resolve this type of error by updating the schedule entry with the new details.

Checking for this type of problem can be by-passed by specifying the -noEPGchg option in settings or on the command line

=== Missing EPG entry ===
[[File:Schedchk-duplicateepisode.png|600px|frameless|right|Duplicate episode]]
Sometimes the event-id associated with a programme changes and the Humax is not good at resolving these, on occasion it can get very confused resulting in it scheduling two episodes of the same series at the same time!

Changes to the event-id can occur when a programme is moved another channel (e.g. Pointless moving from BBC1_>2), when a programme is added to the schedule (ITV assigned new event-ids to all programmes following the Queen's recent broadcasts), a different episode is scheduled (e.g, the duplicate example above) or if a programme is cancelled and replaced by something else.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead.
If there are no matches by event-CRID it will look for a programme of the same name scheduled for the same time in case the Broadcaster has changed event-id, event-CRID and series-CRID and scheduled an episode from a different series of the programme.
If duplicate episodes occur it will delete the episode that no longer appears in the EPG.

Checking for this type of problem can be by-passed by specifying the -noMissEPG option in settings or on the command line

=== Conflict resolution ===

Conflict arise when three of more programmes are scheduled to be recorded at the same time (Two or more on HD model).
This can arise if a user ignores conflict warnings when scheduling, when a news days EPG data is loaded, or if the EPG changes.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead. When considering alternatives schedchk will attempt to find a match on a channel with the same definition (HD or SD) as the original but if there is no match it will consider matches on channels with a different definition.

Schedchk is quite simple minded in its approach to conflict resolution and will not always choose the best solution for your viewing needs. For complex conflicts or where you want to select which programmes you don't want delayed you should attempt to manually resolve conflicts using the Visual Schedule displays in the webif or RS before schedchk attempts automatic resolution.

At the moment Split recordings are not considered for conflict resolution.

Checking for this type of problem can be by-passed by specifying the -noConflict option in settings or on the command line

=== Unscheduled episodes ===

The Humax normally manges to automatically schedule new episodes of a series but can sometimes miss changes that happen in the middle of the scheduled sequence

Schedchk checks the EPG by series-CRID and adds any missing

Checking for this type of problem can be by-passed by specifying the -noUnsched option in settings or on the command line

=== series-CRID changes ===

Often broadcasters change the series-CRID of a long running programme causing the next episodes of the programme to be not recorded. Sometimes this is because it has switched to another series of the programme (as if we really care whether it is repeats from series 51 or 55) but other times there is no obvious reason for the change.

Schedchk handles this by looking by programme name for a new series with matching name in the same time slot on the same channel and scheduling a new series recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes with variable time slots such as the F1 Grand Prix races
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the series-CRID check is liable to consider the +1 series a new unscheduled series

Checking for this type of problem can be by-passed by specifying the -noSCRID option in settings or on the command line

=== One-off episodes of a series ===

Sometimes broadcasters schedule episodes of a series as 1-off programmes without a series-CRID. Often this is deliberate when filling in a gap in the schedule but other times it is the result of broadcaster incompetence! Recently Pick broadcast several episodes of the Sherlock series as 1-off programmes 😥

Schedchk handles this by looking by programme name for a 1-off programme with matching name on the same channel and scheduling a recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the 1-off check is liable to search the +1 channel

Checking for this type of problem can be by-passed by specifying the -no1off option in settings or on the command line

=== Not Recording ===

Occasionally a programme fails to start recording. This can be due to an unresolved conflict, overrunning programmes, last minute schedule changes etc. but some failures are unexplained.

When a programme is due to be recording schedchk checks whether there is a file for the recording and whether it is growing in size. If the programme is not recording it searches by event-CRID for an alternative showing and, if a suitable alternate is found, schedules it as a 1-off recording.

Since some late starting is normal the checking starts a short while after the scheduled start. By default this is 300 seconds (5 minutes) but this can be modified by specifying the -recWait option in settings or on the command line

Checking for this type of problem can be by-passed by specifying the -noNotRec option in settings or on the command line

Note: Since active recording schedule entries are deleted on Humax start-up schedchk can't schedule alternates for recordings truncated by a power failure or Humax crash 😥.

=== Split Recordings ===

Split recordings are where a long programme such as a film has a shorter programme, often a news bulletin, in the middle of the longer programme. While they may appear to be a 2-epsidode series they are not treated as such by the broadcasters or the Humax and have their own (very badly designed) set of rules which the Humax only partially implements.
Split recordings contain #number at the end of their event-CRID (eg /X4454865#01) and both halves of the split recording are required to have the same number, known as an IMI (Instance Metadata ID). The problem arises when the same film is repeated later in the week with exactly the same event-CRID and IMI, under the rules if there is more than three hours between them they should be treated as different programmes but the Humax treats them all as additional parts of the same programme.

This is a particular problem on channels such as Sony Movies which split most films into 2 parts and regularly repeat films up to three times a week. So you can attempt to schedule just one showing of a film but the Humax will schedule all six parts and some of the unwanted recordings can cause schedule conflicts.

Schedchk handles split recordings by leaving those with one or two parts schedule alone, if there are more than two parts scheduled it checks whether there is more than a 3-hour gap and whether there are any conflicts. The first, non-conflicting, showing is kept with a dummy IMI to prevent the Humax rescheduling and the other showings are removed from the schedule.

Checking for this type of problem can be by-passed by specifying the -noSplit option in settings or on the command line

== Other controls ==

=== Threshold ===

The Threshold setting (-thresh) controls how far into the schedule schedchk should look for problems. The default, unless changed in setting is 36 hours which seems adequate for resolving potential problems.
You may wish to increase it on infrequently used machines.

=== No Auto ===

Normally schedchk runs as part of the regular Auto processing.
If you would prefer to run it on ad-hoc basis from a command line or set up your own [[Schedchk#Running via crontabs|schedule with ctontabs]] you can specify No Auto in the Schedchk section of the settings page.

=== No Alerts ===

Schedchk generates webif warnings when it makes changes to the recording schedule to let you know what has happened.
[[File:Schedchk-alert.png|frame|center|Alert messages]]
If you would prefer not to receive these pop-up messages you can specify the -noAlert option in settings or on the command line.

Note: The example shows that sometimes broadcasters makes changes and then reverse them in short order.

=== Test Mode ===

If you specify the -test option no schedule changes will actually be made

=== In-place updating ===

If you use the visual schedule webif/RS pages to "Record this showing instead" it will generate a skip entry for the current episode and a one-off recording entry for the replacement episode. Schedchk uses a different approach and where possible updates the existing series entry with the new episode details.

The main advantages of this approach is that the recording will automatically go into the series folder and any folder related webif settings (auto-decrypt, shrink, detectads etc) will be applied as usual. You will only have one entry in the recording schedule rather than many and you won't have to move recordings from the My Videos folder.

[[File:Schedchk-inplace.png|800px||right]]
[[File:Schedchk-inplace2.png|800px||right]]
It can look a bit odd to have episodes from different channels in the same series but both webif and RS handle this correctly

Which of the channels will show as the 'main' channel for the series depends on the channel of the next scheduled episode

Minor disadvantages are:
* The Humax won't add new episodes while the 'wrong' channel is main (but Schedchk 'Unscheduled episodes' will add them instead)
* Schedchk 'SCRID change' and '1-off episodes' will check the alternate channel when it is main (more work needs to be done in this area)

If you would prefer more traditional skip and 1-off scheduling you can specify the -noAlert option in settings or on the command line.

=== Progress Messages ===

The -d option controls the level of mesages produced:
* 0 - Schedule changes and errors only (also displayed as webif notifications)
* 1 - Intermediate level
* 2 - Detailed progress messages

== Schedchk settings ==

Initially all schedchk processing options are enabled but the default settings can be overridden on the webif Settings page, any changes made here become the new defaults for schedchk.

More detail on each of the options is given in the sections above.

[[File:Schedchk-settingspage.png|frame|center|SchedChk Settings Page ]]

== Schedchk command line ==

As well as running automatically every few minutes as part of the regular Auto process you can also run schedchk on demand from a command line. Options specified on the command line override values set on the settings page for this invocation of schedchk only, they don't change the default values.

<pre>
schedchk = Check for recording schedule issues and attempt to fix them

schedchk -h = produce this help
schedchk -rsv = scan the recording schedule

Options Default (unless changed in Settings)
-thresh 36 = Don't check for problems more than x hrs away from start
-d 0 = Produce more detailed output
-test n = Don't make updates
-noAuto n = Don't run regularly as part of Auto-Processing
-noAlert n = Don't generate webif alert messages for changes made
-noConflict n = Don't check for conflicts
-noUnsched n = Don't check for episodes missing from schedule
-noSCRID n = Don't check for series CRID changes
-no1off n = Don't check for episodes scheduled as one off programmes
-noNotRec n = Don't check for failures to record
-recWait 300 = Don't assume recording failed until x seconds late starting
-noMissEPG n = Don't resolve missing epg entries
-noEPGchg n = Don't resolve epg time/ duration/ event crid changes
-noSplit n = Don't resolve repeated split recordings
-noInplace n = Update reservation by skipping & 1-off rather than inplace

Note: Options are not case sensitive
</pre>
-noAuto has no effect when specified as a command option, it needs to be set via the settings page.

== Running via crontabs ==

As an alternative to running schedchk as part of the standard customised firmware Auto processing it also possible to schedule schedchk to run at different intervals using the crontabs file.

You might want to do this if:
* You normally disable Auto processing during recordings but would still like to take advantage of Not Recording checks
* You want some checks made at a different frequency from others
* You want process messages written to a dedicated log file

You can edit the crontabs file via webif->Diag->File Editor->Commonly edited files->/mod/var/spool/cron/crontabs/root
[[File:Schedchk-crontabs.png|frame|center|Editing crontabs file]]
In the example above schedchk will run a Not Recording check every 4 minutes and check for SCRID changes and 1-off recordings every 4 hours at 17 minutes past the hour, output will be written to schedchk.log

[https://www.thegeekstuff.com/2009/06/15-practical-crontab-examples/ Guides to crontabs time formats are available online]

== fmtrsv - Format a rsv.db table entry ==
Fmtrsv is a simple command line utility created to help with displaying the contents of the rsv.db where schedule entries are stored. It is included with the schedchk package to help in gathering information for debugging purposes. Entries displayed can be filtered with a number of options
<pre>
# fmtrsv -h
fmtrsv = Formats schedule entries from the rsv.db

fmtrsv options
no options will list all reservations

Options
-h produce this help
-n,-name xxx = select recording name contains
-s,-slot n = select slot
-l,-lcn n = select channel number
-c,-cname xxx = select channel name contains
</pre>
Sample output
<pre>
# fmtrsv -s 16
ulslot = 16
ersvtype = 3 Recording
hsvc = 131097
nsttime = 1590429600 25/05/2020 19:00
szsttime = 00000000000000
nduration = 3600 01:00
erepeat = 0 no repeats
usevtid = 12270
szevtname = i7Code-Breakers: Bletchley Park's... (Code-Breakers: Bletchley Park's...)
ulPreOffset = 0
ulPostOffset = 0
ulProgramId = 0
ulSeriesId = 0
ucVolume = 0
ucInputMode = 0
usChNum = 0
ucRecKind = 4 series
ucCRIDType = 50 series
szCRID = FP.BBC.CO.UK/B-3P5L5
szFPBRecPath = Code-Breakers: Bletchley Park's...
szRecordedProgCrid = 1FP.BBC.CO.UK/B/KZSO7|
szEventToRecord = 1FP.BBC.CO.UK/B/KOEPL|
aulEventToRecordInfo = {131097 1590429600 1590433200 12270}
bRecomRsv = 0
usLastRecordedEvtId = 0
eReady = 30
szSvcName = BBC TWO
usLcn = 2
Svcid Start End Evtid CRID
131097 1590429600 25/05/2020 19:00 1590433200 25/05/2020 20:00 12270 1FP.BBC.CO.UK/B/KOEPL
Skiplist Svcid:Evtid
131097:12390
========================================================

</pre>
== Other Stuff ==
=== Change history ===
{|border=1,
| '''Date'''||'''Version'''||'''Author'''||'''Description'''
|-
|2020-05-xx ||schedchk 0.1,0-0|| mymsman || Intial Version
* All new!
|}
=== Acknowledgements ===
;af123:For providing the cf framework that underlies everything and who's code I have copied and hacked.
;/df:For investigating the problems with Split recordings and writing the rsv set method
;everybody else:Who has assisted through the forums
=== Future Enhancements ===
* Detect and reschedule recordings active at time of crash
* Improve Series CRID change detection to reduce false positives

Schedchk

2020-05-30T18:16:51Z

MymsMan: /* Missing EPG entry */

= [[File:Schedchk48.png|left]]DRAFT Schedchk - Check and fix the Humax recording schedule DRAFT =
== Introduction ==
While it is "only telly" it can be extremely annoying when we find that a programme we had scheduled to record fails to record correctly.
Some failures can be attributed to user errors but a considerable numbers of problems are attributable to the broadcasters and problems in the Humax software not anticipating the ever more creative ways the broadcasters find to make life complicated!

The origins of schedchk go back several years to a [https://hummy.tv/forum/threads/schedchk-auto-fix-schedule-changes-a-proposal.7988 forum post]where I proposed the idea of automatically detecting when programmes were delayed or moved to another channel (e.g. BBC One -> BBC Two) because of overrunning sporting events or breaking news events. Nothing much happened at that time since Wimbledon only last two weeks and other last minute programme changes are by their nature unpredictable making testing difficult.

However now we live in Interesting Times and the unpredictable has become routine, every day the BBC1 showing of Pointless is moved to BBC2 to make way for the Corona Virus Daily Update. One might think that after this long the BBC would take the hint and schedule Pointless on BBC2 but no they persist in scheduling it on BBC1 and only update the schedules 3-72 hours in advance!
Since Pointless is one of our favourite shows I was provoked into resurrecting the Schedchk idea and finally it is now ready for a wider audience though there may still be a few rough edges.

The program relies on the EPG being kept up-to-date to allow it to find alternative showings of programmes and, especially with last minute changes, that can't be relied upon and sometimes there are no alternate showings so it will not be infallible but hopefully it will help you avoid some missed recordings,

I have found several different categories of potential errors in the schedule and these are listed below with examples of how they can occur and action schedchk takes when attempting to fix them.
__TOC__
== Schedule Check Categories ==
=== EPG changes ===
The most basic form of schedule change is when the broadcaster changes the start time, duration or scheduled episode (event-CRID change).
Usually the Humax is quite good at spotting these changes but sometimes it doesn't immediately.

Schedchk will resolve this type of error by updating the schedule entry with the new details.

Checking for this type of problem can be by-passed by specifying the -noEPGchg option in settings or on the command line

=== Missing EPG entry ===
[[File:Schedchk-duplicateepisode.png|400px|frameless|right|Duplicate episode]]
Sometimes the event-id associated with a programme changes and the Humax is not good at resolving these, on occasion it can get very confused resulting in it scheduling two episodes of the same series at the same time!

Changes to the event-id can occur when a programme is moved another channel (e.g. Pointless moving from BBC1_>2), when a programme is added to the schedule (ITV assigned new event-ids to all programmes following the Queen's recent broadcasts), a different episode is scheduled (e.g, the duplicate example above) or if a programme is cancelled and replaced by something else.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead.
If there are no matches by event-CRID it will look for a programme of the same name scheduled for the same time in case the Broadcaster has changed event-id, event-CRID and series-CRID and scheduled an episode from a different series of the programme.
If duplicate episodes occur it will delete the episode that no longer appears in the EPG.

Checking for this type of problem can be by-passed by specifying the -noMissEPG option in settings or on the command line

=== Conflict resolution ===

Conflict arise when three of more programmes are scheduled to be recorded at the same time (Two or more on HD model).
This can arise if a user ignores conflict warnings when scheduling, when a news days EPG data is loaded, or if the EPG changes.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead. When considering alternatives schedchk will attempt to find a match on a channel with the same definition (HD or SD) as the original but if there is no match it will consider matches on channels with a different definition.

Schedchk is quite simple minded in its approach to conflict resolution and will not always choose the best solution for your viewing needs. For complex conflicts or where you want to select which programmes you don't want delayed you should attempt to manually resolve conflicts using the Visual Schedule displays in the webif or RS before schedchk attempts automatic resolution.

At the moment Split recordings are not considered for conflict resolution.

Checking for this type of problem can be by-passed by specifying the -noConflict option in settings or on the command line

=== Unscheduled episodes ===

The Humax normally manges to automatically schedule new episodes of a series but can sometimes miss changes that happen in the middle of the scheduled sequence

Schedchk checks the EPG by series-CRID and adds any missing

Checking for this type of problem can be by-passed by specifying the -noUnsched option in settings or on the command line

=== series-CRID changes ===

Often broadcasters change the series-CRID of a long running programme causing the next episodes of the programme to be not recorded. Sometimes this is because it has switched to another series of the programme (as if we really care whether it is repeats from series 51 or 55) but other times there is no obvious reason for the change.

Schedchk handles this by looking by programme name for a new series with matching name in the same time slot on the same channel and scheduling a new series recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes with variable time slots such as the F1 Grand Prix races
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the series-CRID check is liable to consider the +1 series a new unscheduled series

Checking for this type of problem can be by-passed by specifying the -noSCRID option in settings or on the command line

=== One-off episodes of a series ===

Sometimes broadcasters schedule episodes of a series as 1-off programmes without a series-CRID. Often this is deliberate when filling in a gap in the schedule but other times it is the result of broadcaster incompetence! Recently Pick broadcast several episodes of the Sherlock series as 1-off programmes 😥

Schedchk handles this by looking by programme name for a 1-off programme with matching name on the same channel and scheduling a recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the 1-off check is liable to search the +1 channel

Checking for this type of problem can be by-passed by specifying the -no1off option in settings or on the command line

=== Not Recording ===

Occasionally a programme fails to start recording. This can be due to an unresolved conflict, overrunning programmes, last minute schedule changes etc. but some failures are unexplained.

When a programme is due to be recording schedchk checks whether there is a file for the recording and whether it is growing in size. If the programme is not recording it searches by event-CRID for an alternative showing and, if a suitable alternate is found, schedules it as a 1-off recording.

Since some late starting is normal the checking starts a short while after the scheduled start. By default this is 300 seconds (5 minutes) but this can be modified by specifying the -recWait option in settings or on the command line

Checking for this type of problem can be by-passed by specifying the -noNotRec option in settings or on the command line

Note: Since active recording schedule entries are deleted on Humax start-up schedchk can't schedule alternates for recordings truncated by a power failure or Humax crash 😥.

=== Split Recordings ===

Split recordings are where a long programme such as a film has a shorter programme, often a news bulletin, in the middle of the longer programme. While they may appear to be a 2-epsidode series they are not treated as such by the broadcasters or the Humax and have their own (very badly designed) set of rules which the Humax only partially implements.
Split recordings contain #number at the end of their event-CRID (eg /X4454865#01) and both halves of the split recording are required to have the same number, known as an IMI (Instance Metadata ID). The problem arises when the same film is repeated later in the week with exactly the same event-CRID and IMI, under the rules if there is more than three hours between them they should be treated as different programmes but the Humax treats them all as additional parts of the same programme.

This is a particular problem on channels such as Sony Movies which split most films into 2 parts and regularly repeat films up to three times a week. So you can attempt to schedule just one showing of a film but the Humax will schedule all six parts and some of the unwanted recordings can cause schedule conflicts.

Schedchk handles split recordings by leaving those with one or two parts schedule alone, if there are more than two parts scheduled it checks whether there is more than a 3-hour gap and whether there are any conflicts. The first, non-conflicting, showing is kept with a dummy IMI to prevent the Humax rescheduling and the other showings are removed from the schedule.

Checking for this type of problem can be by-passed by specifying the -noSplit option in settings or on the command line

== Other controls ==

=== Threshold ===

The Threshold setting (-thresh) controls how far into the schedule schedchk should look for problems. The default, unless changed in setting is 36 hours which seems adequate for resolving potential problems.
You may wish to increase it on infrequently used machines.

=== No Auto ===

Normally schedchk runs as part of the regular Auto processing.
If you would prefer to run it on ad-hoc basis from a command line or set up your own [[Schedchk#Running via crontabs|schedule with ctontabs]] you can specify No Auto in the Schedchk section of the settings page.

=== No Alerts ===

Schedchk generates webif warnings when it makes changes to the recording schedule to let you know what has happened.
[[File:Schedchk-alert.png|frame|center|Alert messages]]
If you would prefer not to receive these pop-up messages you can specify the -noAlert option in settings or on the command line.

Note: The example shows that sometimes broadcasters makes changes and then reverse them in short order.

=== Test Mode ===

If you specify the -test option no schedule changes will actually be made

=== In-place updating ===

If you use the visual schedule webif/RS pages to "Record this showing instead" it will generate a skip entry for the current episode and a one-off recording entry for the replacement episode. Schedchk uses a different approach and where possible updates the existing series entry with the new episode details.

The main advantages of this approach is that the recording will automatically go into the series folder and any folder related webif settings (auto-decrypt, shrink, detectads etc) will be applied as usual. You will only have one entry in the recording schedule rather than many and you won't have to move recordings from the My Videos folder.

[[File:Schedchk-inplace.png|800px||right]]
[[File:Schedchk-inplace2.png|800px||right]]
It can look a bit odd to have episodes from different channels in the same series but both webif and RS handle this correctly

Which of the channels will show as the 'main' channel for the series depends on the channel of the next scheduled episode

Minor disadvantages are:
* The Humax won't add new episodes while the 'wrong' channel is main (but Schedchk 'Unscheduled episodes' will add them instead)
* Schedchk 'SCRID change' and '1-off episodes' will check the alternate channel when it is main (more work needs to be done in this area)

If you would prefer more traditional skip and 1-off scheduling you can specify the -noAlert option in settings or on the command line.

=== Progress Messages ===

The -d option controls the level of mesages produced:
* 0 - Schedule changes and errors only (also displayed as webif notifications)
* 1 - Intermediate level
* 2 - Detailed progress messages

== Schedchk settings ==

Initially all schedchk processing options are enabled but the default settings can be overridden on the webif Settings page, any changes made here become the new defaults for schedchk.

More detail on each of the options is given in the sections above.

[[File:Schedchk-settingspage.png|frame|center|SchedChk Settings Page ]]

== Schedchk command line ==

As well as running automatically every few minutes as part of the regular Auto process you can also run schedchk on demand from a command line. Options specified on the command line override values set on the settings page for this invocation of schedchk only, they don't change the default values.

<pre>
schedchk = Check for recording schedule issues and attempt to fix them

schedchk -h = produce this help
schedchk -rsv = scan the recording schedule

Options Default (unless changed in Settings)
-thresh 36 = Don't check for problems more than x hrs away from start
-d 0 = Produce more detailed output
-test n = Don't make updates
-noAuto n = Don't run regularly as part of Auto-Processing
-noAlert n = Don't generate webif alert messages for changes made
-noConflict n = Don't check for conflicts
-noUnsched n = Don't check for episodes missing from schedule
-noSCRID n = Don't check for series CRID changes
-no1off n = Don't check for episodes scheduled as one off programmes
-noNotRec n = Don't check for failures to record
-recWait 300 = Don't assume recording failed until x seconds late starting
-noMissEPG n = Don't resolve missing epg entries
-noEPGchg n = Don't resolve epg time/ duration/ event crid changes
-noSplit n = Don't resolve repeated split recordings
-noInplace n = Update reservation by skipping & 1-off rather than inplace

Note: Options are not case sensitive
</pre>
-noAuto has no effect when specified as a command option, it needs to be set via the settings page.

== Running via crontabs ==

As an alternative to running schedchk as part of the standard customised firmware Auto processing it also possible to schedule schedchk to run at different intervals using the crontabs file.

You might want to do this if:
* You normally disable Auto processing during recordings but would still like to take advantage of Not Recording checks
* You want some checks made at a different frequency from others
* You want process messages written to a dedicated log file

You can edit the crontabs file via webif->Diag->File Editor->Commonly edited files->/mod/var/spool/cron/crontabs/root
[[File:Schedchk-crontabs.png|frame|center|Editing crontabs file]]
In the example above schedchk will run a Not Recording check every 4 minutes and check for SCRID changes and 1-off recordings every 4 hours at 17 minutes past the hour, output will be written to schedchk.log

[https://www.thegeekstuff.com/2009/06/15-practical-crontab-examples/ Guides to crontabs time formats are available online]

== fmtrsv - Format a rsv.db table entry ==
Fmtrsv is a simple command line utility created to help with displaying the contents of the rsv.db where schedule entries are stored. It is included with the schedchk package to help in gathering information for debugging purposes. Entries displayed can be filtered with a number of options
<pre>
# fmtrsv -h
fmtrsv = Formats schedule entries from the rsv.db

fmtrsv options
no options will list all reservations

Options
-h produce this help
-n,-name xxx = select recording name contains
-s,-slot n = select slot
-l,-lcn n = select channel number
-c,-cname xxx = select channel name contains
</pre>
Sample output
<pre>
# fmtrsv -s 16
ulslot = 16
ersvtype = 3 Recording
hsvc = 131097
nsttime = 1590429600 25/05/2020 19:00
szsttime = 00000000000000
nduration = 3600 01:00
erepeat = 0 no repeats
usevtid = 12270
szevtname = i7Code-Breakers: Bletchley Park's... (Code-Breakers: Bletchley Park's...)
ulPreOffset = 0
ulPostOffset = 0
ulProgramId = 0
ulSeriesId = 0
ucVolume = 0
ucInputMode = 0
usChNum = 0
ucRecKind = 4 series
ucCRIDType = 50 series
szCRID = FP.BBC.CO.UK/B-3P5L5
szFPBRecPath = Code-Breakers: Bletchley Park's...
szRecordedProgCrid = 1FP.BBC.CO.UK/B/KZSO7|
szEventToRecord = 1FP.BBC.CO.UK/B/KOEPL|
aulEventToRecordInfo = {131097 1590429600 1590433200 12270}
bRecomRsv = 0
usLastRecordedEvtId = 0
eReady = 30
szSvcName = BBC TWO
usLcn = 2
Svcid Start End Evtid CRID
131097 1590429600 25/05/2020 19:00 1590433200 25/05/2020 20:00 12270 1FP.BBC.CO.UK/B/KOEPL
Skiplist Svcid:Evtid
131097:12390
========================================================

</pre>
== Other Stuff ==
=== Change history ===
{|border=1,
| '''Date'''||'''Version'''||'''Author'''||'''Description'''
|-
|2020-05-xx ||schedchk 0.1,0-0|| mymsman || Intial Version
* All new!
|}
=== Acknowledgements ===
;af123:For providing the cf framework that underlies everything and who's code I have copied and hacked.
;/df:For investigating the problems with Split recordings and writing the rsv set method
;everybody else:Who has assisted through the forums
=== Future Enhancements ===
* Detect and reschedule recordings active at time of crash
* Improve Series CRID change detection to reduce false positives

Schedchk

2020-05-30T18:14:59Z

MymsMan: /* Failure Categories */

= [[File:Schedchk48.png|left]]DRAFT Schedchk - Check and fix the Humax recording schedule DRAFT =
== Introduction ==
While it is "only telly" it can be extremely annoying when we find that a programme we had scheduled to record fails to record correctly.
Some failures can be attributed to user errors but a considerable numbers of problems are attributable to the broadcasters and problems in the Humax software not anticipating the ever more creative ways the broadcasters find to make life complicated!

The origins of schedchk go back several years to a [https://hummy.tv/forum/threads/schedchk-auto-fix-schedule-changes-a-proposal.7988 forum post]where I proposed the idea of automatically detecting when programmes were delayed or moved to another channel (e.g. BBC One -> BBC Two) because of overrunning sporting events or breaking news events. Nothing much happened at that time since Wimbledon only last two weeks and other last minute programme changes are by their nature unpredictable making testing difficult.

However now we live in Interesting Times and the unpredictable has become routine, every day the BBC1 showing of Pointless is moved to BBC2 to make way for the Corona Virus Daily Update. One might think that after this long the BBC would take the hint and schedule Pointless on BBC2 but no they persist in scheduling it on BBC1 and only update the schedules 3-72 hours in advance!
Since Pointless is one of our favourite shows I was provoked into resurrecting the Schedchk idea and finally it is now ready for a wider audience though there may still be a few rough edges.

The program relies on the EPG being kept up-to-date to allow it to find alternative showings of programmes and, especially with last minute changes, that can't be relied upon and sometimes there are no alternate showings so it will not be infallible but hopefully it will help you avoid some missed recordings,

I have found several different categories of potential errors in the schedule and these are listed below with examples of how they can occur and action schedchk takes when attempting to fix them.
__TOC__
== Schedule Check Categories ==
=== EPG changes ===
The most basic form of schedule change is when the broadcaster changes the start time, duration or scheduled episode (event-CRID change).
Usually the Humax is quite good at spotting these changes but sometimes it doesn't immediately.

Schedchk will resolve this type of error by updating the schedule entry with the new details.

Checking for this type of problem can be by-passed by specifying the -noEPGchg option in settings or on the command line

=== Missing EPG entry ===
[[File:Schedchk-duplicateepisode.png|frameless|right|Duplicate episode]]
Sometimes the event-id associated with a programme changes and the Humax is not good at resolving these, on occasion it can get very confused resulting in it scheduling two episodes of the same series at the same time!

Changes to the event-id can occur when a programme is moved another channel (e.g. Pointless moving from BBC1_>2), when a programme is added to the schedule (ITV assigned new event-ids to all programmes following the Queen's recent broadcasts), a different episode is scheduled (e.g, the duplicate example above) or if a programme is cancelled and replaced by something else.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead.
If there are no matches by event-CRID it will look for a programme of the same name scheduled for the same time in case the Broadcaster has changed event-id, event-CRID and series-CRID and scheduled an episode from a different series of the programme.
If duplicate episodes occur it will delete the episode that no longer appears in the EPG.

Checking for this type of problem can be by-passed by specifying the -noMissEPG option in settings or on the command line

=== Conflict resolution ===

Conflict arise when three of more programmes are scheduled to be recorded at the same time (Two or more on HD model).
This can arise if a user ignores conflict warnings when scheduling, when a news days EPG data is loaded, or if the EPG changes.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead. When considering alternatives schedchk will attempt to find a match on a channel with the same definition (HD or SD) as the original but if there is no match it will consider matches on channels with a different definition.

Schedchk is quite simple minded in its approach to conflict resolution and will not always choose the best solution for your viewing needs. For complex conflicts or where you want to select which programmes you don't want delayed you should attempt to manually resolve conflicts using the Visual Schedule displays in the webif or RS before schedchk attempts automatic resolution.

At the moment Split recordings are not considered for conflict resolution.

Checking for this type of problem can be by-passed by specifying the -noConflict option in settings or on the command line

=== Unscheduled episodes ===

The Humax normally manges to automatically schedule new episodes of a series but can sometimes miss changes that happen in the middle of the scheduled sequence

Schedchk checks the EPG by series-CRID and adds any missing

Checking for this type of problem can be by-passed by specifying the -noUnsched option in settings or on the command line

=== series-CRID changes ===

Often broadcasters change the series-CRID of a long running programme causing the next episodes of the programme to be not recorded. Sometimes this is because it has switched to another series of the programme (as if we really care whether it is repeats from series 51 or 55) but other times there is no obvious reason for the change.

Schedchk handles this by looking by programme name for a new series with matching name in the same time slot on the same channel and scheduling a new series recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes with variable time slots such as the F1 Grand Prix races
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the series-CRID check is liable to consider the +1 series a new unscheduled series

Checking for this type of problem can be by-passed by specifying the -noSCRID option in settings or on the command line

=== One-off episodes of a series ===

Sometimes broadcasters schedule episodes of a series as 1-off programmes without a series-CRID. Often this is deliberate when filling in a gap in the schedule but other times it is the result of broadcaster incompetence! Recently Pick broadcast several episodes of the Sherlock series as 1-off programmes 😥

Schedchk handles this by looking by programme name for a 1-off programme with matching name on the same channel and scheduling a recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the 1-off check is liable to search the +1 channel

Checking for this type of problem can be by-passed by specifying the -no1off option in settings or on the command line

=== Not Recording ===

Occasionally a programme fails to start recording. This can be due to an unresolved conflict, overrunning programmes, last minute schedule changes etc. but some failures are unexplained.

When a programme is due to be recording schedchk checks whether there is a file for the recording and whether it is growing in size. If the programme is not recording it searches by event-CRID for an alternative showing and, if a suitable alternate is found, schedules it as a 1-off recording.

Since some late starting is normal the checking starts a short while after the scheduled start. By default this is 300 seconds (5 minutes) but this can be modified by specifying the -recWait option in settings or on the command line

Checking for this type of problem can be by-passed by specifying the -noNotRec option in settings or on the command line

Note: Since active recording schedule entries are deleted on Humax start-up schedchk can't schedule alternates for recordings truncated by a power failure or Humax crash 😥.

=== Split Recordings ===

Split recordings are where a long programme such as a film has a shorter programme, often a news bulletin, in the middle of the longer programme. While they may appear to be a 2-epsidode series they are not treated as such by the broadcasters or the Humax and have their own (very badly designed) set of rules which the Humax only partially implements.
Split recordings contain #number at the end of their event-CRID (eg /X4454865#01) and both halves of the split recording are required to have the same number, known as an IMI (Instance Metadata ID). The problem arises when the same film is repeated later in the week with exactly the same event-CRID and IMI, under the rules if there is more than three hours between them they should be treated as different programmes but the Humax treats them all as additional parts of the same programme.

This is a particular problem on channels such as Sony Movies which split most films into 2 parts and regularly repeat films up to three times a week. So you can attempt to schedule just one showing of a film but the Humax will schedule all six parts and some of the unwanted recordings can cause schedule conflicts.

Schedchk handles split recordings by leaving those with one or two parts schedule alone, if there are more than two parts scheduled it checks whether there is more than a 3-hour gap and whether there are any conflicts. The first, non-conflicting, showing is kept with a dummy IMI to prevent the Humax rescheduling and the other showings are removed from the schedule.

Checking for this type of problem can be by-passed by specifying the -noSplit option in settings or on the command line

== Other controls ==

=== Threshold ===

The Threshold setting (-thresh) controls how far into the schedule schedchk should look for problems. The default, unless changed in setting is 36 hours which seems adequate for resolving potential problems.
You may wish to increase it on infrequently used machines.

=== No Auto ===

Normally schedchk runs as part of the regular Auto processing.
If you would prefer to run it on ad-hoc basis from a command line or set up your own [[Schedchk#Running via crontabs|schedule with ctontabs]] you can specify No Auto in the Schedchk section of the settings page.

=== No Alerts ===

Schedchk generates webif warnings when it makes changes to the recording schedule to let you know what has happened.
[[File:Schedchk-alert.png|frame|center|Alert messages]]
If you would prefer not to receive these pop-up messages you can specify the -noAlert option in settings or on the command line.

Note: The example shows that sometimes broadcasters makes changes and then reverse them in short order.

=== Test Mode ===

If you specify the -test option no schedule changes will actually be made

=== In-place updating ===

If you use the visual schedule webif/RS pages to "Record this showing instead" it will generate a skip entry for the current episode and a one-off recording entry for the replacement episode. Schedchk uses a different approach and where possible updates the existing series entry with the new episode details.

The main advantages of this approach is that the recording will automatically go into the series folder and any folder related webif settings (auto-decrypt, shrink, detectads etc) will be applied as usual. You will only have one entry in the recording schedule rather than many and you won't have to move recordings from the My Videos folder.

[[File:Schedchk-inplace.png|800px||right]]
[[File:Schedchk-inplace2.png|800px||right]]
It can look a bit odd to have episodes from different channels in the same series but both webif and RS handle this correctly

Which of the channels will show as the 'main' channel for the series depends on the channel of the next scheduled episode

Minor disadvantages are:
* The Humax won't add new episodes while the 'wrong' channel is main (but Schedchk 'Unscheduled episodes' will add them instead)
* Schedchk 'SCRID change' and '1-off episodes' will check the alternate channel when it is main (more work needs to be done in this area)

If you would prefer more traditional skip and 1-off scheduling you can specify the -noAlert option in settings or on the command line.

=== Progress Messages ===

The -d option controls the level of mesages produced:
* 0 - Schedule changes and errors only (also displayed as webif notifications)
* 1 - Intermediate level
* 2 - Detailed progress messages

== Schedchk settings ==

Initially all schedchk processing options are enabled but the default settings can be overridden on the webif Settings page, any changes made here become the new defaults for schedchk.

More detail on each of the options is given in the sections above.

[[File:Schedchk-settingspage.png|frame|center|SchedChk Settings Page ]]

== Schedchk command line ==

As well as running automatically every few minutes as part of the regular Auto process you can also run schedchk on demand from a command line. Options specified on the command line override values set on the settings page for this invocation of schedchk only, they don't change the default values.

<pre>
schedchk = Check for recording schedule issues and attempt to fix them

schedchk -h = produce this help
schedchk -rsv = scan the recording schedule

Options Default (unless changed in Settings)
-thresh 36 = Don't check for problems more than x hrs away from start
-d 0 = Produce more detailed output
-test n = Don't make updates
-noAuto n = Don't run regularly as part of Auto-Processing
-noAlert n = Don't generate webif alert messages for changes made
-noConflict n = Don't check for conflicts
-noUnsched n = Don't check for episodes missing from schedule
-noSCRID n = Don't check for series CRID changes
-no1off n = Don't check for episodes scheduled as one off programmes
-noNotRec n = Don't check for failures to record
-recWait 300 = Don't assume recording failed until x seconds late starting
-noMissEPG n = Don't resolve missing epg entries
-noEPGchg n = Don't resolve epg time/ duration/ event crid changes
-noSplit n = Don't resolve repeated split recordings
-noInplace n = Update reservation by skipping & 1-off rather than inplace

Note: Options are not case sensitive
</pre>
-noAuto has no effect when specified as a command option, it needs to be set via the settings page.

== Running via crontabs ==

As an alternative to running schedchk as part of the standard customised firmware Auto processing it also possible to schedule schedchk to run at different intervals using the crontabs file.

You might want to do this if:
* You normally disable Auto processing during recordings but would still like to take advantage of Not Recording checks
* You want some checks made at a different frequency from others
* You want process messages written to a dedicated log file

You can edit the crontabs file via webif->Diag->File Editor->Commonly edited files->/mod/var/spool/cron/crontabs/root
[[File:Schedchk-crontabs.png|frame|center|Editing crontabs file]]
In the example above schedchk will run a Not Recording check every 4 minutes and check for SCRID changes and 1-off recordings every 4 hours at 17 minutes past the hour, output will be written to schedchk.log

[https://www.thegeekstuff.com/2009/06/15-practical-crontab-examples/ Guides to crontabs time formats are available online]

== fmtrsv - Format a rsv.db table entry ==
Fmtrsv is a simple command line utility created to help with displaying the contents of the rsv.db where schedule entries are stored. It is included with the schedchk package to help in gathering information for debugging purposes. Entries displayed can be filtered with a number of options
<pre>
# fmtrsv -h
fmtrsv = Formats schedule entries from the rsv.db

fmtrsv options
no options will list all reservations

Options
-h produce this help
-n,-name xxx = select recording name contains
-s,-slot n = select slot
-l,-lcn n = select channel number
-c,-cname xxx = select channel name contains
</pre>
Sample output
<pre>
# fmtrsv -s 16
ulslot = 16
ersvtype = 3 Recording
hsvc = 131097
nsttime = 1590429600 25/05/2020 19:00
szsttime = 00000000000000
nduration = 3600 01:00
erepeat = 0 no repeats
usevtid = 12270
szevtname = i7Code-Breakers: Bletchley Park's... (Code-Breakers: Bletchley Park's...)
ulPreOffset = 0
ulPostOffset = 0
ulProgramId = 0
ulSeriesId = 0
ucVolume = 0
ucInputMode = 0
usChNum = 0
ucRecKind = 4 series
ucCRIDType = 50 series
szCRID = FP.BBC.CO.UK/B-3P5L5
szFPBRecPath = Code-Breakers: Bletchley Park's...
szRecordedProgCrid = 1FP.BBC.CO.UK/B/KZSO7|
szEventToRecord = 1FP.BBC.CO.UK/B/KOEPL|
aulEventToRecordInfo = {131097 1590429600 1590433200 12270}
bRecomRsv = 0
usLastRecordedEvtId = 0
eReady = 30
szSvcName = BBC TWO
usLcn = 2
Svcid Start End Evtid CRID
131097 1590429600 25/05/2020 19:00 1590433200 25/05/2020 20:00 12270 1FP.BBC.CO.UK/B/KOEPL
Skiplist Svcid:Evtid
131097:12390
========================================================

</pre>
== Other Stuff ==
=== Change history ===
{|border=1,
| '''Date'''||'''Version'''||'''Author'''||'''Description'''
|-
|2020-05-xx ||schedchk 0.1,0-0|| mymsman || Intial Version
* All new!
|}
=== Acknowledgements ===
;af123:For providing the cf framework that underlies everything and who's code I have copied and hacked.
;/df:For investigating the problems with Split recordings and writing the rsv set method
;everybody else:Who has assisted through the forums
=== Future Enhancements ===
* Detect and reschedule recordings active at time of crash
* Improve Series CRID change detection to reduce false positives

Schedchk

2020-05-30T18:09:30Z

MymsMan: /* In-place updating */

= [[File:Schedchk48.png|left]]DRAFT Schedchk - Check and fix the Humax recording schedule DRAFT =
== Introduction ==
While it is "only telly" it can be extremely annoying when we find that a programme we had scheduled to record fails to record correctly.
Some failures can be attributed to user errors but a considerable numbers of problems are attributable to the broadcasters and problems in the Humax software not anticipating the ever more creative ways the broadcasters find to make life complicated!

The origins of schedchk go back several years to a [https://hummy.tv/forum/threads/schedchk-auto-fix-schedule-changes-a-proposal.7988 forum post]where I proposed the idea of automatically detecting when programmes were delayed or moved to another channel (e.g. BBC One -> BBC Two) because of overrunning sporting events or breaking news events. Nothing much happened at that time since Wimbledon only last two weeks and other last minute programme changes are by their nature unpredictable making testing difficult.

However now we live in Interesting Times and the unpredictable has become routine, every day the BBC1 showing of Pointless is moved to BBC2 to make way for the Corona Virus Daily Update. One might think that after this long the BBC would take the hint and schedule Pointless on BBC2 but no they persist in scheduling it on BBC1 and only update the schedules 3-72 hours in advance!
Since Pointless is one of our favourite shows I was provoked into resurrecting the Schedchk idea and finally it is now ready for a wider audience though there may still be a few rough edges.

The program relies on the EPG being kept up-to-date to allow it to find alternative showings of programmes and, especially with last minute changes, that can't be relied upon and sometimes there are no alternate showings so it will not be infallible but hopefully it will help you avoid some missed recordings,

I have found several different categories of potential errors in the schedule and these are listed below with examples of how they can occur and action schedchk takes when attempting to fix them.
__TOC__
== Failure Categories ==
=== EPG changes ===
The most basic form of schedule change is when the broadcaster changes the start time, duration or scheduled episode (event-CRID change).
Usually the Humax is quite good at spotting these changes but sometimes it doesn't immediately.

Schedchk will resolve this type of error by updating the schedule entry with the new details.

Checking for this type of problem can be by-passed by specifying the -noEPGchg option in settings or on the command line

=== Missing EPG entry ===
[[File:Schedchk-duplicateepisode.png|frameless|right|Duplicate episode]]
Sometimes the event-id associated with a programme changes and the Humax is not good at resolving these, on occasion it can get very confused resulting in it scheduling two episodes of the same series at the same time!

Changes to the event-id can occur when a programme is moved another channel (e.g. Pointless moving from BBC1_>2), when a programme is added to the schedule (ITV assigned new event-ids to all programmes following the Queen's recent broadcasts), a different episode is scheduled (e.g, the duplicate example above) or if a programme is cancelled and replaced by something else.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead.
If there are no matches by event-CRID it will look for a programme of the same name scheduled for the same time in case the Broadcaster has changed event-id, event-CRID and series-CRID and scheduled an episode from a different series of the programme.
If duplicate episodes occur it will delete the episode that no longer appears in the EPG.

Checking for this type of problem can be by-passed by specifying the -noMissEPG option in settings or on the command line

=== Conflict resolution ===

Conflict arise when three of more programmes are scheduled to be recorded at the same time (Two or more on HD model).
This can arise if a user ignores conflict warnings when scheduling, when a news days EPG data is loaded, or if the EPG changes.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead. When considering alternatives schedchk will attempt to find a match on a channel with the same definition (HD or SD) as the original but if there is no match it will consider matches on channels with a different definition.

Schedchk is quite simple minded in its approach to conflict resolution and will not always choose the best solution for your viewing needs. For complex conflicts or where you want to select which programmes you don't want delayed you should attempt to manually resolve conflicts using the Visual Schedule displays in the webif or RS before schedchk attempts automatic resolution.

At the moment Split recordings are not considered for conflict resolution.

Checking for this type of problem can be by-passed by specifying the -noConflict option in settings or on the command line

=== Unscheduled episodes ===

The Humax normally manges to automatically schedule new episodes of a series but can sometimes miss changes that happen in the middle of the scheduled sequence

Schedchk checks the EPG by series-CRID and adds any missing

Checking for this type of problem can be by-passed by specifying the -noUnsched option in settings or on the command line

=== series-CRID changes ===

Often broadcasters change the series-CRID of a long running programme causing the next episodes of the programme to be not recorded. Sometimes this is because it has switched to another series of the programme (as if we really care whether it is repeats from series 51 or 55) but other times there is no obvious reason for the change.

Schedchk handles this by looking by programme name for a new series with matching name in the same time slot on the same channel and scheduling a new series recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes with variable time slots such as the F1 Grand Prix races
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the series-CRID check is liable to consider the +1 series a new unscheduled series

Checking for this type of problem can be by-passed by specifying the -noSCRID option in settings or on the command line

=== One-off episodes of a series ===

Sometimes broadcasters schedule episodes of a series as 1-off programmes without a series-CRID. Often this is deliberate when filling in a gap in the schedule but other times it is the result of broadcaster incompetence! Recently Pick broadcast several episodes of the Sherlock series as 1-off programmes 😥

Schedchk handles this by looking by programme name for a 1-off programme with matching name on the same channel and scheduling a recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the 1-off check is liable to search the +1 channel

Checking for this type of problem can be by-passed by specifying the -no1off option in settings or on the command line

=== Not Recording ===

Occasionally a programme fails to start recording. This can be due to an unresolved conflict, overrunning programmes, last minute schedule changes etc. but some failures are unexplained.

When a programme is due to be recording schedchk checks whether there is a file for the recording and whether it is growing in size. If the programme is not recording it searches by event-CRID for an alternative showing and, if a suitable alternate is found, schedules it as a 1-off recording.

Since some late starting is normal the checking starts a short while after the scheduled start. By default this is 300 seconds (5 minutes) but this can be modified by specifying the -recWait option in settings or on the command line

Checking for this type of problem can be by-passed by specifying the -noNotRec option in settings or on the command line

Note: Since active recording schedule entries are deleted on Humax start-up schedchk can't schedule alternates for recordings truncated by a power failure or Humax crash 😥.

=== Split Recordings ===

Split recordings are where a long programme such as a film has a shorter programme, often a news bulletin, in the middle of the longer programme. While they may appear to be a 2-epsidode series they are not treated as such by the broadcasters or the Humax and have their own (very badly designed) set of rules which the Humax only partially implements.
Split recordings contain #number at the end of their event-CRID (eg /X4454865#01) and both halves of the split recording are required to have the same number, known as an IMI (Instance Metadata ID). The problem arises when the same film is repeated later in the week with exactly the same event-CRID and IMI, under the rules if there is more than three hours between them they should be treated as different programmes but the Humax treats them all as additional parts of the same programme.

This is a particular problem on channels such as Sony Movies which split most films into 2 parts and regularly repeat films up to three times a week. So you can attempt to schedule just one showing of a film but the Humax will schedule all six parts and some of the unwanted recordings can cause schedule conflicts.

Schedchk handles split recordings by leaving those with one or two parts schedule alone, if there are more than two parts scheduled it checks whether there is more than a 3-hour gap and whether there are any conflicts. The first, non-conflicting, showing is kept with a dummy IMI to prevent the Humax rescheduling and the other showings are removed from the schedule.

Checking for this type of problem can be by-passed by specifying the -noSplit option in settings or on the command line

== Other controls ==

=== Threshold ===

The Threshold setting (-thresh) controls how far into the schedule schedchk should look for problems. The default, unless changed in setting is 36 hours which seems adequate for resolving potential problems.
You may wish to increase it on infrequently used machines.

=== No Auto ===

Normally schedchk runs as part of the regular Auto processing.
If you would prefer to run it on ad-hoc basis from a command line or set up your own [[Schedchk#Running via crontabs|schedule with ctontabs]] you can specify No Auto in the Schedchk section of the settings page.

=== No Alerts ===

Schedchk generates webif warnings when it makes changes to the recording schedule to let you know what has happened.
[[File:Schedchk-alert.png|frame|center|Alert messages]]
If you would prefer not to receive these pop-up messages you can specify the -noAlert option in settings or on the command line.

Note: The example shows that sometimes broadcasters makes changes and then reverse them in short order.

=== Test Mode ===

If you specify the -test option no schedule changes will actually be made

=== In-place updating ===

If you use the visual schedule webif/RS pages to "Record this showing instead" it will generate a skip entry for the current episode and a one-off recording entry for the replacement episode. Schedchk uses a different approach and where possible updates the existing series entry with the new episode details.

The main advantages of this approach is that the recording will automatically go into the series folder and any folder related webif settings (auto-decrypt, shrink, detectads etc) will be applied as usual. You will only have one entry in the recording schedule rather than many and you won't have to move recordings from the My Videos folder.

[[File:Schedchk-inplace.png|800px||right]]
[[File:Schedchk-inplace2.png|800px||right]]
It can look a bit odd to have episodes from different channels in the same series but both webif and RS handle this correctly

Which of the channels will show as the 'main' channel for the series depends on the channel of the next scheduled episode

Minor disadvantages are:
* The Humax won't add new episodes while the 'wrong' channel is main (but Schedchk 'Unscheduled episodes' will add them instead)
* Schedchk 'SCRID change' and '1-off episodes' will check the alternate channel when it is main (more work needs to be done in this area)

If you would prefer more traditional skip and 1-off scheduling you can specify the -noAlert option in settings or on the command line.

=== Progress Messages ===

The -d option controls the level of mesages produced:
* 0 - Schedule changes and errors only (also displayed as webif notifications)
* 1 - Intermediate level
* 2 - Detailed progress messages

== Schedchk settings ==

Initially all schedchk processing options are enabled but the default settings can be overridden on the webif Settings page, any changes made here become the new defaults for schedchk.

More detail on each of the options is given in the sections above.

[[File:Schedchk-settingspage.png|frame|center|SchedChk Settings Page ]]

== Schedchk command line ==

As well as running automatically every few minutes as part of the regular Auto process you can also run schedchk on demand from a command line. Options specified on the command line override values set on the settings page for this invocation of schedchk only, they don't change the default values.

<pre>
schedchk = Check for recording schedule issues and attempt to fix them

schedchk -h = produce this help
schedchk -rsv = scan the recording schedule

Options Default (unless changed in Settings)
-thresh 36 = Don't check for problems more than x hrs away from start
-d 0 = Produce more detailed output
-test n = Don't make updates
-noAuto n = Don't run regularly as part of Auto-Processing
-noAlert n = Don't generate webif alert messages for changes made
-noConflict n = Don't check for conflicts
-noUnsched n = Don't check for episodes missing from schedule
-noSCRID n = Don't check for series CRID changes
-no1off n = Don't check for episodes scheduled as one off programmes
-noNotRec n = Don't check for failures to record
-recWait 300 = Don't assume recording failed until x seconds late starting
-noMissEPG n = Don't resolve missing epg entries
-noEPGchg n = Don't resolve epg time/ duration/ event crid changes
-noSplit n = Don't resolve repeated split recordings
-noInplace n = Update reservation by skipping & 1-off rather than inplace

Note: Options are not case sensitive
</pre>
-noAuto has no effect when specified as a command option, it needs to be set via the settings page.

== Running via crontabs ==

As an alternative to running schedchk as part of the standard customised firmware Auto processing it also possible to schedule schedchk to run at different intervals using the crontabs file.

You might want to do this if:
* You normally disable Auto processing during recordings but would still like to take advantage of Not Recording checks
* You want some checks made at a different frequency from others
* You want process messages written to a dedicated log file

You can edit the crontabs file via webif->Diag->File Editor->Commonly edited files->/mod/var/spool/cron/crontabs/root
[[File:Schedchk-crontabs.png|frame|center|Editing crontabs file]]
In the example above schedchk will run a Not Recording check every 4 minutes and check for SCRID changes and 1-off recordings every 4 hours at 17 minutes past the hour, output will be written to schedchk.log

[https://www.thegeekstuff.com/2009/06/15-practical-crontab-examples/ Guides to crontabs time formats are available online]

== fmtrsv - Format a rsv.db table entry ==
Fmtrsv is a simple command line utility created to help with displaying the contents of the rsv.db where schedule entries are stored. It is included with the schedchk package to help in gathering information for debugging purposes. Entries displayed can be filtered with a number of options
<pre>
# fmtrsv -h
fmtrsv = Formats schedule entries from the rsv.db

fmtrsv options
no options will list all reservations

Options
-h produce this help
-n,-name xxx = select recording name contains
-s,-slot n = select slot
-l,-lcn n = select channel number
-c,-cname xxx = select channel name contains
</pre>
Sample output
<pre>
# fmtrsv -s 16
ulslot = 16
ersvtype = 3 Recording
hsvc = 131097
nsttime = 1590429600 25/05/2020 19:00
szsttime = 00000000000000
nduration = 3600 01:00
erepeat = 0 no repeats
usevtid = 12270
szevtname = i7Code-Breakers: Bletchley Park's... (Code-Breakers: Bletchley Park's...)
ulPreOffset = 0
ulPostOffset = 0
ulProgramId = 0
ulSeriesId = 0
ucVolume = 0
ucInputMode = 0
usChNum = 0
ucRecKind = 4 series
ucCRIDType = 50 series
szCRID = FP.BBC.CO.UK/B-3P5L5
szFPBRecPath = Code-Breakers: Bletchley Park's...
szRecordedProgCrid = 1FP.BBC.CO.UK/B/KZSO7|
szEventToRecord = 1FP.BBC.CO.UK/B/KOEPL|
aulEventToRecordInfo = {131097 1590429600 1590433200 12270}
bRecomRsv = 0
usLastRecordedEvtId = 0
eReady = 30
szSvcName = BBC TWO
usLcn = 2
Svcid Start End Evtid CRID
131097 1590429600 25/05/2020 19:00 1590433200 25/05/2020 20:00 12270 1FP.BBC.CO.UK/B/KOEPL
Skiplist Svcid:Evtid
131097:12390
========================================================

</pre>
== Other Stuff ==
=== Change history ===
{|border=1,
| '''Date'''||'''Version'''||'''Author'''||'''Description'''
|-
|2020-05-xx ||schedchk 0.1,0-0|| mymsman || Intial Version
* All new!
|}
=== Acknowledgements ===
;af123:For providing the cf framework that underlies everything and who's code I have copied and hacked.
;/df:For investigating the problems with Split recordings and writing the rsv set method
;everybody else:Who has assisted through the forums
=== Future Enhancements ===
* Detect and reschedule recordings active at time of crash
* Improve Series CRID change detection to reduce false positives

Schedchk

2020-05-30T18:00:29Z

MymsMan: /* Other controls */

= [[File:Schedchk48.png|left]]DRAFT Schedchk - Check and fix the Humax recording schedule DRAFT =
== Introduction ==
While it is "only telly" it can be extremely annoying when we find that a programme we had scheduled to record fails to record correctly.
Some failures can be attributed to user errors but a considerable numbers of problems are attributable to the broadcasters and problems in the Humax software not anticipating the ever more creative ways the broadcasters find to make life complicated!

The origins of schedchk go back several years to a [https://hummy.tv/forum/threads/schedchk-auto-fix-schedule-changes-a-proposal.7988 forum post]where I proposed the idea of automatically detecting when programmes were delayed or moved to another channel (e.g. BBC One -> BBC Two) because of overrunning sporting events or breaking news events. Nothing much happened at that time since Wimbledon only last two weeks and other last minute programme changes are by their nature unpredictable making testing difficult.

However now we live in Interesting Times and the unpredictable has become routine, every day the BBC1 showing of Pointless is moved to BBC2 to make way for the Corona Virus Daily Update. One might think that after this long the BBC would take the hint and schedule Pointless on BBC2 but no they persist in scheduling it on BBC1 and only update the schedules 3-72 hours in advance!
Since Pointless is one of our favourite shows I was provoked into resurrecting the Schedchk idea and finally it is now ready for a wider audience though there may still be a few rough edges.

The program relies on the EPG being kept up-to-date to allow it to find alternative showings of programmes and, especially with last minute changes, that can't be relied upon and sometimes there are no alternate showings so it will not be infallible but hopefully it will help you avoid some missed recordings,

I have found several different categories of potential errors in the schedule and these are listed below with examples of how they can occur and action schedchk takes when attempting to fix them.
__TOC__
== Failure Categories ==
=== EPG changes ===
The most basic form of schedule change is when the broadcaster changes the start time, duration or scheduled episode (event-CRID change).
Usually the Humax is quite good at spotting these changes but sometimes it doesn't immediately.

Schedchk will resolve this type of error by updating the schedule entry with the new details.

Checking for this type of problem can be by-passed by specifying the -noEPGchg option in settings or on the command line

=== Missing EPG entry ===
[[File:Schedchk-duplicateepisode.png|frameless|right|Duplicate episode]]
Sometimes the event-id associated with a programme changes and the Humax is not good at resolving these, on occasion it can get very confused resulting in it scheduling two episodes of the same series at the same time!

Changes to the event-id can occur when a programme is moved another channel (e.g. Pointless moving from BBC1_>2), when a programme is added to the schedule (ITV assigned new event-ids to all programmes following the Queen's recent broadcasts), a different episode is scheduled (e.g, the duplicate example above) or if a programme is cancelled and replaced by something else.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead.
If there are no matches by event-CRID it will look for a programme of the same name scheduled for the same time in case the Broadcaster has changed event-id, event-CRID and series-CRID and scheduled an episode from a different series of the programme.
If duplicate episodes occur it will delete the episode that no longer appears in the EPG.

Checking for this type of problem can be by-passed by specifying the -noMissEPG option in settings or on the command line

=== Conflict resolution ===

Conflict arise when three of more programmes are scheduled to be recorded at the same time (Two or more on HD model).
This can arise if a user ignores conflict warnings when scheduling, when a news days EPG data is loaded, or if the EPG changes.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead. When considering alternatives schedchk will attempt to find a match on a channel with the same definition (HD or SD) as the original but if there is no match it will consider matches on channels with a different definition.

Schedchk is quite simple minded in its approach to conflict resolution and will not always choose the best solution for your viewing needs. For complex conflicts or where you want to select which programmes you don't want delayed you should attempt to manually resolve conflicts using the Visual Schedule displays in the webif or RS before schedchk attempts automatic resolution.

At the moment Split recordings are not considered for conflict resolution.

Checking for this type of problem can be by-passed by specifying the -noConflict option in settings or on the command line

=== Unscheduled episodes ===

The Humax normally manges to automatically schedule new episodes of a series but can sometimes miss changes that happen in the middle of the scheduled sequence

Schedchk checks the EPG by series-CRID and adds any missing

Checking for this type of problem can be by-passed by specifying the -noUnsched option in settings or on the command line

=== series-CRID changes ===

Often broadcasters change the series-CRID of a long running programme causing the next episodes of the programme to be not recorded. Sometimes this is because it has switched to another series of the programme (as if we really care whether it is repeats from series 51 or 55) but other times there is no obvious reason for the change.

Schedchk handles this by looking by programme name for a new series with matching name in the same time slot on the same channel and scheduling a new series recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes with variable time slots such as the F1 Grand Prix races
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the series-CRID check is liable to consider the +1 series a new unscheduled series

Checking for this type of problem can be by-passed by specifying the -noSCRID option in settings or on the command line

=== One-off episodes of a series ===

Sometimes broadcasters schedule episodes of a series as 1-off programmes without a series-CRID. Often this is deliberate when filling in a gap in the schedule but other times it is the result of broadcaster incompetence! Recently Pick broadcast several episodes of the Sherlock series as 1-off programmes 😥

Schedchk handles this by looking by programme name for a 1-off programme with matching name on the same channel and scheduling a recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the 1-off check is liable to search the +1 channel

Checking for this type of problem can be by-passed by specifying the -no1off option in settings or on the command line

=== Not Recording ===

Occasionally a programme fails to start recording. This can be due to an unresolved conflict, overrunning programmes, last minute schedule changes etc. but some failures are unexplained.

When a programme is due to be recording schedchk checks whether there is a file for the recording and whether it is growing in size. If the programme is not recording it searches by event-CRID for an alternative showing and, if a suitable alternate is found, schedules it as a 1-off recording.

Since some late starting is normal the checking starts a short while after the scheduled start. By default this is 300 seconds (5 minutes) but this can be modified by specifying the -recWait option in settings or on the command line

Checking for this type of problem can be by-passed by specifying the -noNotRec option in settings or on the command line

Note: Since active recording schedule entries are deleted on Humax start-up schedchk can't schedule alternates for recordings truncated by a power failure or Humax crash 😥.

=== Split Recordings ===

Split recordings are where a long programme such as a film has a shorter programme, often a news bulletin, in the middle of the longer programme. While they may appear to be a 2-epsidode series they are not treated as such by the broadcasters or the Humax and have their own (very badly designed) set of rules which the Humax only partially implements.
Split recordings contain #number at the end of their event-CRID (eg /X4454865#01) and both halves of the split recording are required to have the same number, known as an IMI (Instance Metadata ID). The problem arises when the same film is repeated later in the week with exactly the same event-CRID and IMI, under the rules if there is more than three hours between them they should be treated as different programmes but the Humax treats them all as additional parts of the same programme.

This is a particular problem on channels such as Sony Movies which split most films into 2 parts and regularly repeat films up to three times a week. So you can attempt to schedule just one showing of a film but the Humax will schedule all six parts and some of the unwanted recordings can cause schedule conflicts.

Schedchk handles split recordings by leaving those with one or two parts schedule alone, if there are more than two parts scheduled it checks whether there is more than a 3-hour gap and whether there are any conflicts. The first, non-conflicting, showing is kept with a dummy IMI to prevent the Humax rescheduling and the other showings are removed from the schedule.

Checking for this type of problem can be by-passed by specifying the -noSplit option in settings or on the command line

== Other controls ==

=== Threshold ===

The Threshold setting (-thresh) controls how far into the schedule schedchk should look for problems. The default, unless changed in setting is 36 hours which seems adequate for resolving potential problems.
You may wish to increase it on infrequently used machines.

=== No Auto ===

Normally schedchk runs as part of the regular Auto processing.
If you would prefer to run it on ad-hoc basis from a command line or set up your own [[Schedchk#Running via crontabs|schedule with ctontabs]] you can specify No Auto in the Schedchk section of the settings page.

=== No Alerts ===

Schedchk generates webif warnings when it makes changes to the recording schedule to let you know what has happened.
[[File:Schedchk-alert.png|frame|center|Alert messages]]
If you would prefer not to receive these pop-up messages you can specify the -noAlert option in settings or on the command line.

Note: The example shows that sometimes broadcasters makes changes and then reverse them in short order.

=== Test Mode ===

If you specify the -test option no schedule changes will actually be made

=== In-place updating ===

If you use the visual schedule webif/RS pages to "Record this showing instead" it will generate a skip entry for the current episode and a one-off recording entry for the replacement episode. Schedchk uses a different approach and where possible updates the existing series entry with the new episode details.

The main advantages of this approach is that the recording will automatically go into the series folder and any folder related webif settings (auto-decrypt, shrink, detectads etc) will be applied as usual. You will only have one entry in the recording schedule rather than many and you won't have to move recordings from the My Videos folder.

[[File:Schedchk-inplace.png|800px||right]]
[[File:Schedchk-inplace2.png|800px||right]]
It can look a bit odd to have episodes from different channels in the same series but both webif and RS handle this correctly

Which of the channels will show as the 'main' channel for the series depends on the channel of the next scheduled episode

Minor disadvantages are:
* The Humax won't add new episodes while the 'wrong' channel is main (but Schedchk 'Missing episodes' will add them intead)
* Schedchk 'SCRID change' and '1-off episodes' will check the alternate channel when it is main (more work needs to be done in this area)

If you would prefer more traditional skip and 1-off scheduling you can specify the -noAlert option in settings or on the command line.

=== Progress Messages ===

The -d option controls the level of mesages produced:
* 0 - Schedule changes and errors only (also displayed as webif notifications)
* 1 - Intermediate level
* 2 - Detailed progress messages

== Schedchk settings ==

Initially all schedchk processing options are enabled but the default settings can be overridden on the webif Settings page, any changes made here become the new defaults for schedchk.

More detail on each of the options is given in the sections above.

[[File:Schedchk-settingspage.png|frame|center|SchedChk Settings Page ]]

== Schedchk command line ==

As well as running automatically every few minutes as part of the regular Auto process you can also run schedchk on demand from a command line. Options specified on the command line override values set on the settings page for this invocation of schedchk only, they don't change the default values.

<pre>
schedchk = Check for recording schedule issues and attempt to fix them

schedchk -h = produce this help
schedchk -rsv = scan the recording schedule

Options Default (unless changed in Settings)
-thresh 36 = Don't check for problems more than x hrs away from start
-d 0 = Produce more detailed output
-test n = Don't make updates
-noAuto n = Don't run regularly as part of Auto-Processing
-noAlert n = Don't generate webif alert messages for changes made
-noConflict n = Don't check for conflicts
-noUnsched n = Don't check for episodes missing from schedule
-noSCRID n = Don't check for series CRID changes
-no1off n = Don't check for episodes scheduled as one off programmes
-noNotRec n = Don't check for failures to record
-recWait 300 = Don't assume recording failed until x seconds late starting
-noMissEPG n = Don't resolve missing epg entries
-noEPGchg n = Don't resolve epg time/ duration/ event crid changes
-noSplit n = Don't resolve repeated split recordings
-noInplace n = Update reservation by skipping & 1-off rather than inplace

Note: Options are not case sensitive
</pre>
-noAuto has no effect when specified as a command option, it needs to be set via the settings page.

== Running via crontabs ==

As an alternative to running schedchk as part of the standard customised firmware Auto processing it also possible to schedule schedchk to run at different intervals using the crontabs file.

You might want to do this if:
* You normally disable Auto processing during recordings but would still like to take advantage of Not Recording checks
* You want some checks made at a different frequency from others
* You want process messages written to a dedicated log file

You can edit the crontabs file via webif->Diag->File Editor->Commonly edited files->/mod/var/spool/cron/crontabs/root
[[File:Schedchk-crontabs.png|frame|center|Editing crontabs file]]
In the example above schedchk will run a Not Recording check every 4 minutes and check for SCRID changes and 1-off recordings every 4 hours at 17 minutes past the hour, output will be written to schedchk.log

[https://www.thegeekstuff.com/2009/06/15-practical-crontab-examples/ Guides to crontabs time formats are available online]

== fmtrsv - Format a rsv.db table entry ==
Fmtrsv is a simple command line utility created to help with displaying the contents of the rsv.db where schedule entries are stored. It is included with the schedchk package to help in gathering information for debugging purposes. Entries displayed can be filtered with a number of options
<pre>
# fmtrsv -h
fmtrsv = Formats schedule entries from the rsv.db

fmtrsv options
no options will list all reservations

Options
-h produce this help
-n,-name xxx = select recording name contains
-s,-slot n = select slot
-l,-lcn n = select channel number
-c,-cname xxx = select channel name contains
</pre>
Sample output
<pre>
# fmtrsv -s 16
ulslot = 16
ersvtype = 3 Recording
hsvc = 131097
nsttime = 1590429600 25/05/2020 19:00
szsttime = 00000000000000
nduration = 3600 01:00
erepeat = 0 no repeats
usevtid = 12270
szevtname = i7Code-Breakers: Bletchley Park's... (Code-Breakers: Bletchley Park's...)
ulPreOffset = 0
ulPostOffset = 0
ulProgramId = 0
ulSeriesId = 0
ucVolume = 0
ucInputMode = 0
usChNum = 0
ucRecKind = 4 series
ucCRIDType = 50 series
szCRID = FP.BBC.CO.UK/B-3P5L5
szFPBRecPath = Code-Breakers: Bletchley Park's...
szRecordedProgCrid = 1FP.BBC.CO.UK/B/KZSO7|
szEventToRecord = 1FP.BBC.CO.UK/B/KOEPL|
aulEventToRecordInfo = {131097 1590429600 1590433200 12270}
bRecomRsv = 0
usLastRecordedEvtId = 0
eReady = 30
szSvcName = BBC TWO
usLcn = 2
Svcid Start End Evtid CRID
131097 1590429600 25/05/2020 19:00 1590433200 25/05/2020 20:00 12270 1FP.BBC.CO.UK/B/KOEPL
Skiplist Svcid:Evtid
131097:12390
========================================================

</pre>
== Other Stuff ==
=== Change history ===
{|border=1,
| '''Date'''||'''Version'''||'''Author'''||'''Description'''
|-
|2020-05-xx ||schedchk 0.1,0-0|| mymsman || Intial Version
* All new!
|}
=== Acknowledgements ===
;af123:For providing the cf framework that underlies everything and who's code I have copied and hacked.
;/df:For investigating the problems with Split recordings and writing the rsv set method
;everybody else:Who has assisted through the forums
=== Future Enhancements ===
* Detect and reschedule recordings active at time of crash
* Improve Series CRID change detection to reduce false positives

File:Schedchk-inplace2.png

2020-05-30T15:25:37Z

MymsMan: Multi channel series

== Summary ==
Multi channel series

File:Schedchk-inplace.png

2020-05-30T15:23:49Z

MymsMan: Multi-channel series

== Summary ==
Multi-channel series

File:Schedchk-alert.png

2020-05-29T18:40:30Z

MymsMan: Schedchk alert messages

== Summary ==
Schedchk alert messages

Schedchk

2020-05-26T23:05:13Z

MymsMan: Undo revision 5271 by MymsMan (talk)

= [[File:Schedchk48.png|left]]DRAFT Schedchk - Check and fix the Humax recording schedule DRAFT =
== Introduction ==
While it is "only telly" it can be extremely annoying when we find that a programme we had scheduled to record fails to record correctly.
Some failures can be attributed to user errors but a considerable numbers of problems are attributable to the broadcasters and problems in the Humax software not anticipating the ever more creative ways the broadcasters find to make life complicated!

The origins of schedchk go back several years to a [https://hummy.tv/forum/threads/schedchk-auto-fix-schedule-changes-a-proposal.7988 forum post]where I proposed the idea of automatically detecting when programmes were delayed or moved to another channel (e.g. BBC One -> BBC Two) because of overrunning sporting events or breaking news events. Nothing much happened at that time since Wimbledon only last two weeks and other last minute programme changes are by their nature unpredictable making testing difficult.

However now we live in Interesting Times and the unpredictable has become routine, every day the BBC1 showing of Pointless is moved to BBC2 to make way for the Corona Virus Daily Update. One might think that after this long the BBC would take the hint and schedule Pointless on BBC2 but no they persist in scheduling it on BBC1 and only update the schedules 3-72 hours in advance!
Since Pointless is one of our favourite shows I was provoked into resurrecting the Schedchk idea and finally it is now ready for a wider audience though there may still be a few rough edges.

The program relies on the EPG being kept up-to-date to allow it to find alternative showings of programmes and, especially with last minute changes, that can't be relied upon and sometimes there are no alternate showings so it will not be infallible but hopefully it will help you avoid some missed recordings,

I have found several different categories of potential errors in the schedule and these are listed below with examples of how they can occur and action schedchk takes when attempting to fix them.
__TOC__
== Failure Categories ==
=== EPG changes ===
The most basic form of schedule change is when the broadcaster changes the start time, duration or scheduled episode (event-CRID change).
Usually the Humax is quite good at spotting these changes but sometimes it doesn't immediately.

Schedchk will resolve this type of error by updating the schedule entry with the new details.

Checking for this type of problem can be by-passed by specifying the -noEPGchg option in settings or on the command line

=== Missing EPG entry ===
[[File:Schedchk-duplicateepisode.png|frameless|right|Duplicate episode]]
Sometimes the event-id associated with a programme changes and the Humax is not good at resolving these, on occasion it can get very confused resulting in it scheduling two episodes of the same series at the same time!

Changes to the event-id can occur when a programme is moved another channel (e.g. Pointless moving from BBC1_>2), when a programme is added to the schedule (ITV assigned new event-ids to all programmes following the Queen's recent broadcasts), a different episode is scheduled (e.g, the duplicate example above) or if a programme is cancelled and replaced by something else.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead.
If there are no matches by event-CRID it will look for a programme of the same name scheduled for the same time in case the Broadcaster has changed event-id, event-CRID and series-CRID and scheduled an episode from a different series of the programme.
If duplicate episodes occur it will delete the episode that no longer appears in the EPG.

Checking for this type of problem can be by-passed by specifying the -noMissEPG option in settings or on the command line

=== Conflict resolution ===

Conflict arise when three of more programmes are scheduled to be recorded at the same time (Two or more on HD model).
This can arise if a user ignores conflict warnings when scheduling, when a news days EPG data is loaded, or if the EPG changes.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead. When considering alternatives schedchk will attempt to find a match on a channel with the same definition (HD or SD) as the original but if there is no match it will consider matches on channels with a different definition.

Schedchk is quite simple minded in its approach to conflict resolution and will not always choose the best solution for your viewing needs. For complex conflicts or where you want to select which programmes you don't want delayed you should attempt to manually resolve conflicts using the Visual Schedule displays in the webif or RS before schedchk attempts automatic resolution.

At the moment Split recordings are not considered for conflict resolution.

Checking for this type of problem can be by-passed by specifying the -noConflict option in settings or on the command line

=== Unscheduled episodes ===

The Humax normally manges to automatically schedule new episodes of a series but can sometimes miss changes that happen in the middle of the scheduled sequence

Schedchk checks the EPG by series-CRID and adds any missing

Checking for this type of problem can be by-passed by specifying the -noUnsched option in settings or on the command line

=== series-CRID changes ===

Often broadcasters change the series-CRID of a long running programme causing the next episodes of the programme to be not recorded. Sometimes this is because it has switched to another series of the programme (as if we really care whether it is repeats from series 51 or 55) but other times there is no obvious reason for the change.

Schedchk handles this by looking by programme name for a new series with matching name in the same time slot on the same channel and scheduling a new series recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes with variable time slots such as the F1 Grand Prix races
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the series-CRID check is liable to consider the +1 series a new unscheduled series

Checking for this type of problem can be by-passed by specifying the -noSCRID option in settings or on the command line

=== One-off episodes of a series ===

Sometimes broadcasters schedule episodes of a series as 1-off programmes without a series-CRID. Often this is deliberate when filling in a gap in the schedule but other times it is the result of broadcaster incompetence! Recently Pick broadcast several episodes of the Sherlock series as 1-off programmes 😥

Schedchk handles this by looking by programme name for a 1-off programme with matching name on the same channel and scheduling a recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the 1-off check is liable to search the +1 channel

Checking for this type of problem can be by-passed by specifying the -no1off option in settings or on the command line

=== Not Recording ===

Occasionally a programme fails to start recording. This can be due to an unresolved conflict, overrunning programmes, last minute schedule changes etc. but some failures are unexplained.

When a programme is due to be recording schedchk checks whether there is a file for the recording and whether it is growing in size. If the programme is not recording it searches by event-CRID for an alternative showing and, if a suitable alternate is found, schedules it as a 1-off recording.

Since some late starting is normal the checking starts a short while after the scheduled start. By default this is 300 seconds (5 minutes) but this can be modified by specifying the -recWait option in settings or on the command line

Checking for this type of problem can be by-passed by specifying the -noNotRec option in settings or on the command line

Note: Since active recording schedule entries are deleted on Humax start-up schedchk can't schedule alternates for recordings truncated by a power failure or Humax crash 😥.

=== Split Recordings ===

Split recordings are where a long programme such as a film has a shorter programme, often a news bulletin, in the middle of the longer programme. While they may appear to be a 2-epsidode series they are not treated as such by the broadcasters or the Humax and have their own (very badly designed) set of rules which the Humax only partially implements.
Split recordings contain #number at the end of their event-CRID (eg /X4454865#01) and both halves of the split recording are required to have the same number, known as an IMI (Instance Metadata ID). The problem arises when the same film is repeated later in the week with exactly the same event-CRID and IMI, under the rules if there is more than three hours between them they should be treated as different programmes but the Humax treats them all as additional parts of the same programme.

This is a particular problem on channels such as Sony Movies which split most films into 2 parts and regularly repeat films up to three times a week. So you can attempt to schedule just one showing of a film but the Humax will schedule all six parts and some of the unwanted recordings can cause schedule conflicts.

Schedchk handles split recordings by leaving those with one or two parts schedule alone, if there are more than two parts scheduled it checks whether there is more than a 3-hour gap and whether there are any conflicts. The first, non-conflicting, showing is kept with a dummy IMI to prevent the Humax rescheduling and the other showings are removed from the schedule.

Checking for this type of problem can be by-passed by specifying the -noSplit option in settings or on the command line

== Other controls ==

== Schedchk settings ==

Initially all schedchk processing options are enabled but the default settings can be overridden on the webif Settings page, any changes made here become the new defaults for schedchk.

More detail on each of the options is given in the sections above.

[[File:Schedchk-settingspage.png|frame|center|SchedChk Settings Page ]]

== Schedchk command line ==

As well as running automatically every few minutes as part of the regular Auto process you can also run schedchk on demand from a command line. Options specified on the command line override values set on the settings page for this invocation of schedchk only, they don't change the default values.

<pre>
schedchk = Check for recording schedule issues and attempt to fix them

schedchk -h = produce this help
schedchk -rsv = scan the recording schedule

Options Default (unless changed in Settings)
-thresh 36 = Don't check for problems more than x hrs away from start
-d 0 = Produce more detailed output
-test n = Don't make updates
-noAuto n = Don't run regularly as part of Auto-Processing
-noAlert n = Don't generate webif alert messages for changes made
-noConflict n = Don't check for conflicts
-noUnsched n = Don't check for episodes missing from schedule
-noSCRID n = Don't check for series CRID changes
-no1off n = Don't check for episodes scheduled as one off programmes
-noNotRec n = Don't check for failures to record
-recWait 300 = Don't assume recording failed until x seconds late starting
-noMissEPG n = Don't resolve missing epg entries
-noEPGchg n = Don't resolve epg time/ duration/ event crid changes
-noSplit n = Don't resolve repeated split recordings
-noInplace n = Update reservation by skipping & 1-off rather than inplace

Note: Options are not case sensitive
</pre>
-noAuto has no effect when specified as a command option, it needs to be set via the settings page.

== Running via crontabs ==

As an alternative to running schedchk as part of the standard customised firmware Auto processing it also possible to schedule schedchk to run at different intervals using the crontabs file.

You might want to do this if:
* You normally disable Auto processing during recordings but would still like to take advantage of Not Recording checks
* You want some checks made at a different frequency from others
* You want process messages written to a dedicated log file

You can edit the crontabs file via webif->Diag->File Editor->Commonly edited files->/mod/var/spool/cron/crontabs/root
[[File:Schedchk-crontabs.png|frame|center|Editing crontabs file]]
In the example above schedchk will run a Not Recording check every 4 minutes and check for SCRID changes and 1-off recordings every 4 hours at 17 minutes past the hour, output will be written to schedchk.log

[https://www.thegeekstuff.com/2009/06/15-practical-crontab-examples/ Guides to crontabs time formats are available online]

== fmtrsv - Format a rsv.db table entry ==
Fmtrsv is a simple command line utility created to help with displaying the contents of the rsv.db where schedule entries are stored. It is included with the schedchk package to help in gathering information for debugging purposes. Entries displayed can be filtered with a number of options
<pre>
# fmtrsv -h
fmtrsv = Formats schedule entries from the rsv.db

fmtrsv options
no options will list all reservations

Options
-h produce this help
-n,-name xxx = select recording name contains
-s,-slot n = select slot
-l,-lcn n = select channel number
-c,-cname xxx = select channel name contains
</pre>
Sample output
<pre>
# fmtrsv -s 16
ulslot = 16
ersvtype = 3 Recording
hsvc = 131097
nsttime = 1590429600 25/05/2020 19:00
szsttime = 00000000000000
nduration = 3600 01:00
erepeat = 0 no repeats
usevtid = 12270
szevtname = i7Code-Breakers: Bletchley Park's... (Code-Breakers: Bletchley Park's...)
ulPreOffset = 0
ulPostOffset = 0
ulProgramId = 0
ulSeriesId = 0
ucVolume = 0
ucInputMode = 0
usChNum = 0
ucRecKind = 4 series
ucCRIDType = 50 series
szCRID = FP.BBC.CO.UK/B-3P5L5
szFPBRecPath = Code-Breakers: Bletchley Park's...
szRecordedProgCrid = 1FP.BBC.CO.UK/B/KZSO7|
szEventToRecord = 1FP.BBC.CO.UK/B/KOEPL|
aulEventToRecordInfo = {131097 1590429600 1590433200 12270}
bRecomRsv = 0
usLastRecordedEvtId = 0
eReady = 30
szSvcName = BBC TWO
usLcn = 2
Svcid Start End Evtid CRID
131097 1590429600 25/05/2020 19:00 1590433200 25/05/2020 20:00 12270 1FP.BBC.CO.UK/B/KOEPL
Skiplist Svcid:Evtid
131097:12390
========================================================

</pre>
== Other Stuff ==
=== Change history ===
{|border=1,
| '''Date'''||'''Version'''||'''Author'''||'''Description'''
|-
|2020-05-xx ||schedchk 0.1,0-0|| mymsman || Intial Version
* All new!
|}
=== Acknowledgements ===
;af123:For providing the cf framework that underlies everything and who's code I have copied and hacked.
;/df:For investigating the problems with Split recordings and writing the rsv set method
;everybody else:Who has assisted through the forums
=== Future Enhancements ===
* Detect and reschedule recordings active at time of crash
* Improve Series CRID change detection to reduce false positives

Schedchk

2020-05-26T23:00:49Z

MymsMan: /* Schedchk settings */

= [[File:Schedchk48.png|left]]DRAFT Schedchk - Check and fix the Humax recording schedule DRAFT =
== Introduction ==
While it is "only telly" it can be extremely annoying when we find that a programme we had scheduled to record fails to record correctly.
Some failures can be attributed to user errors but a considerable numbers of problems are attributable to the broadcasters and problems in the Humax software not anticipating the ever more creative ways the broadcasters find to make life complicated!

The origins of schedchk go back several years to a [https://hummy.tv/forum/threads/schedchk-auto-fix-schedule-changes-a-proposal.7988 forum post]where I proposed the idea of automatically detecting when programmes were delayed or moved to another channel (e.g. BBC One -> BBC Two) because of overrunning sporting events or breaking news events. Nothing much happened at that time since Wimbledon only last two weeks and other last minute programme changes are by their nature unpredictable making testing difficult.

However now we live in Interesting Times and the unpredictable has become routine, every day the BBC1 showing of Pointless is moved to BBC2 to make way for the Corona Virus Daily Update. One might think that after this long the BBC would take the hint and schedule Pointless on BBC2 but no they persist in scheduling it on BBC1 and only update the schedules 3-72 hours in advance!
Since Pointless is one of our favourite shows I was provoked into resurrecting the Schedchk idea and finally it is now ready for a wider audience though there may still be a few rough edges.

The program relies on the EPG being kept up-to-date to allow it to find alternative showings of programmes and, especially with last minute changes, that can't be relied upon and sometimes there are no alternate showings so it will not be infallible but hopefully it will help you avoid some missed recordings,

I have found several different categories of potential errors in the schedule and these are listed below with examples of how they can occur and action schedchk takes when attempting to fix them.
__TOC__
== Failure Categories ==
=== EPG changes ===
The most basic form of schedule change is when the broadcaster changes the start time, duration or scheduled episode (event-CRID change).
Usually the Humax is quite good at spotting these changes but sometimes it doesn't immediately.

Schedchk will resolve this type of error by updating the schedule entry with the new details.

Checking for this type of problem can be by-passed by specifying the -noEPGchg option in settings or on the command line

=== Missing EPG entry ===
[[File:Schedchk-duplicateepisode.png|frameless|right|Duplicate episode]]
Sometimes the event-id associated with a programme changes and the Humax is not good at resolving these, on occasion it can get very confused resulting in it scheduling two episodes of the same series at the same time!

Changes to the event-id can occur when a programme is moved another channel (e.g. Pointless moving from BBC1_>2), when a programme is added to the schedule (ITV assigned new event-ids to all programmes following the Queen's recent broadcasts), a different episode is scheduled (e.g, the duplicate example above) or if a programme is cancelled and replaced by something else.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead.
If there are no matches by event-CRID it will look for a programme of the same name scheduled for the same time in case the Broadcaster has changed event-id, event-CRID and series-CRID and scheduled an episode from a different series of the programme.
If duplicate episodes occur it will delete the episode that no longer appears in the EPG.

Checking for this type of problem can be by-passed by specifying the -noMissEPG option in settings or on the command line

=== Conflict resolution ===

Conflict arise when three of more programmes are scheduled to be recorded at the same time (Two or more on HD model).
This can arise if a user ignores conflict warnings when scheduling, when a news days EPG data is loaded, or if the EPG changes.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead. When considering alternatives schedchk will attempt to find a match on a channel with the same definition (HD or SD) as the original but if there is no match it will consider matches on channels with a different definition.

Schedchk is quite simple minded in its approach to conflict resolution and will not always choose the best solution for your viewing needs. For complex conflicts or where you want to select which programmes you don't want delayed you should attempt to manually resolve conflicts using the Visual Schedule displays in the webif or RS before schedchk attempts automatic resolution.

At the moment Split recordings are not considered for conflict resolution.

Checking for this type of problem can be by-passed by specifying the -noConflict option in settings or on the command line

=== Unscheduled episodes ===

The Humax normally manges to automatically schedule new episodes of a series but can sometimes miss changes that happen in the middle of the scheduled sequence

Schedchk checks the EPG by series-CRID and adds any missing

Checking for this type of problem can be by-passed by specifying the -noUnsched option in settings or on the command line

=== series-CRID changes ===

Often broadcasters change the series-CRID of a long running programme causing the next episodes of the programme to be not recorded. Sometimes this is because it has switched to another series of the programme (as if we really care whether it is repeats from series 51 or 55) but other times there is no obvious reason for the change.

Schedchk handles this by looking by programme name for a new series with matching name in the same time slot on the same channel and scheduling a new series recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes with variable time slots such as the F1 Grand Prix races
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the series-CRID check is liable to consider the +1 series a new unscheduled series

Checking for this type of problem can be by-passed by specifying the -noSCRID option in settings or on the command line

=== One-off episodes of a series ===

Sometimes broadcasters schedule episodes of a series as 1-off programmes without a series-CRID. Often this is deliberate when filling in a gap in the schedule but other times it is the result of broadcaster incompetence! Recently Pick broadcast several episodes of the Sherlock series as 1-off programmes 😥

Schedchk handles this by looking by programme name for a 1-off programme with matching name on the same channel and scheduling a recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the 1-off check is liable to search the +1 channel

Checking for this type of problem can be by-passed by specifying the -no1off option in settings or on the command line

=== Not Recording ===

Occasionally a programme fails to start recording. This can be due to an unresolved conflict, overrunning programmes, last minute schedule changes etc. but some failures are unexplained.

When a programme is due to be recording schedchk checks whether there is a file for the recording and whether it is growing in size. If the programme is not recording it searches by event-CRID for an alternative showing and, if a suitable alternate is found, schedules it as a 1-off recording.

Since some late starting is normal the checking starts a short while after the scheduled start. By default this is 300 seconds (5 minutes) but this can be modified by specifying the -recWait option in settings or on the command line

Checking for this type of problem can be by-passed by specifying the -noNotRec option in settings or on the command line

Note: Since active recording schedule entries are deleted on Humax start-up schedchk can't schedule alternates for recordings truncated by a power failure or Humax crash 😥.

=== Split Recordings ===

Split recordings are where a long programme such as a film has a shorter programme, often a news bulletin, in the middle of the longer programme. While they may appear to be a 2-epsidode series they are not treated as such by the broadcasters or the Humax and have their own (very badly designed) set of rules which the Humax only partially implements.
Split recordings contain #number at the end of their event-CRID (eg /X4454865#01) and both halves of the split recording are required to have the same number, known as an IMI (Instance Metadata ID). The problem arises when the same film is repeated later in the week with exactly the same event-CRID and IMI, under the rules if there is more than three hours between them they should be treated as different programmes but the Humax treats them all as additional parts of the same programme.

This is a particular problem on channels such as Sony Movies which split most films into 2 parts and regularly repeat films up to three times a week. So you can attempt to schedule just one showing of a film but the Humax will schedule all six parts and some of the unwanted recordings can cause schedule conflicts.

Schedchk handles split recordings by leaving those with one or two parts schedule alone, if there are more than two parts scheduled it checks whether there is more than a 3-hour gap and whether there are any conflicts. The first, non-conflicting, showing is kept with a dummy IMI to prevent the Humax rescheduling and the other showings are removed from the schedule.

Checking for this type of problem can be by-passed by specifying the -noSplit option in settings or on the command line

== Other controls ==

== schedchk settings ==

Initially all schedchk processing options are enabled but the default settings can be overridden on the webif Settings page, any changes made here become the new defaults for schedchk.

More detail on each of the options is given in the sections above.

[[File:Schedchk-settingspage.png|frame|center|SchedChk Settings Page ]]

== Schedchk command line ==

As well as running automatically every few minutes as part of the regular Auto process you can also run schedchk on demand from a command line. Options specified on the command line override values set on the settings page for this invocation of schedchk only, they don't change the default values.

<pre>
schedchk = Check for recording schedule issues and attempt to fix them

schedchk -h = produce this help
schedchk -rsv = scan the recording schedule

Options Default (unless changed in Settings)
-thresh 36 = Don't check for problems more than x hrs away from start
-d 0 = Produce more detailed output
-test n = Don't make updates
-noAuto n = Don't run regularly as part of Auto-Processing
-noAlert n = Don't generate webif alert messages for changes made
-noConflict n = Don't check for conflicts
-noUnsched n = Don't check for episodes missing from schedule
-noSCRID n = Don't check for series CRID changes
-no1off n = Don't check for episodes scheduled as one off programmes
-noNotRec n = Don't check for failures to record
-recWait 300 = Don't assume recording failed until x seconds late starting
-noMissEPG n = Don't resolve missing epg entries
-noEPGchg n = Don't resolve epg time/ duration/ event crid changes
-noSplit n = Don't resolve repeated split recordings
-noInplace n = Update reservation by skipping & 1-off rather than inplace

Note: Options are not case sensitive
</pre>
-noAuto has no effect when specified as a command option, it needs to be set via the settings page.

== Running via crontabs ==

As an alternative to running schedchk as part of the standard customised firmware Auto processing it also possible to schedule schedchk to run at different intervals using the crontabs file.

You might want to do this if:
* You normally disable Auto processing during recordings but would still like to take advantage of Not Recording checks
* You want some checks made at a different frequency from others
* You want process messages written to a dedicated log file

You can edit the crontabs file via webif->Diag->File Editor->Commonly edited files->/mod/var/spool/cron/crontabs/root
[[File:Schedchk-crontabs.png|frame|center|Editing crontabs file]]
In the example above schedchk will run a Not Recording check every 4 minutes and check for SCRID changes and 1-off recordings every 4 hours at 17 minutes past the hour, output will be written to schedchk.log

[https://www.thegeekstuff.com/2009/06/15-practical-crontab-examples/ Guides to crontabs time formats are available online]

== fmtrsv - Format a rsv.db table entry ==
Fmtrsv is a simple command line utility created to help with displaying the contents of the rsv.db where schedule entries are stored. It is included with the schedchk package to help in gathering information for debugging purposes. Entries displayed can be filtered with a number of options
<pre>
# fmtrsv -h
fmtrsv = Formats schedule entries from the rsv.db

fmtrsv options
no options will list all reservations

Options
-h produce this help
-n,-name xxx = select recording name contains
-s,-slot n = select slot
-l,-lcn n = select channel number
-c,-cname xxx = select channel name contains
</pre>
Sample output
<pre>
# fmtrsv -s 16
ulslot = 16
ersvtype = 3 Recording
hsvc = 131097
nsttime = 1590429600 25/05/2020 19:00
szsttime = 00000000000000
nduration = 3600 01:00
erepeat = 0 no repeats
usevtid = 12270
szevtname = i7Code-Breakers: Bletchley Park's... (Code-Breakers: Bletchley Park's...)
ulPreOffset = 0
ulPostOffset = 0
ulProgramId = 0
ulSeriesId = 0
ucVolume = 0
ucInputMode = 0
usChNum = 0
ucRecKind = 4 series
ucCRIDType = 50 series
szCRID = FP.BBC.CO.UK/B-3P5L5
szFPBRecPath = Code-Breakers: Bletchley Park's...
szRecordedProgCrid = 1FP.BBC.CO.UK/B/KZSO7|
szEventToRecord = 1FP.BBC.CO.UK/B/KOEPL|
aulEventToRecordInfo = {131097 1590429600 1590433200 12270}
bRecomRsv = 0
usLastRecordedEvtId = 0
eReady = 30
szSvcName = BBC TWO
usLcn = 2
Svcid Start End Evtid CRID
131097 1590429600 25/05/2020 19:00 1590433200 25/05/2020 20:00 12270 1FP.BBC.CO.UK/B/KOEPL
Skiplist Svcid:Evtid
131097:12390
========================================================

</pre>
== Other Stuff ==
=== Change history ===
{|border=1,
| '''Date'''||'''Version'''||'''Author'''||'''Description'''
|-
|2020-05-xx ||schedchk 0.1,0-0|| mymsman || Intial Version
* All new!
|}
=== Acknowledgements ===
;af123:For providing the cf framework that underlies everything and who's code I have copied and hacked.
;/df:For investigating the problems with Split recordings and writing the rsv set method
;everybody else:Who has assisted through the forums
=== Future Enhancements ===
* Detect and reschedule recordings active at time of crash
* Improve Series CRID change detection to reduce false positives

Schedchk

2020-05-26T22:59:05Z

MymsMan: /* Schedchk setting */

= [[File:Schedchk48.png|left]]DRAFT Schedchk - Check and fix the Humax recording schedule DRAFT =
== Introduction ==
While it is "only telly" it can be extremely annoying when we find that a programme we had scheduled to record fails to record correctly.
Some failures can be attributed to user errors but a considerable numbers of problems are attributable to the broadcasters and problems in the Humax software not anticipating the ever more creative ways the broadcasters find to make life complicated!

The origins of schedchk go back several years to a [https://hummy.tv/forum/threads/schedchk-auto-fix-schedule-changes-a-proposal.7988 forum post]where I proposed the idea of automatically detecting when programmes were delayed or moved to another channel (e.g. BBC One -> BBC Two) because of overrunning sporting events or breaking news events. Nothing much happened at that time since Wimbledon only last two weeks and other last minute programme changes are by their nature unpredictable making testing difficult.

However now we live in Interesting Times and the unpredictable has become routine, every day the BBC1 showing of Pointless is moved to BBC2 to make way for the Corona Virus Daily Update. One might think that after this long the BBC would take the hint and schedule Pointless on BBC2 but no they persist in scheduling it on BBC1 and only update the schedules 3-72 hours in advance!
Since Pointless is one of our favourite shows I was provoked into resurrecting the Schedchk idea and finally it is now ready for a wider audience though there may still be a few rough edges.

The program relies on the EPG being kept up-to-date to allow it to find alternative showings of programmes and, especially with last minute changes, that can't be relied upon and sometimes there are no alternate showings so it will not be infallible but hopefully it will help you avoid some missed recordings,

I have found several different categories of potential errors in the schedule and these are listed below with examples of how they can occur and action schedchk takes when attempting to fix them.
__TOC__
== Failure Categories ==
=== EPG changes ===
The most basic form of schedule change is when the broadcaster changes the start time, duration or scheduled episode (event-CRID change).
Usually the Humax is quite good at spotting these changes but sometimes it doesn't immediately.

Schedchk will resolve this type of error by updating the schedule entry with the new details.

Checking for this type of problem can be by-passed by specifying the -noEPGchg option in settings or on the command line

=== Missing EPG entry ===
[[File:Schedchk-duplicateepisode.png|frameless|right|Duplicate episode]]
Sometimes the event-id associated with a programme changes and the Humax is not good at resolving these, on occasion it can get very confused resulting in it scheduling two episodes of the same series at the same time!

Changes to the event-id can occur when a programme is moved another channel (e.g. Pointless moving from BBC1_>2), when a programme is added to the schedule (ITV assigned new event-ids to all programmes following the Queen's recent broadcasts), a different episode is scheduled (e.g, the duplicate example above) or if a programme is cancelled and replaced by something else.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead.
If there are no matches by event-CRID it will look for a programme of the same name scheduled for the same time in case the Broadcaster has changed event-id, event-CRID and series-CRID and scheduled an episode from a different series of the programme.
If duplicate episodes occur it will delete the episode that no longer appears in the EPG.

Checking for this type of problem can be by-passed by specifying the -noMissEPG option in settings or on the command line

=== Conflict resolution ===

Conflict arise when three of more programmes are scheduled to be recorded at the same time (Two or more on HD model).
This can arise if a user ignores conflict warnings when scheduling, when a news days EPG data is loaded, or if the EPG changes.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead. When considering alternatives schedchk will attempt to find a match on a channel with the same definition (HD or SD) as the original but if there is no match it will consider matches on channels with a different definition.

Schedchk is quite simple minded in its approach to conflict resolution and will not always choose the best solution for your viewing needs. For complex conflicts or where you want to select which programmes you don't want delayed you should attempt to manually resolve conflicts using the Visual Schedule displays in the webif or RS before schedchk attempts automatic resolution.

At the moment Split recordings are not considered for conflict resolution.

Checking for this type of problem can be by-passed by specifying the -noConflict option in settings or on the command line

=== Unscheduled episodes ===

The Humax normally manges to automatically schedule new episodes of a series but can sometimes miss changes that happen in the middle of the scheduled sequence

Schedchk checks the EPG by series-CRID and adds any missing

Checking for this type of problem can be by-passed by specifying the -noUnsched option in settings or on the command line

=== series-CRID changes ===

Often broadcasters change the series-CRID of a long running programme causing the next episodes of the programme to be not recorded. Sometimes this is because it has switched to another series of the programme (as if we really care whether it is repeats from series 51 or 55) but other times there is no obvious reason for the change.

Schedchk handles this by looking by programme name for a new series with matching name in the same time slot on the same channel and scheduling a new series recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes with variable time slots such as the F1 Grand Prix races
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the series-CRID check is liable to consider the +1 series a new unscheduled series

Checking for this type of problem can be by-passed by specifying the -noSCRID option in settings or on the command line

=== One-off episodes of a series ===

Sometimes broadcasters schedule episodes of a series as 1-off programmes without a series-CRID. Often this is deliberate when filling in a gap in the schedule but other times it is the result of broadcaster incompetence! Recently Pick broadcast several episodes of the Sherlock series as 1-off programmes 😥

Schedchk handles this by looking by programme name for a 1-off programme with matching name on the same channel and scheduling a recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the 1-off check is liable to search the +1 channel

Checking for this type of problem can be by-passed by specifying the -no1off option in settings or on the command line

=== Not Recording ===

Occasionally a programme fails to start recording. This can be due to an unresolved conflict, overrunning programmes, last minute schedule changes etc. but some failures are unexplained.

When a programme is due to be recording schedchk checks whether there is a file for the recording and whether it is growing in size. If the programme is not recording it searches by event-CRID for an alternative showing and, if a suitable alternate is found, schedules it as a 1-off recording.

Since some late starting is normal the checking starts a short while after the scheduled start. By default this is 300 seconds (5 minutes) but this can be modified by specifying the -recWait option in settings or on the command line

Checking for this type of problem can be by-passed by specifying the -noNotRec option in settings or on the command line

Note: Since active recording schedule entries are deleted on Humax start-up schedchk can't schedule alternates for recordings truncated by a power failure or Humax crash 😥.

=== Split Recordings ===

Split recordings are where a long programme such as a film has a shorter programme, often a news bulletin, in the middle of the longer programme. While they may appear to be a 2-epsidode series they are not treated as such by the broadcasters or the Humax and have their own (very badly designed) set of rules which the Humax only partially implements.
Split recordings contain #number at the end of their event-CRID (eg /X4454865#01) and both halves of the split recording are required to have the same number, known as an IMI (Instance Metadata ID). The problem arises when the same film is repeated later in the week with exactly the same event-CRID and IMI, under the rules if there is more than three hours between them they should be treated as different programmes but the Humax treats them all as additional parts of the same programme.

This is a particular problem on channels such as Sony Movies which split most films into 2 parts and regularly repeat films up to three times a week. So you can attempt to schedule just one showing of a film but the Humax will schedule all six parts and some of the unwanted recordings can cause schedule conflicts.

Schedchk handles split recordings by leaving those with one or two parts schedule alone, if there are more than two parts scheduled it checks whether there is more than a 3-hour gap and whether there are any conflicts. The first, non-conflicting, showing is kept with a dummy IMI to prevent the Humax rescheduling and the other showings are removed from the schedule.

Checking for this type of problem can be by-passed by specifying the -noSplit option in settings or on the command line

== Other controls ==

== Schedchk settings ==

Initially all schedchk processing options are enabled but the default settings can be overridden on the webif Settings page, any changes made here become the new defaults for schedchk.

More detail on each of the options is given in the sections above.

[[File:Schedchk-settingspage.png|frame|center|SchedChk Settings Page ]]

== Schedchk command line ==

As well as running automatically every few minutes as part of the regular Auto process you can also run schedchk on demand from a command line. Options specified on the command line override values set on the settings page for this invocation of schedchk only, they don't change the default values.

<pre>
schedchk = Check for recording schedule issues and attempt to fix them

schedchk -h = produce this help
schedchk -rsv = scan the recording schedule

Options Default (unless changed in Settings)
-thresh 36 = Don't check for problems more than x hrs away from start
-d 0 = Produce more detailed output
-test n = Don't make updates
-noAuto n = Don't run regularly as part of Auto-Processing
-noAlert n = Don't generate webif alert messages for changes made
-noConflict n = Don't check for conflicts
-noUnsched n = Don't check for episodes missing from schedule
-noSCRID n = Don't check for series CRID changes
-no1off n = Don't check for episodes scheduled as one off programmes
-noNotRec n = Don't check for failures to record
-recWait 300 = Don't assume recording failed until x seconds late starting
-noMissEPG n = Don't resolve missing epg entries
-noEPGchg n = Don't resolve epg time/ duration/ event crid changes
-noSplit n = Don't resolve repeated split recordings
-noInplace n = Update reservation by skipping & 1-off rather than inplace

Note: Options are not case sensitive
</pre>
-noAuto has no effect when specified as a command option, it needs to be set via the settings page.

== Running via crontabs ==

As an alternative to running schedchk as part of the standard customised firmware Auto processing it also possible to schedule schedchk to run at different intervals using the crontabs file.

You might want to do this if:
* You normally disable Auto processing during recordings but would still like to take advantage of Not Recording checks
* You want some checks made at a different frequency from others
* You want process messages written to a dedicated log file

You can edit the crontabs file via webif->Diag->File Editor->Commonly edited files->/mod/var/spool/cron/crontabs/root
[[File:Schedchk-crontabs.png|frame|center|Editing crontabs file]]
In the example above schedchk will run a Not Recording check every 4 minutes and check for SCRID changes and 1-off recordings every 4 hours at 17 minutes past the hour, output will be written to schedchk.log

[https://www.thegeekstuff.com/2009/06/15-practical-crontab-examples/ Guides to crontabs time formats are available online]

== fmtrsv - Format a rsv.db table entry ==
Fmtrsv is a simple command line utility created to help with displaying the contents of the rsv.db where schedule entries are stored. It is included with the schedchk package to help in gathering information for debugging purposes. Entries displayed can be filtered with a number of options
<pre>
# fmtrsv -h
fmtrsv = Formats schedule entries from the rsv.db

fmtrsv options
no options will list all reservations

Options
-h produce this help
-n,-name xxx = select recording name contains
-s,-slot n = select slot
-l,-lcn n = select channel number
-c,-cname xxx = select channel name contains
</pre>
Sample output
<pre>
# fmtrsv -s 16
ulslot = 16
ersvtype = 3 Recording
hsvc = 131097
nsttime = 1590429600 25/05/2020 19:00
szsttime = 00000000000000
nduration = 3600 01:00
erepeat = 0 no repeats
usevtid = 12270
szevtname = i7Code-Breakers: Bletchley Park's... (Code-Breakers: Bletchley Park's...)
ulPreOffset = 0
ulPostOffset = 0
ulProgramId = 0
ulSeriesId = 0
ucVolume = 0
ucInputMode = 0
usChNum = 0
ucRecKind = 4 series
ucCRIDType = 50 series
szCRID = FP.BBC.CO.UK/B-3P5L5
szFPBRecPath = Code-Breakers: Bletchley Park's...
szRecordedProgCrid = 1FP.BBC.CO.UK/B/KZSO7|
szEventToRecord = 1FP.BBC.CO.UK/B/KOEPL|
aulEventToRecordInfo = {131097 1590429600 1590433200 12270}
bRecomRsv = 0
usLastRecordedEvtId = 0
eReady = 30
szSvcName = BBC TWO
usLcn = 2
Svcid Start End Evtid CRID
131097 1590429600 25/05/2020 19:00 1590433200 25/05/2020 20:00 12270 1FP.BBC.CO.UK/B/KOEPL
Skiplist Svcid:Evtid
131097:12390
========================================================

</pre>
== Other Stuff ==
=== Change history ===
{|border=1,
| '''Date'''||'''Version'''||'''Author'''||'''Description'''
|-
|2020-05-xx ||schedchk 0.1,0-0|| mymsman || Intial Version
* All new!
|}
=== Acknowledgements ===
;af123:For providing the cf framework that underlies everything and who's code I have copied and hacked.
;/df:For investigating the problems with Split recordings and writing the rsv set method
;everybody else:Who has assisted through the forums
=== Future Enhancements ===
* Detect and reschedule recordings active at time of crash
* Improve Series CRID change detection to reduce false positives

Schedchk

2020-05-26T22:41:52Z

MymsMan: fmtrsv

= [[File:Schedchk48.png|left]]DRAFT Schedchk - Check and fix the Humax recording schedule DRAFT =
== Introduction ==
While it is "only telly" it can be extremely annoying when we find that a programme we had scheduled to record fails to record correctly.
Some failures can be attributed to user errors but a considerable numbers of problems are attributable to the broadcasters and problems in the Humax software not anticipating the ever more creative ways the broadcasters find to make life complicated!

The origins of schedchk go back several years to a [https://hummy.tv/forum/threads/schedchk-auto-fix-schedule-changes-a-proposal.7988 forum post]where I proposed the idea of automatically detecting when programmes were delayed or moved to another channel (e.g. BBC One -> BBC Two) because of overrunning sporting events or breaking news events. Nothing much happened at that time since Wimbledon only last two weeks and other last minute programme changes are by their nature unpredictable making testing difficult.

However now we live in Interesting Times and the unpredictable has become routine, every day the BBC1 showing of Pointless is moved to BBC2 to make way for the Corona Virus Daily Update. One might think that after this long the BBC would take the hint and schedule Pointless on BBC2 but no they persist in scheduling it on BBC1 and only update the schedules 3-72 hours in advance!
Since Pointless is one of our favourite shows I was provoked into resurrecting the Schedchk idea and finally it is now ready for a wider audience though there may still be a few rough edges.

The program relies on the EPG being kept up-to-date to allow it to find alternative showings of programmes and, especially with last minute changes, that can't be relied upon and sometimes there are no alternate showings so it will not be infallible but hopefully it will help you avoid some missed recordings,

I have found several different categories of potential errors in the schedule and these are listed below with examples of how they can occur and action schedchk takes when attempting to fix them.
__TOC__
== Failure Categories ==
=== EPG changes ===
The most basic form of schedule change is when the broadcaster changes the start time, duration or scheduled episode (event-CRID change).
Usually the Humax is quite good at spotting these changes but sometimes it doesn't immediately.

Schedchk will resolve this type of error by updating the schedule entry with the new details.

Checking for this type of problem can be by-passed by specifying the -noEPGchg option in settings or on the command line

=== Missing EPG entry ===
[[File:Schedchk-duplicateepisode.png|frameless|right|Duplicate episode]]
Sometimes the event-id associated with a programme changes and the Humax is not good at resolving these, on occasion it can get very confused resulting in it scheduling two episodes of the same series at the same time!

Changes to the event-id can occur when a programme is moved another channel (e.g. Pointless moving from BBC1_>2), when a programme is added to the schedule (ITV assigned new event-ids to all programmes following the Queen's recent broadcasts), a different episode is scheduled (e.g, the duplicate example above) or if a programme is cancelled and replaced by something else.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead.
If there are no matches by event-CRID it will look for a programme of the same name scheduled for the same time in case the Broadcaster has changed event-id, event-CRID and series-CRID and scheduled an episode from a different series of the programme.
If duplicate episodes occur it will delete the episode that no longer appears in the EPG.

Checking for this type of problem can be by-passed by specifying the -noMissEPG option in settings or on the command line

=== Conflict resolution ===

Conflict arise when three of more programmes are scheduled to be recorded at the same time (Two or more on HD model).
This can arise if a user ignores conflict warnings when scheduling, when a news days EPG data is loaded, or if the EPG changes.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event-CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead. When considering alternatives schedchk will attempt to find a match on a channel with the same definition (HD or SD) as the original but if there is no match it will consider matches on channels with a different definition.

Schedchk is quite simple minded in its approach to conflict resolution and will not always choose the best solution for your viewing needs. For complex conflicts or where you want to select which programmes you don't want delayed you should attempt to manually resolve conflicts using the Visual Schedule displays in the webif or RS before schedchk attempts automatic resolution.

At the moment Split recordings are not considered for conflict resolution.

Checking for this type of problem can be by-passed by specifying the -noConflict option in settings or on the command line

=== Unscheduled episodes ===

The Humax normally manges to automatically schedule new episodes of a series but can sometimes miss changes that happen in the middle of the scheduled sequence

Schedchk checks the EPG by series-CRID and adds any missing

Checking for this type of problem can be by-passed by specifying the -noUnsched option in settings or on the command line

=== series-CRID changes ===

Often broadcasters change the series-CRID of a long running programme causing the next episodes of the programme to be not recorded. Sometimes this is because it has switched to another series of the programme (as if we really care whether it is repeats from series 51 or 55) but other times there is no obvious reason for the change.

Schedchk handles this by looking by programme name for a new series with matching name in the same time slot on the same channel and scheduling a new series recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes with variable time slots such as the F1 Grand Prix races
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the series-CRID check is liable to consider the +1 series a new unscheduled series

Checking for this type of problem can be by-passed by specifying the -noSCRID option in settings or on the command line

=== One-off episodes of a series ===

Sometimes broadcasters schedule episodes of a series as 1-off programmes without a series-CRID. Often this is deliberate when filling in a gap in the schedule but other times it is the result of broadcaster incompetence! Recently Pick broadcast several episodes of the Sherlock series as 1-off programmes 😥

Schedchk handles this by looking by programme name for a 1-off programme with matching name on the same channel and scheduling a recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the 1-off check is liable to search the +1 channel

Checking for this type of problem can be by-passed by specifying the -no1off option in settings or on the command line

=== Not Recording ===

Occasionally a programme fails to start recording. This can be due to an unresolved conflict, overrunning programmes, last minute schedule changes etc. but some failures are unexplained.

When a programme is due to be recording schedchk checks whether there is a file for the recording and whether it is growing in size. If the programme is not recording it searches by event-CRID for an alternative showing and, if a suitable alternate is found, schedules it as a 1-off recording.

Since some late starting is normal the checking starts a short while after the scheduled start. By default this is 300 seconds (5 minutes) but this can be modified by specifying the -recWait option in settings or on the command line

Checking for this type of problem can be by-passed by specifying the -noNotRec option in settings or on the command line

Note: Since active recording schedule entries are deleted on Humax start-up schedchk can't schedule alternates for recordings truncated by a power failure or Humax crash 😥.

=== Split Recordings ===

Split recordings are where a long programme such as a film has a shorter programme, often a news bulletin, in the middle of the longer programme. While they may appear to be a 2-epsidode series they are not treated as such by the broadcasters or the Humax and have their own (very badly designed) set of rules which the Humax only partially implements.
Split recordings contain #number at the end of their event-CRID (eg /X4454865#01) and both halves of the split recording are required to have the same number, known as an IMI (Instance Metadata ID). The problem arises when the same film is repeated later in the week with exactly the same event-CRID and IMI, under the rules if there is more than three hours between them they should be treated as different programmes but the Humax treats them all as additional parts of the same programme.

This is a particular problem on channels such as Sony Movies which split most films into 2 parts and regularly repeat films up to three times a week. So you can attempt to schedule just one showing of a film but the Humax will schedule all six parts and some of the unwanted recordings can cause schedule conflicts.

Schedchk handles split recordings by leaving those with one or two parts schedule alone, if there are more than two parts scheduled it checks whether there is more than a 3-hour gap and whether there are any conflicts. The first, non-conflicting, showing is kept with a dummy IMI to prevent the Humax rescheduling and the other showings are removed from the schedule.

Checking for this type of problem can be by-passed by specifying the -noSplit option in settings or on the command line

== Other controls ==

== Schedchk setting ==

Initially all schedchk processing options are enabled but the default settings can be overridden on the webif Settings page, any changes made here become the new defaults for schedchk.

More detail on each of the options is given in the sections above.

[[File:Schedchk-settingspage.png|frame|center|SchedChk Settings Page ]]

== Schedchk command line ==

As well as running automatically every few minutes as part of the regular Auto process you can also run schedchk on demand from a command line. Options specified on the command line override values set on the settings page for this invocation of schedchk only, they don't change the default values.

<pre>
schedchk = Check for recording schedule issues and attempt to fix them

schedchk -h = produce this help
schedchk -rsv = scan the recording schedule

Options Default (unless changed in Settings)
-thresh 36 = Don't check for problems more than x hrs away from start
-d 0 = Produce more detailed output
-test n = Don't make updates
-noAuto n = Don't run regularly as part of Auto-Processing
-noAlert n = Don't generate webif alert messages for changes made
-noConflict n = Don't check for conflicts
-noUnsched n = Don't check for episodes missing from schedule
-noSCRID n = Don't check for series CRID changes
-no1off n = Don't check for episodes scheduled as one off programmes
-noNotRec n = Don't check for failures to record
-recWait 300 = Don't assume recording failed until x seconds late starting
-noMissEPG n = Don't resolve missing epg entries
-noEPGchg n = Don't resolve epg time/ duration/ event crid changes
-noSplit n = Don't resolve repeated split recordings
-noInplace n = Update reservation by skipping & 1-off rather than inplace

Note: Options are not case sensitive
</pre>
-noAuto has no effect when specified as a command option, it needs to be set via the settings page.

== Running via crontabs ==

As an alternative to running schedchk as part of the standard customised firmware Auto processing it also possible to schedule schedchk to run at different intervals using the crontabs file.

You might want to do this if:
* You normally disable Auto processing during recordings but would still like to take advantage of Not Recording checks
* You want some checks made at a different frequency from others
* You want process messages written to a dedicated log file

You can edit the crontabs file via webif->Diag->File Editor->Commonly edited files->/mod/var/spool/cron/crontabs/root
[[File:Schedchk-crontabs.png|frame|center|Editing crontabs file]]
In the example above schedchk will run a Not Recording check every 4 minutes and check for SCRID changes and 1-off recordings every 4 hours at 17 minutes past the hour, output will be written to schedchk.log

[https://www.thegeekstuff.com/2009/06/15-practical-crontab-examples/ Guides to crontabs time formats are available online]

== fmtrsv - Format a rsv.db table entry ==
Fmtrsv is a simple command line utility created to help with displaying the contents of the rsv.db where schedule entries are stored. It is included with the schedchk package to help in gathering information for debugging purposes. Entries displayed can be filtered with a number of options
<pre>
# fmtrsv -h
fmtrsv = Formats schedule entries from the rsv.db

fmtrsv options
no options will list all reservations

Options
-h produce this help
-n,-name xxx = select recording name contains
-s,-slot n = select slot
-l,-lcn n = select channel number
-c,-cname xxx = select channel name contains
</pre>
Sample output
<pre>
# fmtrsv -s 16
ulslot = 16
ersvtype = 3 Recording
hsvc = 131097
nsttime = 1590429600 25/05/2020 19:00
szsttime = 00000000000000
nduration = 3600 01:00
erepeat = 0 no repeats
usevtid = 12270
szevtname = i7Code-Breakers: Bletchley Park's... (Code-Breakers: Bletchley Park's...)
ulPreOffset = 0
ulPostOffset = 0
ulProgramId = 0
ulSeriesId = 0
ucVolume = 0
ucInputMode = 0
usChNum = 0
ucRecKind = 4 series
ucCRIDType = 50 series
szCRID = FP.BBC.CO.UK/B-3P5L5
szFPBRecPath = Code-Breakers: Bletchley Park's...
szRecordedProgCrid = 1FP.BBC.CO.UK/B/KZSO7|
szEventToRecord = 1FP.BBC.CO.UK/B/KOEPL|
aulEventToRecordInfo = {131097 1590429600 1590433200 12270}
bRecomRsv = 0
usLastRecordedEvtId = 0
eReady = 30
szSvcName = BBC TWO
usLcn = 2
Svcid Start End Evtid CRID
131097 1590429600 25/05/2020 19:00 1590433200 25/05/2020 20:00 12270 1FP.BBC.CO.UK/B/KOEPL
Skiplist Svcid:Evtid
131097:12390
========================================================

</pre>
== Other Stuff ==
=== Change history ===
{|border=1,
| '''Date'''||'''Version'''||'''Author'''||'''Description'''
|-
|2020-05-xx ||schedchk 0.1,0-0|| mymsman || Intial Version
* All new!
|}
=== Acknowledgements ===
;af123:For providing the cf framework that underlies everything and who's code I have copied and hacked.
;/df:For investigating the problems with Split recordings and writing the rsv set method
;everybody else:Who has assisted through the forums
=== Future Enhancements ===
* Detect and reschedule recordings active at time of crash
* Improve Series CRID change detection to reduce false positives

Schedchk

2020-05-26T15:10:28Z

MymsMan: Split recording

= [[File:Schedchk48.png|left]]DRAFT Schedchk - Check and fix the Humax recording schedule DRAFT =
== Introduction ==
While it is "only telly" it can be extremely annoying when we find that a programme we had scheduled to record fails to record correctly.
Some failures can be attributed to user errors but a considerable numbers of problems are attributable to the broadcasters and problems in the Humax software not anticipating the ever more creative ways the broadcasters find to make life complicated!

The origins of schedchk go back several years to a [https://hummy.tv/forum/threads/schedchk-auto-fix-schedule-changes-a-proposal.7988 forum post]where I proposed the idea of automatically detecting when programmes were delayed or moved to another channel (e.g. BBC One -> BBC Two) because of overrunning sporting events or breaking news events. Nothing much happened at that time since Wimbledon only last two weeks and other last minute programme changes are by their nature unpredictable making testing difficult.

However now we live in Interesting Times the unpredictable has become routine, every day the BBC1 showing of Pointless is moved to BBC2 to make way for the Corona Virus Daily Update. One might think that after this long the BBC would take the hint and schedule Pointless on BBC2 but no they persist in scheduling it on BBC1 and only update the schedules 3-72 hours in advance!
Since Pointless is one of our favourite shows I was provoked into resurrecting the Schedchk idea and finally it is now ready for a wider audience though there may still be a few rough edges.

The program relies on the epg being kept up-to-date to allow it to find alternative showings of programmes and, especially wih last minute changes, that can't be relied upon and sometimes there are no alternate showings so it will not be infallible but hopefully it will help you avoid some missed recordings,

I have found several different categories of potential errors in the schedule and these are listed below with examples of how they can occur and action schedchk takes when attempting to fix them.
__TOC__
== Failure Categories ==
=== EPG changes ===
The most basic form of schedule change is when the broadcaster changes the start time, duration or scheduled episode (CRID change).
Usually the humax is quite good at spotting these changes but sometimes it doesn't immediately.

Schedchk will resolve this type of error by updating the schedule entry with the new details.

Checking for this type of problem can be by-passed by specifying the -noEPGchg option in settings or on the command line

=== Missing EPG entry ===
[[File:Schedchk-duplicateepisode.png|frameless|right|Duplicate episode]]
Sometimes the event-id associated with a programme changes and the Humax is not good at resolving these, on occasion it can get very confused resulting in it scheduling two episodes of the same series at the same time!

Changes to the event-id can occur when a programme is moved another channel (e.g. Pointless moving from BBC1_>2), when a programme is added to the schedule (ITV assigned new event-ids to all programmes following the Queen's recent broadcasts), a different episode is scheduled (e.g, the duplicate example above) or if a programme is cancelled and replaced by something else.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead.
If there are no matches by event-crid it will look for a programme of the same name scheduled for the same time in case the Broadcaster has changed event-id, event-CRID and series-CRID and scheduled an episode from a different series of the programme.
If duplicate episodes occur it will delete the episode that no longer appears in the EPG.

Checking for this type of problem can be by-passed by specifying the -noMissEPG option in settings or on the command line

=== Conflict resolution ===

Conflict arise when three of more programmes are scheduled to be recorded at the same time (Two or more on HD model).
This can arise if a user ignores conflict warnings when scheduling, when a news days EPG data is loaded, or if the EPG changes.

Schedchk attempts to resolve this type of error by searching for another showing of the same programme (by event CRID) elsewhere in the EPG and if another showing (that doesn't cause a conflict) can be found, it will schedule that showing instead. When considering alternatives schedchk will attempt to find a match on a channel with the same definition (HD or SD) as the original but if there is no match it will consider matches on channels with a different definition.

Schedchk is quite simple minded in its approach to conflict resolution and will not always choose the best solution for your viewing needs. For complex conflicts or where you want to select which programmes you don't want delayed you should attempt to manually resolve conflicts using the Visual Schedule displays in the webif or RS before schedchk attempts automatic resolution.

At the moment Split recordings are not considered for conflict resolution.

Checking for this type of problem can be by-passed by specifying the -noConflict option in settings or on the command line

=== Unscheduled episodes ===

The Humax normally manges to automatically schedule new episodes of a series but can sometimes miss changes that happen in the middle of the scheduled sequence

Schedchk checks the EPG by series-CRID and adds any missing

Checking for this type of problem can be by-passed by specifying the -noUnsched option in settings or on the command line

=== series-CRID changes ===

Often broadcasters change the series-CRID of a long running programme causing the next episodes of the programme to be not recorded. Sometimes this is because it has switched to another series of the programme (as if we really care whether it is repeats from series 51 or 55) but other times there is no obvious reason for the change.

Schedchk handles this by looking by programme name for a new series with matching name in the same time slot on the same channel and scheduling a new series recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes with variable time slots such as the F1 Grand Prix races
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the series-CRID check is liable to consider the +1 series a new unscheduled series

Checking for this type of problem can be by-passed by specifying the -noSCRID option in settings or on the command line

=== One-off episodes of a series ===

Some times broadcasters schedule episodes of a series as 1-off programmes without a series-CRID. Often this is deliberate when filling in a gap in the schedule but other times it is the result of broadcaster incompetence! Recently Pick broadcast several episodes of the Sherlock series as 1-off programmes 😥

Schedchk handles this by looking by programme name for a 1-off programme with matching name on the same channel and scheduling a recording for the programme.

Prefixes such as New: are ignored but the checking can miss some programmes and find false matches in other cases:
* Variations in title, Pointless would match Pointless Celebrities but not vice versa
* Programmes moved by conflict resolution, If, for example, an series episode has been moved to a +1 channel the 1-off check is liable to search the +1 channel

Checking for this type of problem can be by-passed by specifying the -no1off option in settings or on the command line

=== Not Recording ===

Occasionally a programme fails to start recording. This can be due to an unresolved conflict, overrunning programmes, last minute schedule changes etc. but some failures are unexplained.

When a programme is due to be recording schedchk checks whether there is a file for the recording and whether it is growing in size. If the programme is not recording it searches by event-CRID for an alternative showing and, if a suitable alternate is found, schedules it as a 1-off recording.

Since some late starting is normal the checking starts a short while after the scheduled start. By default this is 300 seconds (5 minutes) but this can be modified by specifying the -recWait option in settings or on the command line

Checking for this type of problem can be by-passed by specifying the -noNotRec option in settings or on the command line

Note: Since active recording schedule entries are deleted on Humax start-up schedchk can't schedule alternates for recordings truncated by a power failure or Humax crash 😥.

=== Split Recordings ===

Split recordings are where a long programme such as a film has a shorter programme, often a news bulletin, in the middle of the longer programme. While they may appear to be a 2-epsidode series they are not treated as such by the broadcasters or the Humax and have there own (very badly designed) set of rules which the Humax only partially implements.
Split recordings contain #number at the end of their event-CRID (eg /X4454865#01) and both halves of he split recording are required to have the same number, known as an IMI (Instance Metadata ID). The problem arises when the same film is repeated later in the week with exactly the same event-CRID and IMI, under the rules if there is more than three hours between them they should be treated as different programmes but the Humax treats them all as additional parts of the same programme.

This is a particular problem on channels such as Sony Movies which split most films into 2 parts and regularly repeat films up to three times a week. So you can attempt to schedule just one showing of a film but the Humax will schedule all six parts and some of the unwanted recordings can cause schedule conflicts.

Schedchk handles split recordings by leaving those with one or two parts schedule alone, if there are more than two parts scheduled it checks whether there is more than a 3-hour gap and whether there are any conflicts. The first, non-conflicting, showing is kept with a dummy IMI to prevent the Humax rescheduling and the other showings are removed from the schedule.

Checking for this type of problem can be by-passed by specifying the -no Split option in settings or on the command line

== Other controls ==

== Schedchk setting ==

Initially all schedchk processing options are enabled but the default settings can be overridden on the webif Settings page, any changes made here become the new defaults for schedchk.

More detail on each of the options is given in the sections above.

[[File:Schedchk-settingspage.png|frame|center|SchedChk Settings Page ]]

== Schedchk command line ==

As well as running automatically every few minutes as part of the regular auto process you can also run schedchk on demand from a command line. Options specified on the command line override values set on the settings page for this invocation of schedchk only, they don't change the default values.

<pre>
schedchk = Check for recording schedule issues and attempt to fix them

schedchk -h = produce this help
schedchk -rsv = scan the recording schedule

Options Default (unless changed in Settings)
-thresh 36 = Don't check for problems more than x hrs away from start
-d 0 = Produce more detailed output
-test n = Don't make updates
-noAuto n = Don't run regularly as part of Auto-Processing
-noAlert n = Don't generate webif alert messages for changes made
-noConflict n = Don't check for conflicts
-noUnsched n = Don't check for episodes missing from schedule
-noSCRID n = Don't check for series CRID changes
-no1off n = Don't check for episodes scheduled as one off programmes
-noNotRec n = Don't check for failures to record
-recWait 300 = Don't assume recording failed until x seconds late starting
-noMissEPG n = Don't resolve missing epg entries
-noEPGchg n = Don't resolve epg time/ duration/ event crid changes
-noSplit n = Don't resolve repeated split recordings
-noInplace n = Update reservation by skipping & 1-off rather than inplace

Note: Options are not case sensitive
</pre>
-noAuto has no effect when specified as a command option, it needs to be set via the settings page.

== Running via crontabs ==

As an alternative to running schedchk as part of the standard customised firmware Auto processing it also possible to schedule schedchk to run at different intervals using the crontabs file.

You might want to do this if:
* You normally disable Auto processing during recordings but would still like to take advantage of Not Recording checks
* You want some checks made at a different frequency from others
* You want process messages written to a dedicated log file

You can edit the crontabs file via webif->Diag->File Editor->Commonly edited files->/mod/var/spool/cron/crontabs/root
[[File:Schedchk-crontabs.png|frame|center|Editing crontabs file]]
In the example above schedchk will run a Not Recording check every 4 minutes and check for SCRID changes and 1-off recordings every 4 hours at 17 minutes past the hour, output will be written to schedchk.log

[https://www.thegeekstuff.com/2009/06/15-practical-crontab-examples/ Guides to crontabs time formats are available online]

== fmtrsv - Format a rsv.db table entry ==
== Other Stuff ==
=== Change history ===
{|border=1,
| '''Date'''||'''Version'''||'''Author'''||'''Description'''
|-
|2020-05-xx ||schedchk 0.1,0-0|| mymsman || Intial Version
* All new!
|}
=== Acknowledgements ===
;af123:For providing the cf framework that underlies everything and who's code I have copied and hacked.
;/df:For investigating the problems with Split recordings and writing the rsv set method
;everbody else:Who has assisted through the forums
=== Future Enhancements ===
* Detect and reschedule recordings active at time of crash
* Improve Series CRID change detection to reduce false positive's

File:Schedchk-crontabs.png

2020-05-26T13:44:38Z

MymsMan: MymsMan uploaded a new version of File:Schedchk-crontabs.png

== Summary ==
Editing crontabs file

Schedchk

2020-05-26T13:18:40Z

MymsMan: crontabs

File:Schedchk-crontabs.png

2020-05-26T13:00:07Z

MymsMan: Editing crontabs file

== Summary ==
Editing crontabs file

File:Schedchk-settingspage.png

2020-05-25T23:02:24Z

MymsMan: SchedChk Settings Page

== Summary ==
SchedChk Settings Page

Schedchk

2020-05-25T22:36:35Z

MymsMan: /* Not Recording */

Schedchk

2020-05-25T21:45:00Z

MymsMan: not recording

Schedchk

2020-05-25T20:02:38Z

MymsMan: scrid and 1-off

Schedchk

2020-05-24T19:16:05Z

MymsMan: Conflict resolution

Schedchk

2020-05-24T16:06:33Z

MymsMan: Conflict resolution

Schedchk

2020-05-24T15:53:50Z

MymsMan: /* Missing EPG entry */

Schedchk

2020-05-24T15:52:27Z

MymsMan: add missEPG description

File:Schedchk-duplicateepisode.png

2020-05-24T15:09:45Z

MymsMan: Showing two episodes of the same programme scheduled at the same time

== Summary ==
Showing two episodes of the same programme scheduled at the same time

Schedchk

2020-05-20T15:30:28Z

MymsMan: intermediate save

File:Schedchk48.png

2020-05-20T13:50:24Z

MymsMan: Schedchk icon

== Summary ==
Schedchk icon

Schedchk

2020-04-17T20:06:18Z

MymsMan: Created page with "== Introduction == === Schedchk setting ==="

== Introduction ==
=== Schedchk setting ===

Maintain packages with Git

2020-04-02T13:02:25Z

MymsMan: /* Commit your changes */

[https://en.wikipedia.org/wiki/Git Git] is a distributed version-control system for tracking changes in source code during software development. It is designed for coordinating work among programmers, but it can be used to track changes in any set of files.

Some, but not all, packages developed for the Humax use Git to maintain the associated source code. This allows for better tracking and control of changes and, potentially, allows for multiple users to collaborate on maintaining the package by making and testing changes on a private copy of the package and then submitting them for review and incorporation into the main package for distribution to the Humax community via the normal package update mechanism.

This wiki page attempts to describe the basics required to submit a change to a package that you don't own using the ''webif'' package as an example. It was written by a naive new user of Git and does not attempt to cover all of Git / Github and may contain errors, please correct and update this page where needed!

Git repository = Storage location for a single humax package

== Initial setup ==
Install, using the normal Humax package install method, the following (may need to show Advanced packages):
* git
* pkgtools
* gzip
* A text editor, Joe, Nano, or Vim unless you are happy with the default Vi

Create a user account on the hummy package git repository site https://git.hpkg.tv/ userid should normally be the same as your forum id,
Optionally also create an id on the the public git repository [https://github.com github]

All commands shown should be issued from a command prompt (telnet, putty, or Command Line on webif Diagnostics page)

Create a directory to hold git repositories (do not use /mod directly to avoid conflicts with installed packages)
<pre>
md /mod/git
cd /mod/git
</pre>
Set up some defaults for Git based on your details and preferences. The credential.helper timeout will remember your password for 24 hours
<pre>
git config --global user.name "USERNAME"
git config --global user.email "EMAIL"
git config --global core.editor "editor"
git config --global credential.helper 'cache --timeout=86400'
</pre>
== Fork and clone reposiory ==
Sign in and find the package you want to work with on the host repository eg https://git.hpkg.tv/hummypkg/webif

If the package you are interested in is not visible on the website contact the package owner to discuss access.

Click on the Fork button (top right) and create a forked repository
(using a fork creates a private copy and insulates your changes from those on the master, it is not needed if you are the repository owner)
Copy the the HHTPS url for the forked repository, ensure you are in your git folder on the humax and paste it into a ''git clone'' command
<pre>
cd /mod/git
git clone https://git.hpkg.tv/USERNAME/webif.git
</pre>
Change to your repository directory and add the master repository as another remote - this enables you to pick up changes made to the master
<pre>
cd /mod/git/webif
git remote add upstream https://git.hpkg.tv/hummypkg/webif.git
</pre>
You now have two remotes for this project on disk:
# origin which points to your fork of the project. You can read and write to this remote.
# upstream which points to the main project’s repository. You can only read from this remote.

== Sync with master ==
You don't need this step if you have just forked and cloned the master, but if time has elapsed and master may have changed you can pull in the latest changes and push them up to your host repository
<pre>
cd /mod/git/webif
git checkout master
git pull upstream master
git push origin master
</pre>
== Create a Branch ==
Every related set of changes should be in its own branch, don't try and fix unrelated problems in the same branch.
Branch names should be meaningful.
<pre>
cd /mod/git/webif
git checkout -b FixBrowseTypo
git push -u origin FixBrowseTypo
</pre>
The -b flag is only needed for a new branch, not when switching to existing branch

== Make your updates ==
Using your favourite text editor make the necessary changes to the code.
== Package, Install and test fixes ==
For simple changes you may be able to test the changes in isolation without needing to package and install for each update but to fully test using the webif it is best to properly package and install your changes.
Update CONTROL/control for the package to update the version number, check the dependencies section if your changes depend on new or updated packages (or remove existing dependencies). See the "[[Create Packages]]" page for more information on the control file structure.
Create package .opk file and install it (vers#) is the number from the control file
<pre>
cd /mod/git
opkg-pack webif
opkg install webif_vers#_mipsel.opk
</pre>
If the opkg-pack fails with 'Resource temporarily unavailable' messages try again - it seems to resolve itself after a few goes.
Test to ensure your changes are working as intended.
== Commit your changes ==
Committing saves your updates in the local Git repository and allows you to revert to any previous commit point should you need to back out a change, for a small change you may only need to commit once but for larger changes you can split your work into logical chunks and commit each piece. Pushing then syncs your remote repository with the changes from your local repository.

Before committing Git needs to know which of the changes you have made in the repository folder are to be included in the commit, this is known as staging and can be done in several ways.

To add a file to the next commit
<pre>
git add file.name
</pre>
To add all changed files to the next commit
<pre>
git add .
</pre>
To see the current status, very useful for checking what will / won't be committed
<pre>
git status
</pre>
To discard changes to a file
<pre>
git checkout -- file.name
</pre>
To commit all changed files use the -a flag on the commit command (alternative to ''git add .''), if the -m flag is omitted it will open an editor window for you to type a commit message
<pre>
git commit -a -m "Summary of the changes"
</pre>
Send changes to remote reposiory
<pre>
git push
</pre>
=== Omit CONTROL/control from commits ===
When different branches have changes to the same file Git can normally automatically merge the changes provided they don't affect the same lines of the file when you have to resolve the conflicts and decide which version to keep, not hard but extra work for the package owner.
Changes to the package version number obviously all affect the same line of the control file and will cause conflicts if several changes are to be combined into one update of the Humax package.
So unless you have made other changes (e.g. Dependencies) I suggest that you backout changes to the control file before committing.
<pre>
git checkout -- CONTROL/control
</pre>

== Create a Pull Request ==
A ''Pull Request'' is a request to the package owner to merge your changes into the Master repository and update the Humax package.
The New Pull Request button appears in a number of places on the remote repository pages under the Branches or Pull Requests tabs.

Ensure you specify the master branch of the master repository as the target for merge into and your branch to pull from
[[File:PullRequest.png|frame|centre|Creating a Pull Request]]

The title and description of the Pull Request should explain to the package owner why your changes should be included in the package.
Assign the request to the owner in the assignee tab (on the right of the page)

The owner will review your changes and may request changes which should be made and committed on the same branch (a new Pull request is '''not''' needed)

When happy with the changes the owner will merge the branch into master and close the Pull Request, the branch can be deleted and you can start again at the [[Maintain_packages_with_Git|Sync with master]] step
== Further Information ==
This page only scratches the surface of Git and there are numerous reference works and tutorials on github and elsewhere on the web. A few links that have helped me are:
* [https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/ The beginners guide to contributing to a github project]
* [http://www.bioinf.org.uk/teaching/bbk/biocomp2/git/git.pdf An introduction to Git and GitHub]
* [https://www.atlassian.com/git/tutorials Git Tutorials]

Create Packages

2020-03-11T17:19:14Z

MymsMan: Add Git usage

__NOTOC__
The modified firmware includes a lightweight package management system called opkg ([http://code.google.com/p/opkg/ home page]) which is similar to the Debian package management system (dpkg).

==Coding your package==

Most of the customised firmware is written in a language called Jim/TCL, See the Jim Manual [http://jim.tcl.tk/fossil/doc/trunk/Tcl_shipped.html '''HERE'''] with other bits in C/C++ and the Humax runs a Linux operating system.

A number of TCL classes have been created to make it easier to work with different parts of the Humax webif environment. For example the '''ts''' class provides services for working with recordings and the '''epg''' class provides access to the programme guide.

The webif also provides a large number of '''.hook''' points where packages can integrate themselves into the existing webif infrastructure. For example the '''browse.hook''' allows new actions to be added to the browse opt+ menus.

Unfortunately documentation is sparse and there is no definitive list of all the classes and their services or of the available hook points.
It is largely a case of reading existing code to find out what is available and above all asking questions on the forums, Use existing packages that have similarities as a basis for your code but don't forget to credit the original authors in your comments and forum/wiki posts.

== Package Repositories ==

The custom firmware is configured to use the package repository at [http://hummypkg.org.uk/packages.html hummypkg.org.uk] by default.

== Package Format ==

A package is a UNIX Archive (<tt>ar</tt>) file which itself contains three files:

;debian-binary : A file which just contains the string <tt>"2.0"</tt>, a clue to the packaging system's roots.
;data.tar.gz : The files which make up the package.
;control.tar.gz : Package meta-information.

== Creating a Package ==

The <tt>pkgtools</tt> package includes utilities for working with packages and can be used to create packages directly on the Humax itself. Before proceeding, install these utilities:

humax# opkg update
humax# opkg install pkgtools
humax# opkg install gzip

Next create a directory to hold your new package and create a directory within it called CONTROL, which will be used for the package meta-information:

humax# cd /mod/tmp
humax# mkdir my-first-package
humax# mkdir my-first-package/CONTROL

{{Note|Package names should '''not''' contain underscore (_) characters as these are used as delimiters in package file names. It is safest to stick to alpha-numeric characters and use - as a delimiter where appropriate, e.g. <tt>webif-iphone</tt>}}

Place the files which make up your package directly into the new package directory. Note that to save memory when running, compiled binaries should be stripped before packaging. In this example, we'll create a package which just installs a script called <tt>hello</tt>.

humax# cd /mod/tmp/my-first-package
humax# mkdir bin
humax# cat > bin/hello
#!/bin/sh

echo "Hello!"
^D
humax# chmod 755 bin/hello

{{Note|Files should be included relative to <tt>/mod</tt> (or <tt>/opt</tt> on the FoxSat) so in this example the <tt>bin/hello</tt> file will be installed as <tt>/mod/bin/hello</tt>}}

Create file package control file as <tt>CONTROL/control</tt>. Here's an example:

<pre>
Package: jim-sqlite3
Priority: optional
Section: misc
Version: 0.71
Architecture: mipsel
Maintainer: af123@hummypkg.org.uk
Depends: jim(>=0.71-1),sqlite3
Description: Jim SQLite3 plugin.
A plugin for the jim interpreter (a lightweight TCL interpreter) which
provides access to SQLite3 databases (such as those used on the Humax).
</pre>

The Debian project maintains [http://www.debian.org/doc/debian-policy/ch-controlfields.html documentation on the format of the control file] which also applies to opkg packages, although some fields are not required.

; Package : The package name.
; Priority : Always set to optional for Humax packages.
; Section : One of <tt>misc</tt>, <tt>net</tt>, <tt>devel</tt>, etc. [http://www.debian.org/doc/debian-policy/ch-archive.html#s-subsections full list]
; Version : The package version number of the format ''upstream_version[-opkg_version]'' [http://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Version more information]
; Architecture : Always <tt>mipsel</tt> for the HD/HDR Fox T2, and <tt>mips</tt> for the FoxSat.
; Maintainer : An email address or hummy.tv/wiki username.
; Depends : A list of dependencies for this package, optionally with version constraints [http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps see Debian documentation]
; Description : A description of the package. Continuation lines must be prefixed by white space.
; Tags : An optional field that contains a URL pointing to a source of further information

The CONTROL directory can also contain other package maintenance scripts such as <tt>preinst</tt>, <tt>postinst</tt>, <tt>prerm</tt> and <tt>postrm</tt>. See [http://www.debian.org/doc/debian-policy/ch-maintainerscripts.html the Debian documentation for more details and examples]. The scripts are called with various arguments during package maintenance operations. Many simple packages do not require any maintenance scripts.

Continuing with our example package, create the bare minimum control file:

<pre>
humax# cat > CONTROL/control
Package: hello
Version: 1.0
Architecture: mipsel
Maintainer: af123
Description: hello
Tags: http://wiki.hummy.tv/wiki/Custom_Firmware_Overview/
</pre>

The package can now be built using the opkg-pack command:

<pre>
humax# cd /mod/tmp
humax# opkg-pack my-first-package
bin/
bin/hello
Packaged contents of /mod/tmp/my-first-package/ into /mod/tmp/my-first-package//../hello_1.0_mipsel.opk 532
</pre>

The package can then be installed directly from the resulting file for testing.

<pre>
humax# opkg install hello_1.0_mipsel.opk
Installing hello (1.0) to root...
Configuring hello.
humax# hello
Hello!
humax# opkg remove hello
Removing package hello from root...
</pre>

If you have any packages which you'd like published in the [http://hummypkg.org.uk hummypkg.org.uk] repository, then email them to [mailto:packages@hummypkg.org.uk packages@hummypkg.org.uk].

== Using Git to store and maintain package ==

It is recommended that you use the Git library system to provide version control and to allow for collaborative development with others.

See [[Maintain packages with Git]] for a guide to using Git with Humax packages.
Most of that page also applies to maintaining your own packages but there are also a few differences which are covered here.

As package owner you will be responsible for establishing the principal repository for the package and will work directly with that repository rather than a forked copy and you will also be responsible for merging the branches created by you or others into the master branch once you are satisfied they are working correctly and then removing empty branches.

=== Create a new repository for your package ===

On the Dashboard of the [https://git.hpkg.tv/ Hummy Git website] click to create a New Repository
[[File:New Repository.png|frame|centre]]
Provide the Package name, Visibility (Public is best) and Description but ''do not'' select the 'Initialize Repository' option then click on 'Create Repository' buttton
On your local machine switch to the folder for the package and upload it the repository.
<pre>
cd /mod/tmp/my-first-package
git init
git add .
git commit -a -m "first commit"
git remote add origin https://git.hpkg.tv/USERNAME/my-first-package.git
git push -u origin master
</pre>

=== Merge changes into '''master''' branch ===
This can be done locally on your machine for changes you have made or on the web repository for Pull Requestsgo created by you or others
==== Local Merge ====
After completing changes switch to master branch, merge the changes, delete the branch and synchronize with the remote repository
<pre>
git checkout master
git merge branch-name
git branch -d branch-name
git push
</pre>
If the branch had bee pushed to the remote it can be deleted
<pre>
git push origin --delete branch-name
git remote prune origin
</pre>
==== Remote Merge ====
On the Pull Request tab of the [https://git.hpkg.tv/ Hummy Git website] Review the changes are OK and Approve the changes, or Request Changes if required
[[File:Review Pull request.png|frame|center]]
Once satisfied click on the "Merge Pull Request" button after which you can click on the "Delete Branch" button
Synchronize your local repository
<pre>
git checkout master
git pull
</pre>

== Unpacking an existing package ==

The <tt>pkgtools</tt> package also contains a utility which can be used to unpack an existing package into a directory structure for editing or just for investigation, NOTE :- you need to install the gzip Custom Firmware package in order to use opkg-unpack

<pre>
humax# cd /mod/tmp
humax# opkg download webif
Downloading http://hummypkg.org.uk/hdrfoxt2/base/webif_0.6.4_mipsel.opk.
Downloaded webif as ./webif_0.6.4_mipsel.opk.
humax# opkg-unpack webif_0.6.4_mipsel.opk
Unpacked to webif_0.6.4_mipsel
</pre>

If you have a Debian-based Linux machine, opkg packages can be examined and manipulated using the dkpg-deb command.

wget http://hummypkg.org.uk/hdrfoxt2/base/busybox_1.19.3-3_mipsel.opk
dpkg-deb -x busybox_1.19.3-3_mipsel.opk <tmpdir>

== Packing and Unpacking Bundled Packages ==

An OPK file contains the executable program /s and all the set-up scripts required for a single Custom Firmware package, However this single package may require other packages to be present in order to work. An OPB file contains the main package and all the peripheral packages require for it to run in a single file, the OPK’s are tarred together to form this file and can be viewed as follows :-
<pre>
humax# /bin/untar multimode_0.0.1_mipsel.opb
Extracting from multimode_0.0.1_mipsel.opb
Extracting file multimode_0.0.1_mipsel.opk
Extracting file webif_0.8.9_mipsel.opk
Extracting file mongoose_3.0-6_mipsel.opk
Extracting file jim_0.71-1_mipsel.opk
Extracting file jim-sqlite3_0.71-1_mipsel.opk
Extracting file sqlite3_3.7.6_mipsel.opk
Extracting file jim-cgi_0.4-1_mipsel.opk
Extracting file jim-oo_0.71_mipsel.opk
Extracting file jim-pack_0.71_mipsel.opk
Extracting file service-control_1.0_mipsel.opk
Extracting file busybox_1.19.3-2_mipsel.opk
Extracting file lsof_4.82_mipsel.opk
Extracting file epg_1.0.8_mipsel.opk
Extracting file hmt_1.1.3_mipsel.opk
Extracting file ssmtp_2.64_mipsel.opk
Extracting file anacron_2.3-1_mipsel.opk
Extracting file cron-daemon_1.18.3-1_mipsel.opk
Extracting file rs_0.4.0_mipsel.opk
End of multimode_0.0.1_mipsel.opb
humax#

</pre>

File:Review Pull request.png

2020-03-11T16:12:01Z

MymsMan:

File:New Repository.png

2020-03-11T14:37:28Z

MymsMan:

Maintain packages with Git

2020-03-11T13:48:05Z

MymsMan: remove 'Draft' designation

[https://en.wikipedia.org/wiki/Git Git] is a distributed version-control system for tracking changes in source code during software development. It is designed for coordinating work among programmers, but it can be used to track changes in any set of files.

Some, but not all, packages developed for the Humax use Git to maintain the associated source code. This allows for better tracking and control of changes and, potentially, allows for multiple users to collaborate on maintaining the package by making and testing changes on a private copy of the package and then submitting them for review and incorporation into the main package for distribution to the Humax community via the normal package update mechanism.

This wiki page attempts to describe the basics required to submit a change to a package that you don't own using the ''webif'' package as an example. It was written by a naive new user of Git and does not attempt to cover all of Git / Github and may contain errors, please correct and update this page where needed!

Git repository = Storage location for a single humax package

== Initial setup ==
Install, using the normal Humax package install method, the following (may need to show Advanced packages):
* git
* pkgtools
* gzip
* A text editor, Joe, Nano, or Vim unless you are happy with the default Vi

Create a user account on the hummy package git repository site https://git.hpkg.tv/ userid should normally be the same as your forum id,
Optionally also create an id on the the public git repository [https://github.com github]

All commands shown should be issued from a command prompt (telnet, putty, or Command Line on webif Diagnostics page)

Create a directory to hold git repositories (do not use /mod directly to avoid conflicts with installed packages)
<pre>
md /mod/git
cd /mod/git
</pre>
Set up some defaults for Git based on your details and preferences. The credential.helper timeout will remember your password for 24 hours
<pre>
git config --global user.name "USERNAME"
git config --global user.email "EMAIL"
git config --global core.editor "editor"
git config --global credential.helper 'cache --timeout=86400'
</pre>
== Fork and clone reposiory ==
Sign in and find the package you want to work with on the host repository eg https://git.hpkg.tv/hummypkg/webif

If the package you are interested in is not visible on the website contact the package owner to discuss access.

Click on the Fork button (top right) and create a forked repository
(using a fork creates a private copy and insulates your changes from those on the master, it is not needed if you are the repository owner)
Copy the the HHTPS url for the forked repository, ensure you are in your git folder on the humax and paste it into a ''git clone'' command
<pre>
cd /mod/git
git clone https://git.hpkg.tv/USERNAME/webif.git
</pre>
Change to your repository directory and add the master repository as another remote - this enables you to pick up changes made to the master
<pre>
cd /mod/git/webif
git remote add upstream https://git.hpkg.tv/hummypkg/webif.git
</pre>
You now have two remotes for this project on disk:
# origin which points to your fork of the project. You can read and write to this remote.
# upstream which points to the main project’s repository. You can only read from this remote.

== Sync with master ==
You don't need this step if you have just forked and cloned the master, but if time has elapsed and master may have changed you can pull in the latest changes and push them up to your host repository
<pre>
cd /mod/git/webif
git checkout master
git pull upstream master
git push origin master
</pre>
== Create a Branch ==
Every related set of changes should be in its own branch, don't try and fix unrelated problems in the same branch.
Branch names should be meaningful.
<pre>
cd /mod/git/webif
git checkout -b FixBrowseTypo
git push -u origin FixBrowseTypo
</pre>
The -b flag is only needed for a new branch, not when switching to existing branch

== Make your updates ==
Using your favourite text editor make the necessary changes to the code.
== Package, Install and test fixes ==
For simple changes you may be able to test the changes in isolation without needing to package and install for each update but to fully test using the webif it is best to properly package and install your changes.
Update CONTROL/control for the package to update the version number, check the dependencies section if your changes depend on new or updated packages (or remove existing dependencies). See the "[[Create Packages]]" page for more information on the control file structure.
Create package .opk file and install it (vers#) is the number from the control file
<pre>
cd /mod/git
opkg-pack webif
opkg install webif_vers#_mipsel.opk
</pre>
If the opkg-pack fails with 'Resource temporarily unavailable' messages try again - it seems to resolve itself after a few goes.
Test to ensure your changes are working as intended.
== Commit your changes ==
Committing saves your updates in the local Git repository and allows you to revert to any previous commit point should you need to back out a change, for a small change you may only need to commit once but for larger changes you can split your work into logical chunks and commit each piece. Pushing then syncs your remote repository with the changes from your local repository.

Before committing Git needs to know which of the changes you have made in the repository folder are to be included in the commit, this is known as staging and can be done in several ways.

To add a file to the next commit
<pre>
git add file.name
</pre>
To add all changed files to the next commit
<pre>
git add .
</pre>
To see the current status, very useful for checking what will / won't be committed
<pre>
git status
</pre>
To discard changes to a file
<pre>
git checkout -- file.name
</pre>
To commit all changed files use the -a flag on the commit command (alternative to ''git add .''), if the -m flag is omitted it will open an editor window for you to type a commit message
<pre>
git commit -a -m "Summary of the changes"
</pre>
=== Omit CONTROL/control from commits ===
When different branches have changes to the same file Git can normally automatically merge the changes provided they don't affect the same lines of the file when you have to resolve the conflicts and decide which version to keep, not hard but extra work for the package owner.
Changes to the package version number obviously all affect the same line of the control file and will cause conflicts if several changes are to be combined into one update of the Humax package.
So unless you have made other changes (e.g. Dependencies) I suggest that you backout changes to the control file before committing.
<pre>
git checkout -- CONTROL/control
</pre>
== Create a Pull Request ==
A ''Pull Request'' is a request to the package owner to merge your changes into the Master repository and update the Humax package.
The New Pull Request button appears in a number of places on the remote repository pages under the Branches or Pull Requests tabs.

Ensure you specify the master branch of the master repository as the target for merge into and your branch to pull from
[[File:PullRequest.png|frame|centre|Creating a Pull Request]]

The title and description of the Pull Request should explain to the package owner why your changes should be included in the package.
Assign the request to the owner in the assignee tab (on the right of the page)

The owner will review your changes and may request changes which should be made and committed on the same branch (a new Pull request is '''not''' needed)

When happy with the changes the owner will merge the branch into master and close the Pull Request, the branch can be deleted and you can start again at the [[Maintain_packages_with_Git|Sync with master]] step
== Further Information ==
This page only scratches the surface of Git and there are numerous reference works and tutorials on github and elsewhere on the web. A few links that have helped me are:
* [https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/ The beginners guide to contributing to a github project]
* [http://www.bioinf.org.uk/teaching/bbk/biocomp2/git/git.pdf An introduction to Git and GitHub]
* [https://www.atlassian.com/git/tutorials Git Tutorials]

Maintain packages with Git

2020-03-11T13:36:09Z

MymsMan: /* Fork and clone reposiory */

'''Draft'''
[https://en.wikipedia.org/wiki/Git Git] is a distributed version-control system for tracking changes in source code during software development. It is designed for coordinating work among programmers, but it can be used to track changes in any set of files.

Some, but not all, packages developed for the Humax use Git to maintain the associated source code. This allows for better tracking and control of changes and, potentially, allows for multiple users to collaborate on maintaining the package by making and testing changes on a private copy of the package and then submitting them for review and incorporation into the main package for distribution to the Humax community via the normal package update mechanism.

This wiki page attempts to describe the basics required to submit a change to a package that you don't own using the ''webif'' package as an example. It was written by a naive new user of Git and does not attempt to cover all of Git / Github and may contain errors, please correct and update this page where needed!

Git repository = Storage location for a single humax package

== Initial setup ==
Install, using the normal Humax package install method, the following (may need to show Advanced packages):
* git
* pkgtools
* A text editor, Joe, Nano, or Vim unless you are happy with the default Vi

Create a user account on the hummy package git repository site https://git.hpkg.tv/ userid should normally be the same as your forum id,
Optionally also create an id on the the public git repository [https://github.com github]

All commands shown should be issued from a command prompt (telnet, putty, or Command Line on webif Diagnostics page)

Create a directory to hold git repositories (do not use /mod directly to avoid conflicts with installed packages)
<pre>
md /mod/git
cd /mod/git
</pre>
Set up some defaults for Git based on your details and preferences. The credential.helper timeout will remember your password for 24 hours
<pre>
git config --global user.name "USERNAME"
git config --global user.email "EMAIL"
git config --global core.editor "editor"
git config --global credential.helper 'cache --timeout=86400'
</pre>
== Fork and clone reposiory ==
Sign in and find the package you want to work with on the host repository eg https://git.hpkg.tv/hummypkg/webif

If the package you are interested in is not visible on the website contact the package owner to discuss access.

Click on the Fork button (top right) and create a forked repository
(using a fork creates a private copy and insulates your changes from those on the master, it is not needed if you are the repository owner)
Copy the the HHTPS url for the forked repository, ensure you are in your git folder on the humax and paste it into a ''git clone'' command
<pre>
cd /mod/git
git clone https://git.hpkg.tv/USERNAME/webif.git
</pre>
Change to your repository directory and add the master repository as another remote - this enables you to pick up changes made to the master
<pre>
cd /mod/git/webif
git remote add upstream https://git.hpkg.tv/hummypkg/webif.git
</pre>
You now have two remotes for this project on disk:
# origin which points to your fork of the project. You can read and write to this remote.
# upstream which points to the main project’s repository. You can only read from this remote.

== Sync with master ==
You don't need this step if you have just forked and cloned the master, but if time has elapsed and master may have changed you can pull in the latest changes and push them up to your host repository
<pre>
cd /mod/git/webif
git checkout master
git pull upstream master
git push origin master
</pre>
== Create a Branch ==
Every related set of changes should be in its own branch, don't try and fix unrelated problems in the same branch.
Branch names should be meaningful.
<pre>
cd /mod/git/webif
git checkout -b FixBrowseTypo
git push -u origin FixBrowseTypo
</pre>
The -b flag is only needed for a new branch, not when switching to existing branch

== Make your updates ==
Using your favourite text editor make the necessary changes to the code.
== Package, Install and test fixes ==
For simple changes you may be able to test the changes in isolation without needing to package and install for each update but to fully test using the webif it is best to properly package and install your changes.
Update CONTROL/control for the package to update the version number, check the dependencies section if your changes depend on new or updated packages (or remove existing dependencies). See the "[[Create Packages]]" page for more information on the control file structure.
Create package .opk file and install it (vers#) is the number from the control file
<pre>
cd /mod/git
opkg-pack webif
opkg install webif_vers#_mipsel.opk
</pre>
If the opkg-pack fails with 'Resource temporarily unavailable' messages try again - it seems to resolve itself after a few goes.
Test to ensure your changes are working as intended.
== Commit your changes ==
Committing saves your updates in the local Git repository and allows you to revert to any previous commit point should you need to back out a change, for a small change you may only need to commit once but for larger changes you can split your work into logical chunks and commit each piece. Pushing then syncs your remote repository with the changes from your local repository.

Before committing Git needs to know which of the changes you have made in the repository folder are to be included in the commit, this is known as staging and can be done in several ways.

To add a file to the next commit
<pre>
git add file.name
</pre>
To add all changed files to the next commit
<pre>
git add .
</pre>
To see the current status, very useful for checking what will / won't be committed
<pre>
git status
</pre>
To discard changes to a file
<pre>
git checkout -- file.name
</pre>
To commit all changed files use the -a flag on the commit command (alternative to ''git add .''), if the -m flag is omitted it will open an editor window for you to type a commit message
<pre>
git commit -a -m "Summary of the changes"
</pre>
=== Omit CONTROL/control from commits ===
When different branches have changes to the same file Git can normally automatically merge the changes provided they don't affect the same lines of the file when you have to resolve the conflicts and decide which version to keep, not hard but extra work for the package owner.
Changes to the package version number obviously all affect the same line of the control file and will cause conflicts if several changes are to be combined into one update of the Humax package.
So unless you have made other changes (e.g. Dependencies) I suggest that you backout changes to the control file before committing.
<pre>
git checkout -- CONTROL/control
</pre>
== Create a Pull Request ==
A ''Pull Request'' is a request to the package owner to merge your changes into the Master repository and update the Humax package.
The New Pull Request button appears in a number of places on the remote repository pages under the Branches or Pull Requests tabs.

Ensure you specify the master branch of the master repository as the target for merge into and your branch to pull from
[[File:PullRequest.png|frame|centre|Creating a Pull Request]]

The title and description of the Pull Request should explain to the package owner why your changes should be included in the package.
Assign the request to the owner in the assignee tab (on the right of the page)

The owner will review your changes and may request changes which should be made and committed on the same branch (a new Pull request is '''not''' needed)

When happy with the changes the owner will merge the branch into master and close the Pull Request, the branch can be deleted and you can start again at the [[Maintain_packages_with_Git|Sync with master]] step
== Further Information ==
This page only scratches the surface of Git and there are numerous reference works and tutorials on github and elsewhere on the web. A few links that have helped me are:
* [https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/ The beginners guide to contributing to a github project]
* [http://www.bioinf.org.uk/teaching/bbk/biocomp2/git/git.pdf An introduction to Git and GitHub]
* [https://www.atlassian.com/git/tutorials Git Tutorials]

Maintain packages with Git

2020-03-11T13:35:11Z

MymsMan: /* Fork and clone reposiory */

'''Draft'''
[https://en.wikipedia.org/wiki/Git Git] is a distributed version-control system for tracking changes in source code during software development. It is designed for coordinating work among programmers, but it can be used to track changes in any set of files.

Some, but not all, packages developed for the Humax use Git to maintain the associated source code. This allows for better tracking and control of changes and, potentially, allows for multiple users to collaborate on maintaining the package by making and testing changes on a private copy of the package and then submitting them for review and incorporation into the main package for distribution to the Humax community via the normal package update mechanism.

This wiki page attempts to describe the basics required to submit a change to a package that you don't own using the ''webif'' package as an example. It was written by a naive new user of Git and does not attempt to cover all of Git / Github and may contain errors, please correct and update this page where needed!

Git repository = Storage location for a single humax package

== Initial setup ==
Install, using the normal Humax package install method, the following (may need to show Advanced packages):
* git
* pkgtools
* A text editor, Joe, Nano, or Vim unless you are happy with the default Vi

Create a user account on the hummy package git repository site https://git.hpkg.tv/ userid should normally be the same as your forum id,
Optionally also create an id on the the public git repository [https://github.com github]

All commands shown should be issued from a command prompt (telnet, putty, or Command Line on webif Diagnostics page)

Create a directory to hold git repositories (do not use /mod directly to avoid conflicts with installed packages)
<pre>
md /mod/git
cd /mod/git
</pre>
Set up some defaults for Git based on your details and preferences. The credential.helper timeout will remember your password for 24 hours
<pre>
git config --global user.name "USERNAME"
git config --global user.email "EMAIL"
git config --global core.editor "editor"
git config --global credential.helper 'cache --timeout=86400'
</pre>
== Fork and clone reposiory ==
Sign in and find the package you want to work with on the host repository eg https://git.hpkg.tv/hummypkg/webif

If the package you are interested in is not visible on the website contact the package owner to discuss access.

Click on the Fork button (top right) and create a forked repository
(using a fork creates a private copy and insulates your changes from those on the master, it is not needed if you are the repository owner)
Copy the the HHTPS url for the forked repository, ensure you are in your git folder on the humax and paste it into a ''git clone'' command
<pre>
cd /mod/git
git clone https://git.hpkg.tv/USERNAME/webif.git
</pre>
Change to our repository directory and add the master repository as another remote - this enables you to pick up changes made to the master
<pre>
cd /mod/git/webif
git remote add upstream https://git.hpkg.tv/hummypkg/webif.git
</pre>
You now have two remotes for this project on disk:
# origin which points to your fork of the project. You can read and write to this remote.
# upstream which points to the main project’s repository. You can only read from this remote.

== Sync with master ==
You don't need this step if you have just forked and cloned the master, but if time has elapsed and master may have changed you can pull in the latest changes and push them up to your host repository
<pre>
cd /mod/git/webif
git checkout master
git pull upstream master
git push origin master
</pre>
== Create a Branch ==
Every related set of changes should be in its own branch, don't try and fix unrelated problems in the same branch.
Branch names should be meaningful.
<pre>
cd /mod/git/webif
git checkout -b FixBrowseTypo
git push -u origin FixBrowseTypo
</pre>
The -b flag is only needed for a new branch, not when switching to existing branch

== Make your updates ==
Using your favourite text editor make the necessary changes to the code.
== Package, Install and test fixes ==
For simple changes you may be able to test the changes in isolation without needing to package and install for each update but to fully test using the webif it is best to properly package and install your changes.
Update CONTROL/control for the package to update the version number, check the dependencies section if your changes depend on new or updated packages (or remove existing dependencies). See the "[[Create Packages]]" page for more information on the control file structure.
Create package .opk file and install it (vers#) is the number from the control file
<pre>
cd /mod/git
opkg-pack webif
opkg install webif_vers#_mipsel.opk
</pre>
If the opkg-pack fails with 'Resource temporarily unavailable' messages try again - it seems to resolve itself after a few goes.
Test to ensure your changes are working as intended.
== Commit your changes ==
Committing saves your updates in the local Git repository and allows you to revert to any previous commit point should you need to back out a change, for a small change you may only need to commit once but for larger changes you can split your work into logical chunks and commit each piece. Pushing then syncs your remote repository with the changes from your local repository.

Before committing Git needs to know which of the changes you have made in the repository folder are to be included in the commit, this is known as staging and can be done in several ways.

To add a file to the next commit
<pre>
git add file.name
</pre>
To add all changed files to the next commit
<pre>
git add .
</pre>
To see the current status, very useful for checking what will / won't be committed
<pre>
git status
</pre>
To discard changes to a file
<pre>
git checkout -- file.name
</pre>
To commit all changed files use the -a flag on the commit command (alternative to ''git add .''), if the -m flag is omitted it will open an editor window for you to type a commit message
<pre>
git commit -a -m "Summary of the changes"
</pre>
=== Omit CONTROL/control from commits ===
When different branches have changes to the same file Git can normally automatically merge the changes provided they don't affect the same lines of the file when you have to resolve the conflicts and decide which version to keep, not hard but extra work for the package owner.
Changes to the package version number obviously all affect the same line of the control file and will cause conflicts if several changes are to be combined into one update of the Humax package.
So unless you have made other changes (e.g. Dependencies) I suggest that you backout changes to the control file before committing.
<pre>
git checkout -- CONTROL/control
</pre>
== Create a Pull Request ==
A ''Pull Request'' is a request to the package owner to merge your changes into the Master repository and update the Humax package.
The New Pull Request button appears in a number of places on the remote repository pages under the Branches or Pull Requests tabs.

Ensure you specify the master branch of the master repository as the target for merge into and your branch to pull from
[[File:PullRequest.png|frame|centre|Creating a Pull Request]]

The title and description of the Pull Request should explain to the package owner why your changes should be included in the package.
Assign the request to the owner in the assignee tab (on the right of the page)

The owner will review your changes and may request changes which should be made and committed on the same branch (a new Pull request is '''not''' needed)

When happy with the changes the owner will merge the branch into master and close the Pull Request, the branch can be deleted and you can start again at the [[Maintain_packages_with_Git|Sync with master]] step
== Further Information ==
This page only scratches the surface of Git and there are numerous reference works and tutorials on github and elsewhere on the web. A few links that have helped me are:
* [https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/ The beginners guide to contributing to a github project]
* [http://www.bioinf.org.uk/teaching/bbk/biocomp2/git/git.pdf An introduction to Git and GitHub]
* [https://www.atlassian.com/git/tutorials Git Tutorials]

Maintain packages with Git

2020-03-11T13:33:58Z

MymsMan: add not visible comment

'''Draft'''
[https://en.wikipedia.org/wiki/Git Git] is a distributed version-control system for tracking changes in source code during software development. It is designed for coordinating work among programmers, but it can be used to track changes in any set of files.

Some, but not all, packages developed for the Humax use Git to maintain the associated source code. This allows for better tracking and control of changes and, potentially, allows for multiple users to collaborate on maintaining the package by making and testing changes on a private copy of the package and then submitting them for review and incorporation into the main package for distribution to the Humax community via the normal package update mechanism.

This wiki page attempts to describe the basics required to submit a change to a package that you don't own using the ''webif'' package as an example. It was written by a naive new user of Git and does not attempt to cover all of Git / Github and may contain errors, please correct and update this page where needed!

Git repository = Storage location for a single humax package

== Initial setup ==
Install, using the normal Humax package install method, the following (may need to show Advanced packages):
* git
* pkgtools
* A text editor, Joe, Nano, or Vim unless you are happy with the default Vi

Create a user account on the hummy package git repository site https://git.hpkg.tv/ userid should normally be the same as your forum id,
Optionally also create an id on the the public git repository [https://github.com github]

All commands shown should be issued from a command prompt (telnet, putty, or Command Line on webif Diagnostics page)

Create a directory to hold git repositories (do not use /mod directly to avoid conflicts with installed packages)
<pre>
md /mod/git
cd /mod/git
</pre>
Set up some defaults for Git based on your details and preferences. The credential.helper timeout will remember your password for 24 hours
<pre>
git config --global user.name "USERNAME"
git config --global user.email "EMAIL"
git config --global core.editor "editor"
git config --global credential.helper 'cache --timeout=86400'
</pre>
== Fork and clone reposiory ==
Sign in and find the package you want to work with on the host repository eg https://git.hpkg.tv/hummypkg/webif
If the package you are interested in is not visible in the repository contact the package owner to discuss access.

Click on the Fork button (top right) and create a forked repository
(using a fork creates a private copy and insulates your changes from those on the master, it is not needed if you are the repository owner)
Copy the the HHTPS url for the forked repository, ensure you are in your git folder on the humax and paste it into a ''git clone'' command
<pre>
cd /mod/git
git clone https://git.hpkg.tv/USERNAME/webif.git
</pre>
Change to our repository directory and add the master repository as another remote - this enables you to pick up changes made to the master
<pre>
cd /mod/git/webif
git remote add upstream https://git.hpkg.tv/hummypkg/webif.git
</pre>
You now have two remotes for this project on disk:
# origin which points to your fork of the project. You can read and write to this remote.
# upstream which points to the main project’s repository. You can only read from this remote.
== Sync with master ==
You don't need this step if you have just forked and cloned the master, but if time has elapsed and master may have changed you can pull in the latest changes and push them up to your host repository
<pre>
cd /mod/git/webif
git checkout master
git pull upstream master
git push origin master
</pre>
== Create a Branch ==
Every related set of changes should be in its own branch, don't try and fix unrelated problems in the same branch.
Branch names should be meaningful.
<pre>
cd /mod/git/webif
git checkout -b FixBrowseTypo
git push -u origin FixBrowseTypo
</pre>
The -b flag is only needed for a new branch, not when switching to existing branch

== Make your updates ==
Using your favourite text editor make the necessary changes to the code.
== Package, Install and test fixes ==
For simple changes you may be able to test the changes in isolation without needing to package and install for each update but to fully test using the webif it is best to properly package and install your changes.
Update CONTROL/control for the package to update the version number, check the dependencies section if your changes depend on new or updated packages (or remove existing dependencies). See the "[[Create Packages]]" page for more information on the control file structure.
Create package .opk file and install it (vers#) is the number from the control file
<pre>
cd /mod/git
opkg-pack webif
opkg install webif_vers#_mipsel.opk
</pre>
If the opkg-pack fails with 'Resource temporarily unavailable' messages try again - it seems to resolve itself after a few goes.
Test to ensure your changes are working as intended.
== Commit your changes ==
Committing saves your updates in the local Git repository and allows you to revert to any previous commit point should you need to back out a change, for a small change you may only need to commit once but for larger changes you can split your work into logical chunks and commit each piece. Pushing then syncs your remote repository with the changes from your local repository.

Before committing Git needs to know which of the changes you have made in the repository folder are to be included in the commit, this is known as staging and can be done in several ways.

To add a file to the next commit
<pre>
git add file.name
</pre>
To add all changed files to the next commit
<pre>
git add .
</pre>
To see the current status, very useful for checking what will / won't be committed
<pre>
git status
</pre>
To discard changes to a file
<pre>
git checkout -- file.name
</pre>
To commit all changed files use the -a flag on the commit command (alternative to ''git add .''), if the -m flag is omitted it will open an editor window for you to type a commit message
<pre>
git commit -a -m "Summary of the changes"
</pre>
=== Omit CONTROL/control from commits ===
When different branches have changes to the same file Git can normally automatically merge the changes provided they don't affect the same lines of the file when you have to resolve the conflicts and decide which version to keep, not hard but extra work for the package owner.
Changes to the package version number obviously all affect the same line of the control file and will cause conflicts if several changes are to be combined into one update of the Humax package.
So unless you have made other changes (e.g. Dependencies) I suggest that you backout changes to the control file before committing.
<pre>
git checkout -- CONTROL/control
</pre>
== Create a Pull Request ==
A ''Pull Request'' is a request to the package owner to merge your changes into the Master repository and update the Humax package.
The New Pull Request button appears in a number of places on the remote repository pages under the Branches or Pull Requests tabs.

Ensure you specify the master branch of the master repository as the target for merge into and your branch to pull from
[[File:PullRequest.png|frame|centre|Creating a Pull Request]]

The title and description of the Pull Request should explain to the package owner why your changes should be included in the package.
Assign the request to the owner in the assignee tab (on the right of the page)

The owner will review your changes and may request changes which should be made and committed on the same branch (a new Pull request is '''not''' needed)

When happy with the changes the owner will merge the branch into master and close the Pull Request, the branch can be deleted and you can start again at the [[Maintain_packages_with_Git|Sync with master]] step
== Further Information ==
This page only scratches the surface of Git and there are numerous reference works and tutorials on github and elsewhere on the web. A few links that have helped me are:
* [https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/ The beginners guide to contributing to a github project]
* [http://www.bioinf.org.uk/teaching/bbk/biocomp2/git/git.pdf An introduction to Git and GitHub]
* [https://www.atlassian.com/git/tutorials Git Tutorials]