Additional endpoint examples

[helgek]

Feedback

Hi,

I finally found solution to change e.g. picture presets. Please see my last comment at:

https://community.home-assistant.io/t/lg-webos-change-picture-setting-mode-with-scripts/262915

Could these commands also be performed with the current integration of webostv? I'm not a developer so this the reason why I'm asking this potentially stupid sounding question. If it's possible I think many home assistant users would praise you for additional examples in the documentation regarding how one can e.g. modify picture presets!

When you search for "picture" in this Source you will also find more details:
https://github.com/bendavid/aiopylgtv/blob/master/aiopylgtv/webos_client.py

Thanks
Helge

URL

https://www.home-assistant.io/integrations/webostv/

Version

2021.4.6

Additional information

No response

[probot-home-assistant]

Hey there @bendavid, mind taking a look at this feedback as its been labeled with an integration (webostv) you are listed as a codeowner for? Thanks!
_{^{(message by CodeOwnersMention)}}

[helgek]

follow-up information on ongoing implementations here:
merdok/homebridge-webos-tv#371
https://github.com/klattimer/LGWebOSRemote

[bendavid]

There are a number of caveats to this:

1. These commands are intended to be used for calibration and not for general control. If start_calibration is called without calling end_calibration, you can leave the image in a weird state (not sure if/when it resets itself)

2. Because the tv keeps track of presets separately for SDR, HDR10+HLG, and Dolby Vision, you can only change the preset for the current dynamic range mode, which makes it difficult to deal with this robustly in automations unless you can be sure to always be in a predictable dynamic range mode (e.g. for a device which only supports SDR or which is locked to HDR10 all the time)

[helgek]

Thank you for your remarks! I understand both points you raise. Especially I now better understand why for instance different presets are shown when I select my FireTV. It seems though that cinema, game, expert1, expert2 are available at least in SDR and Dolby Vision (FireTV) it seems.

[bendavid]

The presets are also tracked separately per HDMI input , and also for smart tv apps (but all the smart tv apps share the same preset)

[helgek]

wow, you have really deep knowledge! Thanks!

[kongomongo]

@bendavid so there is no other method to directly switch presets (game <-> expert2) other than the calibration api?

[bendavid]

Not that I know of. What I personally do is have two hdmi cables running from my AVR to the TV and swap outputs when I want to switch between two different presets.

[kongomongo]

unfortunately undesirable in my setup. Have you tried doing a externalpq/getExternalPqData ? can you get the picMode via that? That way you can use the quick menu to select another picMode since you know how many ticks to go left/right.

[bendavid]

The only way I know to get information about the current picture mode is with get_picture_settings (in case they have different values set for contrast/backlight/brightness/color)

This could also allow to distinguish which HDR mode the tv is in...

[bendavid]

externalpq/getExternalPqData actually looks like a valid endpoint, but I get an "invalid parameters" error and I have no idea what is supposed to be passed to it...

One thing I did realize is that settings/getSystemSettings in fact supports subscription callbacks, so I can add this to the set of internally tracked state information in the next release of aiopylgtv (and eventually brightness/constrast/oled light/color can be added as additional state attributes in home assistant)

[kongomongo]

is it possible to decrypt the firmware file and look for clues?

[bendavid]

This was actually an excellent suggestion.

The firmware as downloaded from lg's web site can be decrypted with
https://github.com/openlgtv/epk2extract

And there are plenty of hints there. I'll definitely have a look (but feel free to as well :)

[kongomongo]

Thanks for the heads up! I am digging as well.

