Pixel FX Wiki

Morph 4K: Difference between revisions

← Older edit
Introduced the following sections: On-Screen Display (OSD) Main Menu and Submenus / WiFi Setup Wizard
m Fixed references to "PixelFX" as "Pixel FX"
 
(4 intermediate revisions by the same user not shown)
Line 3: Line 3:
== Introduction ==
== Introduction ==
[[File:Morph_4K_Front.png|400px|right]]
[[File:Morph_4K_Front.png|400px|right]]
PixelFX Morph 4K is an advanced, modular scaling solution based around a powerful FPGA architecture. The device has been designed to bring powerful, flexible 4K scaling tailored for video game material to users at an affordable cost.  
Pixel FX Morph 4K is an advanced, modular scaling solution based around a powerful FPGA architecture. The device has been designed to bring powerful, flexible 4K scaling tailored for video game material to users at an affordable cost.  


By being modular in design, the unit can be customized to a users exact needs and setup, therefore saving the end user considerable expense. The base unit has one HDMI input.  Expansion modules allow the device to accept various analog signals too.
By being modular in design, the unit can be customized to a users exact needs and setup, therefore saving the end user considerable expense. The base unit has one HDMI input.  Expansion modules allow the device to accept various analog signals too.
Line 37: Line 37:
=== More information & discussion ===
=== More information & discussion ===