grep getExternalPqData -r *
rootfs.pak.unsquashfs/usr/share/luna-service2/api-permissions.d/com.webos.service.apiadapter.api.json:    "com.webos.service.apiadapter/externalpq/getExternalPqData",
rootfs.pak.unsquashfs/usr/share/luna-service2/api-permissions.d/com.webos.service.apiadapter.api.json:    "com.webos.service.apiadapter/externalpq/getExternalPqData",
rootfs.pak.unsquashfs/usr/palm/services/com.webos.service.secondscreen.gateway/interfaces/externalpq.interface:                 "path": "/getExternalPqData",
rootfs.pak.unsquashfs/usr/palm/services/com.webos.service.secondscreen.gateway/interfaces/externalpq.interface:                 "provider": "com.webos.service.apiadapter/externalpq/getExternalPqData"
rootfs.pak.unsquashfs/usr/palm/services/com.webos.service.secondscreen.gateway/interfaces/com.webos.service.apiadapter.interface:                       "path": "/externalpq/getExternalPqData",
rootfs.pak.unsquashfs/usr/palm/services/com.webos.service.apiadapter/adapters/externalpq/index.js:              {name: "getExternalPqData", path: "/getExternalPqData", onRequest: "onGetExternalPqData"},
rootfs.pak.unsquashfs/usr/palm/services/com.webos.service.apiadapter/adapters/externalpq/index.js:              return request.chainCall('luna://com.webos.service.tv.display/getExternalPqData', payload)
Binary file tvservice-dvb.pak.unsquashfs/mnt/lg/tvservice/lgapp/tvservice.sym matches
Binary file tvservice-dvb.pak.unsquashfs/mnt/lg/tvservice/lgapp/tvservice matches

tvservice-dvb.pak.unsquashfs/mnt/lg/tvservice/lgapp# file tvservice
tvservice: ELF 32-bit LSB executable, ARM, EABI5 version 1 (GNU/Linux), dynamically linked, interpreter /lib/ld-linux.so.3, for GNU/Linux 3.2.0, BuildID[sha1]=24857f03fc44a35b2bf365764f14ac25c59d2c43, with debug_info, not stripped

seems like https://www.hopperapp.com/ can disasm this, however I dont have a proper environment for doing so

[bendavid]

So I actually got getExternalPqData working for some calls. So far I can get it it to return the 1D and 3D LUTs stored in the TV, which is INCREDIBLY useful for other purposes, but not much more useful for exposing the picture mode than using the backlight values.

[kongomongo]

gstGetCmdTbl    EXT_CALIB_COMMAND_TBL_T 
 EXT_CALIB_COMMAND_READ_HDR_3BY3_GAMUT_DATA>
 EXT_CALIB_COMMAND_READ_3D_LUT_DATA>
 EXT_CALIB_COMMAND_READ_3BY3_GAMUT_DATA>
 EXT_CALIB_COMMAND_READ_1D_DPG_DATA>
 EXT_CALIB_COMMAND_READ_1D_2_2_EN>
 EXT_CALIB_COMMAND_READ_1D_0_45_EN>

[bendavid]

Do you have the same for setExternalPqData?

[kongomongo]

                EXPORT gstUiPostVal
; EXT_CALIB_UI_VALUE_T gstUiPostVal[2]
gstUiPostVal    EXT_CALIB_UI_VALUE_T <aColorgamut, 0>
                                        ; DATA XREF: LOAD:00200C80↑o
                                        ; _controller_pqfrwk_setExternalPqCalibrationCondition+C0↑o ...
                EXT_CALIB_UI_VALUE_T <aGamma, 1> ; "gamma" ...
                EXPORT gstUiPreVal
; EXT_CALIB_UI_VALUE_T gstUiPreVal[7]
gstUiPreVal     EXT_CALIB_UI_VALUE_T <aLocaldimming, 0>
                                        ; DATA XREF: LOAD:002AB300↑o
                                        ; _controller_pqfrwk_setExternalPqCalibrationCondition+272↑o ...
                EXT_CALIB_UI_VALUE_T <aDynamiccontras, 0> ; "gamma" ...
                EXT_CALIB_UI_VALUE_T <aColorgamut, 0>
                EXT_CALIB_UI_VALUE_T <aGamma, 1>
                EXT_CALIB_UI_VALUE_T <aColortemperatu, 0xFFFFFFCE>
                EXT_CALIB_UI_VALUE_T <aSmoothgradatio, 0>
                EXT_CALIB_UI_VALUE_T <aAmbientlightco, 0>
                EXPORT gstrUiResetItems
; $<19896536,1> gstrUiResetItems[4]
gstrUiResetItems DCD aLocaldimming, aDynamiccontras, aSmoothgradatio, aAmbientlightco
                                        ; DATA XREF: LOAD:001F0450↑o
                                        ; _controller_pqfrwk_setExternalPqCalibrationCondition+13E↑o ...
                                        ; "smoothGradation" ...
                EXPORT gstSetCmdTbl_calman
; EXT_CALIB_COMMAND_TBL_T gstSetCmdTbl_calman[18]
gstSetCmdTbl_calman EXT_CALIB_COMMAND_TBL_T <aCalStart, EXT_CALIB_COMMAND_CAL_START>
                                        ; DATA XREF: LOAD:0011E160↑o
                                        ; controller_pqfrwk_processExternalPqSetCommand+110↑r
                EXT_CALIB_COMMAND_TBL_T <aCalEnd, EXT_CALIB_COMMAND_CAL_END> ; "CAL_START" ...
                EXT_CALIB_COMMAND_TBL_T <aBrightnessUiDa, \
                                         EXT_CALIB_COMMAND_CAL_SETUI_START>
                EXT_CALIB_COMMAND_TBL_T <aContrastUiData, \
                                         EXT_CALIB_COMMAND_CAL_SETUI_CONTRAST>
                EXT_CALIB_COMMAND_TBL_T <aBacklightUiDat, \
                                         EXT_CALIB_COMMAND_CAL_SETUI_BACKLIGHT>
                EXT_CALIB_COMMAND_TBL_T <aColorUiData, \
                                         EXT_CALIB_COMMAND_CAL_SETUI_COLOR>
                EXT_CALIB_COMMAND_TBL_T <aHdr3by3GamutDa, \
                                         EXT_CALIB_COMMAND_HDR_3BY3_GAMUT_DATA>
                EXT_CALIB_COMMAND_TBL_T <aBt7093dLutData, \
                                         EXT_CALIB_COMMAND_BT709_3D_LUT_DATA>
                EXT_CALIB_COMMAND_TBL_T <aBt20203dLutDat, \
                                         EXT_CALIB_COMMAND_BT2020_3D_LUT_DATA>
                EXT_CALIB_COMMAND_TBL_T <a1d22En, EXT_CALIB_COMMAND_1D_2_2_EN>
                EXT_CALIB_COMMAND_TBL_T <a3by3GamutEn, \
                                         EXT_CALIB_COMMAND_3BY3_GAMUT_EN>
                EXT_CALIB_COMMAND_TBL_T <aBt7093by3Gamut, \
                                         EXT_CALIB_COMMAND_BT709_3BY3_GAMUT_DATA>
                EXT_CALIB_COMMAND_TBL_T <aBt20203by3Gamu, \
                                         EXT_CALIB_COMMAND_BT2020_3BY3_GAMUT_DATA>
                EXT_CALIB_COMMAND_TBL_T <a1d045En, EXT_CALIB_COMMAND_1D_0_45_EN>
                EXT_CALIB_COMMAND_TBL_T <a1dDpgEn, EXT_CALIB_COMMAND_1D_DPG_EN>
                EXT_CALIB_COMMAND_TBL_T <a1dDpgData, EXT_CALIB_COMMAND_1D_DPG_DATA>
                EXT_CALIB_COMMAND_TBL_T <aDolbyCfgData, \
                                         EXT_CALIB_COMMAND_DOLBY_CFG_DATA>
                EXT_CALIB_COMMAND_TBL_T <a1dTonemapParam, \
                                         EXT_CALIB_COMMAND_1D_TONEMAP_PARAM>
                EXPORT gstSetCmdTbl_svl