* [https://docs.pixelfx.co/ PixelFX Documentation]
* [https://docs.pixelfx.co/ Pixel FX Documentation]
* [https://discord.com/channels/1101136714916962364/1167441958638202960 Discord chat room]
* [https://discord.com/channels/1101136714916962364/1167441958638202960 Discord chat room]
* [https://videogameperfection.com/forums/forum/pixelfx-products/morph-4k/ VGP hosted discussion forum]
* [https://videogameperfection.com/forums/forum/pixelfx-products/morph-4k/ VGP hosted discussion forum]
Line 148: Line 148:
Port B contains Component w/ 3.5mm audio that includes:
Port B contains Component w/ 3.5mm audio that includes:


* Formats RGsB, RGB, YPbPr, Composite Video, S-Video
* Formats RGBS, RGsB, RGB, YPbPr, Composite Video, S-Video
* Green support CVBS (shared with S-Video Port)
* Green support CVBS (shared with S-Video Port)
* Green/Red Pins support S-Video (shared with S-Video Port)
* Green/Red Pins support S-Video (shared with S-Video Port)
Line 160: Line 160:


* ​Formats RGBHV, RGBs, RGsB, YPbPr, Composite Video, S-Video
* ​Formats RGBHV, RGBs, RGsB, YPbPr, Composite Video, S-Video
* Green/HSync Pin support CVBS
* Green/HSYNC Pin support CVBS
* Green/Red Pins support S-Video
* Green/Red Pins support S-Video
* Sync types accepted: TTL Csync, Attenuated Csync, Composite Video Sync, Luma, TTL
* Sync types accepted: TTL Csync, Attenuated Csync, Composite Video Sync, Luma, TTL
Line 168: Line 168:
Port B contains Component w/ 3.5mm audio that includes:
Port B contains Component w/ 3.5mm audio that includes:
​
​
* Formats RGsB, RGB, YPbPr, Composite Video, S-Video
* Formats RGBS, RGsB, RGB, YPbPr, Composite Video, S-Video
* Green supports CVBS (shared with S-Video Port)
* Green supports CVBS (shared with S-Video Port)
* Green/Red support S-Video (shared with S-Video Port)
* Green/Red support S-Video (shared with S-Video Port)
Line 178: Line 178:


* Formats RGBHV, RGBs, RGsB, YPbPr, Composite Video, S-Video
* Formats RGBHV, RGBs, RGsB, YPbPr, Composite Video, S-Video
* Green/HSync Pin support CVBS
* Green/HSYNC Pin support CVBS
* Green/Red Pins support S-Video
* Green/Red Pins support S-Video
* Sync types accepted: TTL Csync, Attenuated Csync, Composite Video Sync, Luma, TTL
* Sync types accepted: TTL Csync, Attenuated Csync, Composite Video Sync, Luma, TTL
Line 258: Line 258:
To connect using a HDMI upgrade, HDMI adapter or secondary scaler, use the adapters "pass-though" or "digitization only" mode if one is available. If no passthrough mode is available, choose the lowest output resolution offered by the adapter/scaler and then use the "Prescale" options under the "Scaler" menu on the Morph to effectively undo any scaling the adapter applies.  
To connect using a HDMI upgrade, HDMI adapter or secondary scaler, use the adapters "pass-though" or "digitization only" mode if one is available. If no passthrough mode is available, choose the lowest output resolution offered by the adapter/scaler and then use the "Prescale" options under the "Scaler" menu on the Morph to effectively undo any scaling the adapter applies.  


For specific considerations for each system, see [[Morph_4K#Compatibility_and_Special_Configuration|Compatibility and special configuration]]  
For specific considerations for each system, see [[Morph_4K_System_Compatibility|Morph 4K System Compatibility]]  


'''What can the Morph do for Pre-HDMI consoles and computers?''' These machines were typically designed for older displays (especially sixth generation and earlier systems). Morph 4K can properly scale and process these systems and add CRT effects such as scanlines, to make them look as pleasing as they did on legacy CRT displays. For systems which output interlace video (e.g PS2) Morph 4K has a fast, motion adaptive deinterlacer that is optimised for video game content.
'''What can the Morph do for Pre-HDMI consoles and computers?''' These machines were typically designed for older displays (especially sixth generation and earlier systems). Morph 4K can properly scale and process these systems and add CRT effects such as scanlines, to make them look as pleasing as they did on legacy CRT displays. For systems which output interlace video (e.g PS2) Morph 4K has a fast, motion adaptive deinterlacer that is optimised for video game content.
Line 339: Line 339:
=== Presets ===
=== Presets ===


The Presets menu is found at the top of the main menu.  Presets act as profiles for Morph 4K.  This menu can be used to create profiles, manually load profiles, automatically load profiles, and stay up-to-date with a network archive of community made profiles.
The Presets menu is found at the top of the main menu.  Presets act as the identity profile to apply Morph 4K settings based upon input sources and other conditions.  This menu can be used to create profile presets, manually load profile presets, automatically load profile presets, and keep the [[Morph_4K#MicroSD_Port|microSD]] card up-to-date with the preset archive.


By default, you can add mask and color profiles in the <code>.ini</code> or <code>.txt</code> file extension to Morph from your PC by manually placing them on the [[Morph_4K#MicroSD_Port|microSD]] card in the '''presets''' subfolder visible in the file explorer or [[Morph_4K#SD_Card_.2F_Presets|through the SD Card / Presets manager in the WebUI]] by placing them in the ''/sdcard/presets'' directory.
By default, you can add mask presets and color correction profile presets in the <code>.ini</code> or <code>.txt</code> file extension to Morph from your PC by manually placing them on the microSD card in the '''presets''' subfolder visible in the file explorer or through the [[Morph_4K#SD_Card_.2F_Presets|SD Card / Presets manager in the WebUI]] by placing them in the ''/sdcard/presets'' directory.


You can also download the latest preset archive of community made profiles directly to Morph with a WiFi connection.  This archive will automatically store on the [[Morph_4K#MicroSD_Port|microSD card]].
From the Preset menu, you have the option to download the latest [https://github.com/pixel-fx/morph4k-presets preset archive] of community profile presets, [[Morph_4K#Retro_FX|mask presets]], and [[Morph_4K#Color_Correction|color correction profile presets]] directly to Morph with a WiFi connection via '''Install/update from presets archive'''.  This archive will automatically store on the [[Morph_4K#MicroSD_Port|microSD card]] and will only overwrite profile presets with matching names and folder paths.


[https://docs.pixelfx.co/Morph4K-Preset-Autoload-cascaded.html Presets can also automatically load based on detection of CEC, Game ID, Mode, and SPD.]*  All of these appear under the ''/sdcard/presets/Auto'' folder in the following structure:
Since many consoles with analog outputs have multiple resolutions and switch between interlaced and progressive scan (e.g. 240p/480i), Morph's profile presets decimate and shift the horizontal and vertical lines from the analog signal before Morph upscales it for the display.  Whereas for consoles with built-in HDMI, they can send a uniform digital signal to Morph with little to no adjustments.  In special circumstances, consoles with built-in HDMI may require a profile preset to assist with downscaling their digital signal before Morph upscales it (e.g. Analogue Pocket in Integer mode or Nintendo Classics on NSO).  However, there are no profile presets in the archive that apply to Retro GEM (or xDigital) since the device is already equipped to send a raw digital signal via direct modes (DV1-Direct / DV1-Passthru / FX-Direct).  Direct video is also available on MiSTer FPGA via HDMI (direct_video=1) and it's advised to apply this mode when connecting a MiSTer to Morph.  In the event MiSTer in DV1 has issues with HDMI switches into Morph, then consider the MiSTer 1080p prescale profile presets as a backup option.
 
Also, profile presets are capable of [https://docs.pixelfx.co/Morph4K-Preset-Autoload-cascaded.html automatically loading] based on detection of CEC, Game ID, Mode, and SPD.*  All of these appear under the ''/sdcard/presets/Auto'' folder in the following structure:


* '''/By_CEC*''' - For consoles or devices that communicate over CEC protocol (''such as Nintendo Switch's Match TV Power State option'')
* '''/By_CEC*''' - For consoles or devices that communicate over CEC protocol (''such as Nintendo Switch's Match TV Power State option'')
Line 401: Line 403:


* '''Composite Video over GREEN''' ''(CVBS green)''
* '''Composite Video over GREEN''' ''(CVBS green)''
* '''Composite Video over HSYNC''' ''(CVBS hsync)''
* '''Composite Video over HSYNC''' ''(CVBS hysnc)''
* '''S-Video'''
* '''S-Video'''
* '''Component (YPbPr)''' ''(YCbCr)''
* '''Component (YPbPr)''' ''(YCbCr)''
* '''RGB-HV (separate sync)''' ''(RGBHV)''
* '''RGB(HV/S) (TTL sync levels)''' ''(RGB TTL)''
* '''RGB-S (composite sync)''' ''(RGBS)''
* '''RGB(S) (75 ohm sync levels)''' ''(RGB 75)''
* '''RGsB (sync on green)''' ''(RGsB)''
* '''RGsB (sync on green)''' ''(RGsB)''


Line 424: Line 426:
|-
|-
|'''422 Interp.'''
|'''422 Interp.'''
|For HDMI sources with 4:2:2 chroma subsampling, turn this option on.  Otherwise, leave it off.
|For HDMI sources with 4:2:2 chroma subsampling, turn this option '''on'''.  Otherwise, leave it '''off'''.
|-
|-
|'''Metadata adjust''' <br> '''- DE left + right''' <br> ''' - DE top + bottom''' <br> ''' - Horiz. Prescale''' <br> ''' - Vert. Prescale'''
|'''Metadata adjust''' <br> '''- DE left + right''' <br> ''' - DE top + bottom''' <br> ''' - Horiz. Prescale''' <br> ''' - Vert. Prescale'''
Line 430: Line 432:
|-
|-
|'''DV1/FXD'''
|'''DV1/FXD'''
|For detecting DV1 or FXD input from HDMI sources that support it, turn this option on.  If neither DV1 or FXD will be used on the HDMI input source, then turn it off.
|For detecting DV1 or FXD input from HDMI sources that support it, turn this option '''on'''.  If neither DV1 or FXD will be used on the HDMI input source, then turn it '''off'''.
|-
|-
|'''EDID'''
|'''EDID'''
Line 438: Line 440:


'''Port A or B Input Settings - Main'''
'''Port A or B Input Settings - Main'''
[[File:Morph_Port_B_Input_Settings_Main_Menu.png|thumb|300px|right|Example of the Port B Input Settings menu with values that are default (grey), new (yellow), saved (white)]]
[[File:Morph_Port_A_Input_Settings_Main_Menu.png|thumb|300px|right|Example of the Port A Input Settings menu with values that are default (grey), new (yellow), saved (white)]]


'''Note:''' ''All values appear grey by default.  When you change a value, it will appear yellow before clicking OK to save.  Once a value is changed and saved, it will appear white.''
'''Note:''' ''All values appear grey by default.  When you change a value, it will appear yellow before clicking OK to save.  Once a value is changed and saved, it will appear white.''
Line 466: Line 468:
|}
|}


'''Port A or B Input Settings - Color Submenu''' ''(for YCbCr, RGBHV, RGBS, RGsB input types)''
'''Port A or B Input Settings - Color Submenu''' ''(applies to YCbCr / RGB TTL / RGB 75 / RGsB)''
 
[[File:Morph_Port_A_Input_Settings_Color_Submenu.png|thumb|300px|right|Example of the Port A Color Submenu with Gain and ALC V-Filt-Coeff values that are saved (white) with the rest set to default (grey)]]
'''Note:''' ''All values appear grey by default.  When you change a value, it will appear yellow before clicking OK to save.  Once a value is changed and saved, it will appear white.''
'''Note:''' ''All values appear grey by default.  When you change a value, it will appear yellow before clicking OK to save.  Once a value is changed and saved, it will appear white.''


Line 481: Line 483:
|-
|-
|'''ALC V-Filt-Coeff'''
|'''ALC V-Filt-Coeff'''
|For adjusting the adaptive loop coefficient (ALC) vertical filter when encountering uneven brightness for certain analog sources.  By default, this is set to 1/512, yet can be adjusted to: '''1''', '''1/2''', '''1/4''', '''1/8''', '''1/16''', '''1/32''', '''1/64''', '''1/128''', '''1/256''', or '''1/1024'''.
|For adjusting the adaptive loop coefficient (ALC) vertical filter when encountering uneven brightness for certain analog sources.  By default, this is set to '''1/512''', yet can be adjusted to: '''1''', '''1/2''', '''1/4''', '''1/8''', '''1/16''', '''1/32''', '''1/64''', '''1/128''', '''1/256''', or '''1/1024'''.
|-
|-
|'''SOG LPF''' <br> '''- Threshold'''
|'''SOG LPF''' <br> '''- Threshold'''
Line 488: Line 490:
|'''SS Threshold'''
|'''SS Threshold'''
|For adjusting the sync slicer (SS) threshold to separate csync from SOG.  By default, the SS threshold is set to 68.  The value can be incremented by 1 using the left or right navigation or by 10 (coarse) using the '''<span style="color:#FFDB58">yellow</span>''' or '''<span style="color:blue">blue</span>''' shortcut buttons on the remote.
|For adjusting the sync slicer (SS) threshold to separate csync from SOG.  By default, the SS threshold is set to 68.  The value can be incremented by 1 using the left or right navigation or by 10 (coarse) using the '''<span style="color:#FFDB58">yellow</span>''' or '''<span style="color:blue">blue</span>''' shortcut buttons on the remote.
|-
|'''HPLL''' <br>  '''- Pre-Coast''' <br> '''- Post-Coast'''
|For adjusting the horizontal phase-locked loop (PLL) in special circumstances when the incoming HSYNC signal is missing or disrupted.  This is done with a coasting technique in which the PLL disregards the missing/disrupted HSYNC during the VSYNC pulse interval and instead generates anchored HSYNC pulses as a stopgap approach.  Pre-Coast is the period before a VSYNC pulse starts and Post-Coast is the period after the VSYNC pulse ends.  By default, Pre-Coast is set to '''1''' and Post-Coast is set to '''0'''.  Both values can be set as high as '''255'''.  The value can be incremented by 1 using the left or right navigation or by 10 (coarse) using the '''<span style="color:#FFDB58">yellow</span>''' or '''<span style="color:blue">blue</span>''' shortcut buttons on the remote.
|-
|'''Line Length Tol.'''
|For adjusting the line length tolerance's margin sensitivity in order to maintain HSYNC input stability.  By default, Line Length Tol. is set to '''6''', yet can be set as high as '''127'''.  The value can be incremented by 1 using the left or right navigation or by 10 (coarse) using the '''<span style="color:#FFDB58">yellow</span>''' or '''<span style="color:blue">blue</span>''' shortcut buttons on the remote.
|-
|-
|'''Clamp adjust'''
|'''Clamp adjust'''
Line 525: Line 533:
|-
|-
|'''Horiz. Interpolation'''
|'''Horiz. Interpolation'''
|For adjusting the sharpness of the horizontal scale.  Leaving this set to off applies a nearest neighbor interpolation.  Additional options available that are forms of bilinear: '''softer''', '''soft''', '''sharp''', '''sharper''', or '''sharper (alt)'''.
|For adjusting the sharpness of the horizontal scale.  Leaving this set to '''off''' applies a nearest neighbor interpolation.  Additional options available that are forms of bilinear: '''softer''', '''soft''', '''sharp''', '''sharper''', or '''sharper (alt)'''.
|-
|-
|'''Vert. Interpolation'''
|'''Vert. Interpolation'''
|For adjusting the sharpness of the vertical scale.  Leaving this set to off applies a nearest neighbor interpolation.  Additional options available that are forms of bilinear: '''softer''', '''soft''', '''sharp''', '''sharper''', or '''sharper (alt)'''.
|For adjusting the sharpness of the vertical scale.  Leaving this set to '''off''' applies a nearest neighbor interpolation.  Additional options available that are forms of bilinear: '''softer''', '''soft''', '''sharp''', '''sharper''', or '''sharper (alt)'''.
|-
|-
|'''Horiz. Prescale'''
|'''Horiz. Prescale'''
|For reducing the horizontal prescale factor starting from /1 all the way to /32. Can be used to correct bad scaling applied by the connected system. Known as "Input Decimation" on some other scalers.  By default, this is set to '''Auto'''.
|For reducing the horizontal prescale factor starting from '''/1''' all the way to '''/32'''. Can be used to correct bad scaling applied by the connected system. Known as "Input Decimation" on some other scalers.  By default, this is set to '''Auto'''.
|-
|-
|'''Vert. Prescale'''
|'''Vert. Prescale'''
|For reducing the vertical prescale factor starting from /1 all the way to /32. This is typically used with pre-scaled content or pixel art video games to create a more accurate scanline presentation.  By default, this is set to '''Auto'''.
|For reducing the vertical prescale factor starting from '''/1''' all the way to '''/32'''. This is typically used with pre-scaled content or pixel art video games to create a more accurate scanline presentation.  By default, this is set to '''Auto'''.
|-
|-
|}
|}
Line 610: Line 618:


==== Retro FX ====
==== Retro FX ====
 
[[File:Morph_Retro_FX_Menu.png|thumb|300px|right|Example of running (re)scan presets to detect all 611 masks newly added to the microSD from the [[Morph_4K#Presets|preset archive]] and allow them to be selectable]]
The Retro FX menu is where you apply scanlines and masks. Since Retro gaming consoles were designed around cathode ray tube (CRT) displays, Retro gaming video content looks more authentic (and therefore subjectively better) when presented with simulated picture effects that mimic the characteristics of these displays.
The Retro FX menu is where you apply scanlines and masks. Since Retro gaming consoles were designed around cathode ray tube (CRT) displays, Retro gaming video content looks more authentic (and therefore subjectively better) when presented with simulated picture effects that mimic the characteristics of these displays.


Line 644: Line 652:
|-
|-
|'''Color Profile'''
|'''Color Profile'''
|Use this to load a saved color correction profile from the microSD card.  Click right on the remote and select it under ''/sdcard/presets/Color Correction (CSC)''.  Then click OK to apply.
|Use this to load a saved color correction profile preset from the microSD card, either from the [[Morph_4K#Presets|preset archive]] or manually generated thru the [[Morph_4K#Web Interface|WebUI]].  Click right on the remote and select it under ''/sdcard/presets/Color Correction (CSC)''.  Then click OK to apply.
|-
|-
|'''Input Gamma''' <br> '''- Transfer Function''' <br> '''&nbsp;&nbsp; - Factor''' <br> ''' - Gain''' <br> ''' - Lift''' <br> '''- Bit Crush'''
|'''Input Gamma''' <br> '''- Transfer Function''' <br> '''&nbsp;&nbsp; - Factor''' <br> ''' - Gain''' <br> ''' - Lift''' <br> '''- Bit Crush'''
Line 725: Line 733:
|-
|-
|'''RX 422 Interp.'''
|'''RX 422 Interp.'''
|For HDMI sources with 4:2:2 chroma subsampling, turn this option on. Otherwise, leave it off.
|For HDMI sources with 4:2:2 chroma subsampling, turn this option '''on'''. Otherwise, leave it '''off'''.
|-
|-
|'''RX EDID'''
|'''RX EDID'''
Line 797: Line 805:
|-
|-
|'''Check for Update'''
|'''Check for Update'''
|Allows you to run a firmware version check against the PixelFX server on the selected update channel to compare the staged and installed firmware versions.  When these values are equal, then you will see the message "Firmware is up-to-date."  When these values are not equal, then you can click OK to check release notes for the version differences and either click back to exit or click OK to initiate a firmware update.  For the full list of steps to implement the firmware update, check out [[Morph_4K#Updating_via_WiFi|Updating via WiFi]].
|Allows you to run a firmware version check against the Pixel FX server on the selected update channel to compare the staged and installed firmware versions.  When these values are equal, then you will see the message "Firmware is up-to-date."  When these values are not equal, then you can click OK to check release notes for the version differences and either click back to exit or click OK to initiate a firmware update.  For the full list of steps to implement the firmware update, check out [[Morph_4K#Updating_via_WiFi|Updating via WiFi]].
|-
|-
|'''Update Firmware*****'''
|'''Update Firmware*****'''
|Allows you to stage and install the newest firmware update available from the PixelFX server based upon the selected update channel.  For the full list of steps to implement the firmware update, check out [[Morph_4K#Updating_via_WiFi|Updating via WiFi]].
|Allows you to stage and install the newest firmware update available from the Pixel FX server based upon the selected update channel.  For the full list of steps to implement the firmware update, check out [[Morph_4K#Updating_via_WiFi|Updating via WiFi]].
|-
|-
|'''Update Firmware from SD Card'''
|'''Update Firmware from SD Card'''
Line 811: Line 819:


'''*****''' ''As of the 3.9.x firmware, a microSD is always required to run Update Firmware.''
'''*****''' ''As of the 3.9.x firmware, a microSD is always required to run Update Firmware.''
[[File:Morph_Firmware_Check_for_Update.png|thumb|300px|right|Example of Check for Update screen after a version check verifies a new update is available on the PixelFX server for the stable channel]]
[[File:Morph_Firmware_Check_for_Update.png|thumb|300px|right|Example of Check for Update screen after a version check verifies a new update is available on the Pixel FX server for the stable channel]]
==== OSD ====
==== OSD ====


Line 887: Line 895:
|-
|-
|'''Write debug log******'''
|'''Write debug log******'''
|Allows you to write a debug log file called ''debug.txt'' to the root directory of the [[Morph_4K#MicroSD_Port|microSD]] card. This is useful in the event you encounter a problem or issue using your Morph and need to share your debug log with PixelFX.  By default, this is set to off and can be changed to '''yes (overwrite)''' to write over the file on each power cycle or '''yes (keep)''' to continuously record lines without losing debug history.  The debug log can easily be accessed from the [[Morph_4K#Web_Interface|Web Interface]] at [http://morph4k.local/sdcard/debug.txt http://morph4k.local/sdcard/debug.txt].  Currently TX, RX and Clock events are recorded as well as other notable events.  In order to locate events in their context, you can use the '''Number 5''' button on the Morph remote to create a ''user mark'' in the log file (such as when a sync drop occurs) to assist in inspecting the debug log for unusual behavior in proximity to the recorded user marks.********
|Allows you to write a debug log file called ''debug.txt'' to the root directory of the [[Morph_4K#MicroSD_Port|microSD]] card. This is useful in the event you encounter a problem or issue using your Morph and need to share your debug log with Pixel FX.  By default, this is set to off and can be changed to '''yes (overwrite)''' to write over the file on each power cycle or '''yes (keep)''' to continuously record lines without losing debug history.  The debug log can easily be accessed from the [[Morph_4K#Web_Interface|Web Interface]] at [http://morph4k.local/sdcard/debug.txt http://morph4k.local/sdcard/debug.txt].  Currently TX, RX and Clock events are recorded as well as other notable events.  In order to locate events in their context, you can use the '''Number 5''' button on the Morph remote to create a ''user mark'' in the log file (such as when a sync drop occurs) to assist in inspecting the debug log for unusual behavior in proximity to the recorded user marks.********
|-
|-
|'''Signal modifier'''
|'''Signal modifier'''
|Allows you to change Morph's HDMI transmitter charge pump current. By default, this is set to off.  Turning this on is recommended when using a very long HDMI cable or when advised during troubleshooting by PixelFX support.  First check for the existing value via the [[Morph_4K#Web_Interface|Web Interface]] URL [http://morph4k.local/signal_modifier/VALUE http://morph4k.local/signal_modifier/VALUE], then replace VALUE with a different option i.e. 0, 1, 2, 3.
|Allows you to change Morph's HDMI transmitter charge pump current. By default, this is set to off.  Turning this on is recommended when using a very long HDMI cable or when advised during troubleshooting by Pixel FX support.  First check for the existing value via the [[Morph_4K#Web_Interface|Web Interface]] URL [http://morph4k.local/signal_modifier/VALUE http://morph4k.local/signal_modifier/VALUE], then replace VALUE with a different option i.e. 0, 1, 2, 3.
|-
|-
|'''Fan setting'''
|'''Fan setting'''
Line 931: Line 939:
==== Game ID ====
==== Game ID ====


The Game ID submenu contains settings related to [https://junkerhq.net/xrgb/index.php?title=Game_ID Game ID].  Game ID allows supported consoles and devices (such as PixelFX's xDigitals and Retro GEMs) to transmit which game or software title you are currently playing over to Morph.  Additional PixelFX links pertaining to advanced use of Game ID:
The Game ID submenu contains settings related to [https://junkerhq.net/xrgb/index.php?title=Game_ID Game ID].  Game ID allows supported consoles and devices (such as Pixel FX's xDigitals and Retro GEMs) to transmit which game or software title you are currently playing over to Morph.  Additional Pixel FX links pertaining to advanced use of Game ID:


* [https://docs.pixelfx.co/API-V0.html#game-id Game ID Rest API]
* [https://docs.pixelfx.co/API-V0.html#game-id Game ID Rest API]
Line 1,029: Line 1,037:


==== Snake ====
==== Snake ====
[[File:Morph_Snake_Game_Example.png|thumb|300px|right|Example of PixelFX's Snake game]]
[[File:Morph_Snake_Game_Example.png|thumb|300px|right|Example of Pixel FX's Snake game]]
The Snake submenu is PixelFX's version of the popular classic video game, [https://en.wikipedia.org/wiki/Snake_(video_game_genre) Snake].  This is useful when you want to easily play a game in the OSD without powering on a separate device or console.
The Snake submenu is Pixel FX's version of the popular classic video game, [https://en.wikipedia.org/wiki/Snake_(video_game_genre) Snake].  This is useful when you want to easily play a game in the OSD without powering on a separate device or console.


{| class="wikitable" align="center"
{| class="wikitable" align="center"
Line 1,065: Line 1,073:
|-
|-
|'''Force Firmware Update'''
|'''Force Firmware Update'''
|Choose this option to reset the [[Morph_4K#Firmware|firmware updater]] so a new version is found the next time it is executed, even if the checksum of the firmware on the server matches the firmware that is currently installed.  Generally, you would only use this option when advised during troubleshooting by PixelFX support.
|Choose this option to reset the [[Morph_4K#Firmware|firmware updater]] so a new version is found the next time it is executed, even if the checksum of the firmware on the server matches the firmware that is currently installed.  Generally, you would only use this option when advised during troubleshooting by Pixel FX support.
|-
|-
|'''Force Preset Install/Update'''
|'''Force Preset Install/Update'''
|Choose this option to reset the [[Morph_4K#Presets|preset updater]] so a new version is found the next time it is executed, even if the version of the preset archive matches the version currently installed.  Generally, you would only use this option when advised during troubleshooting by PixelFX support.
|Choose this option to reset the [[Morph_4K#Presets|preset updater]] so a new version is found the next time it is executed, even if the version of the preset archive matches the version currently installed.  Generally, you would only use this option when advised during troubleshooting by Pixel FX support.
|-
|-
|}
|}
Line 1,173: Line 1,181:
:# Click on Mobile Hotspot
:# Click on Mobile Hotspot
:# Verify Band is set to 2.4 GHz
:# Verify Band is set to 2.4 GHz
== Updating Firmware ==
=== Updating via WiFi ===
[[File:Morph_4K_Firmware_Update_Complete.png|thumb|300px|right|Example of Update Firmware screen after Morph's firmware updater completes the download, verify, and install steps]]
''You must complete [[Morph_4K#WiFi_Setup_Wizard|WiFi Setup Wizard]] in order to proceed.  Also as of the 3.9.x firmware, a microSD is always required to run Update Firmware.''
# With Morph connected to WiFi, open the main menu and go to System > Firmware > Update Channel.
# Choose either the stable or testing channel (stable is recommended), then press OK on the remote to save this setting.
# Back on the Firmware menu, select Check for Update.
#* If an update is available, you will see the message "New version is available for download."  Press OK on the remote to view the Firmware Changelog and then press OK again to begin the update.
#* If no update is available, you will see the message "Firmware is up-to-date".  Press back on the remote to return to the Firmware menu.
# Select Update Firmware and then press OK on the remote to begin the process.
#* Morph will first download the latest update to the device and then install it.  Please wait for this process to finish before attempting to use or power off Morph via physical switch (same goes for standby via remote power button).
#* If the firmware downloads, but fails to install, then remove the microSD card from the Morph, insert it into your PC, and delete the '''fw''' and '''update''' folders.  Then place the microSD back into the Morph and repeat the previous steps.
# When the update has finished installing, you will see the message "Bootloader is up-to-date!" as shown in the picture on the right. Press OK on the remote to restart Morph.
# The main menu will appear letting you know the latest firmware has installed.  Press OK on the remote to mark this version as valid.
#* If for any reason you prefer to revert to the previously installed version, press back on the remote.
If the firmware fails to download, then re-attempt the update with System > Firmware > Update Firmware after you apply these troubleshooting steps:
:* Go to System > Wifi and confirm Morph's SignalQ percentage, the signal quality strength to the router, is at least ~50% or move it closer to the router
:* Confirm the router's 2.4 GHz band is separate from 5 GHz (Morph's WiFi antenna only supports 2.4 GHz)
:* Confirm the router's 2.4 GHz band is not using a VPN (the VPN tunnel may slow internet traffic)
:* Confirm the router's 2.4 GHz band has the channel set to either 1, 6, or 11 (these are non-overlapping channels; others are more susceptible to interference)
:* If everything above is correct, then as a last resort restart the router
:# Unplug the power cable/turn off the router
:# Wait 60 seconds and then plug the power cable back in/turn on the router
:# Wait at least 5 minutes for the router to re-establish internet connectivity to all devices
These steps should resolve the issue.  However if you are still unable to update Morph via WiFi, then attempt to update via SD card instead.
=== Updating via SD Card ===
[[File:Pixel_FX_Firmware_Download_Website.png|thumb|300px|right|[https://firmware.pixelfx.co/ Pixel FX Firmware Download Website]]]
When no WiFi access is available, especially if Morph is on launch firmware v3.0.5, it is possible to update Morph using the [[Morph_4K#MicroSD_Port|microSD port]] on the front of the device.  Morph supports both exFAT and FAT32 formats.
==== Download Firmware to MicroSD ====
The latest Morph firmware can be downloaded in a few ways.
*; Directly from [https://firmware.pixelfx.co/ https://firmware.pixelfx.co/]
# Select Morph4K from the product list.  You must have your Device ID ready in order to download it.
#* The Device ID is found either in the Morph menu under System > Info or in the [http://morph4k.local/ Web Interface] after clicking on [[Morph_4K#Device_Info|Show Device Info]]. 
# Once you've added the Device ID, choose the stable version (or testing, if you prefer) and click on Download Firmware.
# After the firmware file has finished downloading, place it on the root directory of the microSD card and rename it '''morph4k-update.fx'''.  Then safely eject the microSD from your computer.
*; Using Morph to generate a direct download link via text file to the microSD
# Insert a microSD card into Morph while fully powered off via physical switch (not standby mode via remote power button), then briefly hold down the first button from the left (O underneath it) and turn it on. 
# Morph's LED will double-blink red continuously while it writes a text file to the root of the microSD card called ''firmware-download-url.txt''.  This file contains a link that you can use to automatically download the latest firmware from the last chosen [[Morph_4K#Update_Channel|Update Channel]]. 
#* This is also another way to retrieve the Device ID via the URL path <code>...uuid='''<Device ID>'''&pid=morph4k...</code> and it's visible in the downloaded file name <code>morph4k-update-testing_'''<Device ID>'''.fx</code>.
# After the firmware file has finished downloading, place it on the root directory of the microSD card and rename it '''morph4k-update.fx'''.  Then safely eject the microSD from your computer.
*; Using Morph's Web Interface
# If you've successfully connected Morph to your local SSID by following the [[Morph_4K#WiFi_Setup_Wizard|WiFi Setup Wizard]] (even though you're unable to update via WiFi), then the firmware file can be downloaded from the [http://morph4k.local/ Web Interface] under the [[Morph_4K#Manual_FW_Update|Manual FW Update]] section by clicking '''Download firmware for manual update'''.
# This will redirect you to the [https://firmware.pixelfx.co/ Pixel FX Firmware Download Website] with a pre-populated Device ID.  You can choose the latest stable version (or testing, if you prefer) and click on Download Firmware.
# After the firmware file has finished downloading, place it on the root directory of the microSD card and rename it '''morph4k-update.fx'''.  Then safely eject the microSD from your computer.
Once you have the latest firmware file on the microSD, proceed with one of the two update methods below.
==== Method A. Flash Morph with MicroSD Card ====
# With Morph fully powered off via physical switch (not standby mode via remote power button), insert the microSD card face up in the card reader.
# Briefly hold down the first button from the left (O underneath it) on Morph and turn it on.
# Morph's LED will double-blink red, then double-blink green about five times, and then double-blink yellow continuously.  This means the flashing process is underway.
# Once it is complete, the LED will remain white. At this point, you can power cycle the Morph.
# Open the main menu to see from the bottom right-hand corner that Morph is now running the latest firmware.
==== Method B. Using "Update Firmware from SD Card" ====
[[File:Morph_4K_Firmware_Submenu.png|thumb|300px|right|Example of the Firmware submenu with the option for Update Firmware from SD Card available when a microSD card is detected]]
''Morph must be on at least firmware version 3.1.0 to proceed''
# With Morph fully powered off via physical switch (not standby mode via remote power button), insert the microSD card face up in the card reader.
# Turn Morph on, open the main menu, and go to System > Firmware > Update Firmware from SD Card.
# You will see two fields, Current FW and Install FW, along with the chosen firmware file at the bottom.
#* If you see ''morph4k-update.fx.verified'', then press right on the remote once to select the '''morph4k-update.fx''' file.
#* You can tell the file is correct when the Install FW is now different from the Current FW.
# Press OK on the remote to start installing the firmware.
# Once complete, press OK again to restart Morph.
# The main menu will appear letting you know the latest firmware has installed.  Press OK on the remote to mark this version as valid.
#* If a ''morph4k-update.fx.verified'' file was already on the microSD card, it will be overwritten with the latest firmware version.
=== Using the Rescue System ===
In the event you're unable to access Morph's main menu and [[Morph_4K#Web_Interface|Web Interface]], such as experiencing power failure during a firmware update, then you can use the Rescue System to re-flash Morph with the latest firmware.
==== Rescue System via WiFi ====
[[File:Rescue_System_with_Reformat_Filesystem.png|thumb|300px|right|[http://192.168.4.1/rescue.html Rescue page] accessible from Morph's '''Rescue-System''' SSID]]
# Start with Morph fully powered off via physical switch (not standby mode via remote power button), briefly hold down the first button from the left (O underneath it) on Morph and turn it back on.
# Morph's LED will double-blink red continuously.  This means Morph is in Rescue System mode and is broadcasting a private WiFi connection.
# Using a laptop or desktop with wireless connectivity, open the WiFi connections list and click on the SSID labeled '''Rescue-System'''.
#* Enter the password '''Rescue-System''' (same as SSID) and wait for your device to complete the connection.
#* If DHCP is disabled on your device and you're using a static IP address, be sure to re-enable DHCP in order to connect to the '''Rescue-System''' SSID.
# In your browser, go to the address [http://192.168.4.1/rescue.html http://192.168.4.1/rescue.html].  Keep the browser window open and switch your laptop/desktop back to your local SSID.
# Go back to the browser window and click on Firmware Download.  This will take you to the [https://firmware.pixelfx.co/ Pixel FX Firmware Download Website] with a pre-populated Device ID.
# In the version list, choose the latest stable version (or testing, if you prefer) and click on Download Firmware.
# After the firmware file has finished downloading, rename it '''morph4k-update.fx'''.
# Switch back to the '''Rescue-System''' SSID and return to the browser window with the address [http://192.168.4.1/rescue.html http://192.168.4.1/rescue.html].
#* Refresh the browser window to make sure the rescue page is still accessible while connected to the '''Rescue-System''' SSID.
# Click on Browse... and select the '''morph4k-update.fx''' file.
# You will see the option to Reformat Filesystem.  Leave this unchecked for now.
# Click on Upload and wait patiently while the firmware file uploads and then installs on Morph.
# Once complete, you will see a "Successfully Updated Firmware" message in the browser window.  Morph will automatically restart.
#* If the process fails, then click on Browse... and select the '''morph4k-update.fx''' file again.
#* Check the box next to Reformat Filesystem.  This will factory reset the Morph, deleting all custom profiles and stored data.
#* Click on Upload and wait patiently while Morph's filesystem is reformatted, then the firmware file will upload and install on Morph.
#* Once complete, you will see a "Successfully Updated Firmware" message in the browser window.  Morph will automatically restart.
# It is now safe to use Morph.  Open the main menu to confirm the latest firmware has installed.
These steps should recover Morph to a working state.  However if you are still unable to recover Morph through the Rescue System via WiFi, then attempt the Rescue System via SD card instead.
==== Rescue System via SD Card ====
# Take the '''morph4k-update.fx''' file that you downloaded during the [[Morph_4K#Rescue_System_via_WiFi|Rescue System via WiFi]] steps and place it on the root directory of a microSD card (both FAT32 and exFAT are supported).
# Safely eject the microSD from your computer.  Make sure Morph is fully powered off via physical switch (not standby mode via remote power button), insert the microSD card face up in the card reader.
# Briefly hold down the first button from the left (O underneath it) on Morph and turn it on.
# Morph's LED will double-blink red, then double-blink green about five times, and then double-blink yellow continuously.  This means the flashing process is underway.
# Once it is complete, the LED will remain white. At this point, you can power cycle the Morph.
# Open the main menu to see from the bottom right-hand corner that Morph is now running the latest firmware.
==== Common Errors ====
:* Error -7: Usually caused by filesystem corruption, try again with the "Reformat Filesystem" option selected.
:* Error -18: Incorrect firmware. A checksum or device-Id does not match. Start the process again and follow the instructions to download the firmware for your target unit. Do not attempt to use firmware downloaded on another Morph unit.
==== Updating the Rescue System ====
New firmware specifically for the rescue system may occasionally be released. Please only update your rescue system firmware if instructed to do so by Pixel FX support. To update the Rescue System firmware, follow the steps below.
# Place the '''morph4k-rescue.binc''' file, provided to you by Pixel FX support, onto the root directory of a microSD card  (both FAT32 and exFAT are supported).
# Safely eject the microSD from your computer.  Make sure Morph is fully powered off via physical switch (not standby mode via remote power button), insert the microSD card face up in the card reader.
# Power on Morph, open the main menu, and navigate to System > Firmware where you should see the option Rescue Mode Update.
#* If you do not see the option Rescue Mode Update, check that your SD card is inserted and that you copied the update file correctly.
# Select Rescue Mode Update, press OK on the remote and then press OK again to confirm.
# When the update is complete, you should see the message "Rescue update successfully finished!". Press the back button and the process is complete.
Retrieved from "https://wiki.pixelfx.co/index.php/Morph_4K"