; EXT_CALIB_COMMAND_TBL_T gstSetCmdTbl_svl[23]
gstSetCmdTbl_svl EXT_CALIB_COMMAND_TBL_T <aCalStart, EXT_CALIB_COMMAND_CAL_START>
                                        ; DATA XREF: LOAD:0016E160↑o
                                        ; controller_pqfrwk_processExternalPqSetCommand+AE↑o ...
                EXT_CALIB_COMMAND_TBL_T <aCalEnd, EXT_CALIB_COMMAND_CAL_END> ; "CAL_START" ...
                EXT_CALIB_COMMAND_TBL_T <aBrightnessUiDa, \
                                         EXT_CALIB_COMMAND_CAL_SETUI_START>
                EXT_CALIB_COMMAND_TBL_T <aContrastUiData, \
                                         EXT_CALIB_COMMAND_CAL_SETUI_CONTRAST>
                EXT_CALIB_COMMAND_TBL_T <aBacklightUiDat, \
                                         EXT_CALIB_COMMAND_CAL_SETUI_BACKLIGHT>
                EXT_CALIB_COMMAND_TBL_T <aColorUiData, \
                                         EXT_CALIB_COMMAND_CAL_SETUI_COLOR>
                EXT_CALIB_COMMAND_TBL_T <aInputCscData, \
                                         EXT_CALIB_COMMAND_INPUT_CSC_DATA>
                EXT_CALIB_COMMAND_TBL_T <a1dEotfData, EXT_CALIB_COMMAND_1D_EOTF_DATA>
                EXT_CALIB_COMMAND_TBL_T <aHdr3by3GamutDa, \
                                         EXT_CALIB_COMMAND_HDR_3BY3_GAMUT_DATA>
                EXT_CALIB_COMMAND_TBL_T <a1dOetfData, EXT_CALIB_COMMAND_1D_OETF_DATA>
                EXT_CALIB_COMMAND_TBL_T <a1dTonemapData, \
                                         EXT_CALIB_COMMAND_1D_TONEMAP_DATA>
                EXT_CALIB_COMMAND_TBL_T <aBt7093dLutData, \
                                         EXT_CALIB_COMMAND_BT709_3D_LUT_DATA>
                EXT_CALIB_COMMAND_TBL_T <aBt20203dLutDat, \
                                         EXT_CALIB_COMMAND_BT2020_3D_LUT_DATA>
                EXT_CALIB_COMMAND_TBL_T <a1dLut045En, \
                                         EXT_CALIB_COMMAND_1D_LUT_0_45_EN>
                EXT_CALIB_COMMAND_TBL_T <aHueCorrectionD, \
                                         EXT_CALIB_COMMAND_HUE_CORRECTION_DATA>
                EXT_CALIB_COMMAND_TBL_T <a1d22En, EXT_CALIB_COMMAND_1D_2_2_EN>
                EXT_CALIB_COMMAND_TBL_T <aBt7093by3Gamut, \
                                         EXT_CALIB_COMMAND_BT709_3BY3_GAMUT_DATA>
                EXT_CALIB_COMMAND_TBL_T <aBt20203by3Gamu, \
                                         EXT_CALIB_COMMAND_BT2020_3BY3_GAMUT_DATA>
                EXT_CALIB_COMMAND_TBL_T <a1d045En, EXT_CALIB_COMMAND_1D_0_45_EN>
                EXT_CALIB_COMMAND_TBL_T <a1dDpgData, EXT_CALIB_COMMAND_1D_DPG_DATA>
                EXT_CALIB_COMMAND_TBL_T <a1dLutRgbwEn, \
                                         EXT_CALIB_COMMAND_1D_LUT_RGBW_EN>
                EXT_CALIB_COMMAND_TBL_T <a1dLutRgbwData, \
                                         EXT_CALIB_COMMAND_1D_LUT_RGBW_DATA>
                EXT_CALIB_COMMAND_TBL_T <aDolbyCfgData, \
                                         EXT_CALIB_COMMAND_DOLBY_CFG_DATA>
                EXPORT gstPsmTbl
; EXT_CALIB_TARGET_PICTURE_TBL_T gstPsmTbl[11]
gstPsmTbl       EXT_CALIB_TARGET_PICTURE_TBL_T <aCinema, \
                                        ; DATA XREF: LOAD:001196D0↑o
                                                EXT_CALIB_TARGET_PICTURE_CINEMA> ; "expert1" ...
                EXT_CALIB_TARGET_PICTURE_TBL_T <aExpert1, \
                                                EXT_CALIB_TARGET_PICTURE_EXPERT1>
                EXT_CALIB_TARGET_PICTURE_TBL_T <aExpert2, \
                                                EXT_CALIB_TARGET_PICTURE_EXPERT2>
                EXT_CALIB_TARGET_PICTURE_TBL_T <unk_1054D6C, \
                                                EXT_CALIB_TARGET_PICTURE_HDR_CINEMA>
                EXT_CALIB_TARGET_PICTURE_TBL_T <aGame, EXT_CALIB_TARGET_PICTURE_GAME>
                EXT_CALIB_TARGET_PICTURE_TBL_T <aHdrGame_1, \
                                                EXT_CALIB_TARGET_PICTURE_HDR_GAME>
                EXT_CALIB_TARGET_PICTURE_TBL_T <aTechnicolorexp, \
                                                EXT_CALIB_TARGET_PICTURE_TECHNICOLOR_EXPERT>
                EXT_CALIB_TARGET_PICTURE_TBL_T <unk_1054D84, \
                                                EXT_CALIB_TARGET_PICTURE_HDR_TECHNICOLOR_EXPERT>
                EXT_CALIB_TARGET_PICTURE_TBL_T <aDolbyCinemaBri_0, \
                                                EXT_CALIB_TARGET_PICTURE_DOLBY_CINEMA_BRIGHT>
                EXT_CALIB_TARGET_PICTURE_TBL_T <aDolbyCinemaDar, \
                                                EXT_CALIB_TARGET_PICTURE_DOLBY_CINEMA_DARK>
                EXT_CALIB_TARGET_PICTURE_TBL_T <aDolbyGame_0, \
                                                EXT_CALIB_TARGET_PICTURE_DOLBY_GAME>
; $<19909204,1> gExtPsmTarget
_gExtPsmTarget  DCD 0xB                 ; DATA XREF: controller_pqfrwk_processExternalPqSetCommand+482↑r
                                        ; controller_pqfrwk_processExternalPqSetCommand+59A↑r ...
                EXPORT gstDataTypeTbl
; EXT_CALIB_DATA_TYPE_T_TBL_T gstDataTypeTbl[6]
gstDataTypeTbl  EXT_CALIB_DATA_TYPE_T_TBL_T <aFloat, EXT_CALIB_DATA_TYPE_FLOAT>
                                        ; DATA XREF: LOAD:0019BDD0↑o
                                        ; controller_pqfrwk_processExternalPqGetCommand:loc_94B6F6↑o ...
                EXT_CALIB_DATA_TYPE_T_TBL_T <aInterget16, EXT_CALIB_DATA_TYPE_INT16> ; "float" ...
                EXT_CALIB_DATA_TYPE_T_TBL_T <aUnsignedIntege, \
                                             EXT_CALIB_DATA_TYPE_UINT16>
                EXT_CALIB_DATA_TYPE_T_TBL_T <aInterget32, EXT_CALIB_DATA_TYPE_INT32>
                EXT_CALIB_DATA_TYPE_T_TBL_T <aUnsignedIntege_0, \
                                             EXT_CALIB_DATA_TYPE_UINT32>
                EXT_CALIB_DATA_TYPE_T_TBL_T <aUnsignedChar, EXT_CALIB_DATA_TYPE_UCHAR>
                EXPORT gstUiSetCmdKeyTbl
; EXT_CALIB_COMMAND_UI_SET_TBL_T gstUiSetCmdKeyTbl[4]
gstUiSetCmdKeyTbl EXT_CALIB_COMMAND_UI_SET_TBL_T <EXT_CALIB_COMMAND_CAL_SETUI_START, \
                                        ; DATA XREF: LOAD:0025E570↑o
                                        ; controller_pqfrwk_processExternalPqSetCommand+1FA↑o ...
                                                aBrightness> ; "color" ...
                EXT_CALIB_COMMAND_UI_SET_TBL_T <EXT_CALIB_COMMAND_CAL_SETUI_CONTRAST, \
                                                aContrast>
                EXT_CALIB_COMMAND_UI_SET_TBL_T <EXT_CALIB_COMMAND_CAL_SETUI_BACKLIGHT,\
                                                aBacklight>
                EXT_CALIB_COMMAND_UI_SET_TBL_T <EXT_CALIB_COMMAND_CAL_SETUI_COLOR, \
                                                aTechnicolorhdr+0x14>
                EXPORT gstGetCmdTbl
; EXT_CALIB_COMMAND_TBL_T gstGetCmdTbl[6]
gstGetCmdTbl    EXT_CALIB_COMMAND_TBL_T <unk_1054DD0, \
                                        ; DATA XREF: LOAD:0020C2B0↑o
                                        ; controller_pqfrwk_processExternalPqGetCommand:loc_94B60E↑o ...
                                         EXT_CALIB_COMMAND_READ_HDR_3BY3_GAMUT_DATA> ; "GET_3D_LUT_DATA" ...
                EXT_CALIB_COMMAND_TBL_T <aGet3dLutData, \
                                         EXT_CALIB_COMMAND_READ_3D_LUT_DATA>
                EXT_CALIB_COMMAND_TBL_T <aGet3by3GamutDa, \
                                         EXT_CALIB_COMMAND_READ_3BY3_GAMUT_DATA>
                EXT_CALIB_COMMAND_TBL_T <unk_1054E0C, \
                                         EXT_CALIB_COMMAND_READ_1D_DPG_DATA>
                EXT_CALIB_COMMAND_TBL_T <unk_1054E1C, \
                                         EXT_CALIB_COMMAND_READ_1D_2_2_EN>
                EXT_CALIB_COMMAND_TBL_T <unk_1054E2C, \
                                         EXT_CALIB_COMMAND_READ_1D_0_45_EN>
; $<19929054,1> gAGPFlag

[kongomongo]

all other methods seem dead ends so far.

valid settings for "getSystemSettings", "getSystemSettingDesc", "getSystemSettingValues", "setSystemSettings":

var validSettings = {
	getSettingsValidKeySet : {
		"twinTv": [
			"status",
			"role",
			"systemMode"
		],
		"network": [
			"deviceName",
			"wolwowlOnOff",
			"bleAdvertisingOnOff"
		],
		"option": [
			"audioGuidance",
			"country",
			"zipcode",
			"livePlus",
			"addressInfo",
			"phlCitySelection",
			"smartServiceCountryCode3",
			"syncMode",
			"storeMode"
		],
		"time": [
			"onTimerVolume"
		],
		"picture": [
			"brightness",
			"backlight",
			"contrast",
			"color"
		],
		"" : [
			"eulaStatus",
			"eulaInfoNetwork",
			"mobileSetupStatus",
			"localeInfo"
		],
		"other": [
			"simplinkEnable"
		],
		"sound": [
			"avSync",
			"avSyncSpdif",
			"avSyncBypassInput",
			"eArcSupport",
			"soundOutput",
			"soundOutputDigital"
		]
	},

	getSettingDescValidKeySet : {
		"": [
			"eulaInfoNetwork"
		],
		"sound": [
			"eArcSupport",
			"soundOutput",
			"soundOutputDigital"
		]
	},

	getSettingValuesValidKeySet : {
		"option": [
			"phlCitySelection"
		],
		"": [
			"eulaInfoNetwork"
		]
	},

	setSettingsValidKeySet : {
		"option": [
			"phlCitySelection",
			"zipcode",
			"livePlus",
			"firstTvSignalStatus",
			"addressInfo"
		],
		"": [
			"eulaInfoNetwork",
			"eulaStatus",
			"mobileSetupStatus"
		],
		"other": [
			"simplinkEnable"
		],
		"sound": [
			"avSync",
			"avSyncSpdif",
			"avSyncBypassInput",
			"eArcSupport",
			"soundOutput",
			"soundOutputDigital"
		],
		"network": [
			"deviceName",
			"wolwowlOnOff",
			"bleAdvertisingOnOff"
		]
	}
};

module.exports = validSettings;

[kongomongo]

@bendavid bendavid/aiopylgtv@711abda pretty wicked awesome.

How did you come up with that? ;-)

> python picmode.py game
setting picmode to game
   4ms for .create
 919ms for .connect
  31ms for .set_current_picture_mode
   7ms for .disconnect
 962ms total

[FilHarr]

What now needs to be done to get this into the HA webostv integration?

[github-actions]

There hasn't been any activity on this issue recently. Due to the high number of incoming GitHub notifications, we have to clean some of the old issues, as many of them have already been resolved.
If this issue is still relevant, please let us know by leaving a comment 👍
This issue has now has been marked as stale and will be closed if no further activity occurs. Thank you for your contributions.