[API] SamyGO web API

Here are software that related with Samsung H series TVs.
Post Reply

User avatar
mad_ady
SamyGO Project Donor
Posts: 235
Joined: Sun May 03, 2015 10:42 am

[API] SamyGO web API

Post by mad_ady » Mon Jul 10, 2017 2:21 pm

I've developed a simplified API to interact with some common libraries that run on SamyGO (B/C/D/E/H) and I'm releasing it to the community, for tests, ideas and improvements :)

You can get it here:
https://github.com/mad-ady/samygo-web

SamyGO web API

The Web API exposes some of SamyGO's plugins to external clients. The API tries to return data in json format where possible, but uses image/jpg for screenshots.

Features:
  • Get TV State and current program details via libLogChannel
  • Control the TV via samyGOrc with remote actions
  • Reboot the TV
  • Get a screenshot of what is on the screen via libScreenShot
  • Compatibility with libSoftPowerOff (viewtopic.php?t=8987&start=230)
Dependencies:
Installation:

Download to your rooted SamyGO TV:

Code: Select all

cd /tmp
curl -k https://codeload.github.com/mad-ady/samygo-web/zip/master > samygo-web-api.zip
Unzip

Code: Select all

unzip samygo-web-api.zip
Run the installation script:

Code: Select all

./samygo-web-master/installer.sh
LibSoftPowerOff coexistence:
If you have libSoftPowerOff enabled in your TV and you use the screenshot functionality, in order not to inject the screenshot command when the display is off you can signal that the TV is in soft-off mode by configuring libSoftPowerOff.so to run two scripts on power on/off. When you load the libSoftPowerOff library, use the following options:

Code: Select all

CMD_ON:/mnt/scripts/onPowerOn.sh CMD_OFF:/mnt/scripts/onPowerOff.sh 
The onPowerOn.sh/onPowerOff.sh scripts (among other functionality) should set a flag by creating a file called

Code: Select all

/dtv/tvIsSleeping
:
  • onPowerOn.sh: rm -f /dtv/tvIsSleeping
  • onPowerOff.sh: touch /dtv/tvIsSleeping
If you don't use libSoftPowerOff, the TV powers off and the web API is no longer accessible.

Startup
:

Code: Select all

/mnt/etc/init.d/99_99_samygo_web_api.init start
On first run the startup script will generate a unique challenge which will be printed by the startup screen. This challenge is generated in

Code: Select all

/mnt/etc/samygo-web-api.challenge
. You will need to supply this challenge string on all requests. The security is equivalent to HTTP Simple Auth and should protect you against somebody scanning your system, but will not protect you from a man-in-the middle attack! Also, don't use over unencrypted internet!

API Usage
:

to get the current information, request for action=CHANNELINFO:

Code: Select all

$ wget -O - "http://tv-ip:1080/cgi-bin/samygo-web-api.cgi?challenge=oyd4uIz5WWAkWPo5MzfxBFraI05C3FDorSPE7xiMLCVAQ40a&action=CHANNELINFO"

{"source":"TV (0)","pvr_status":"NONE","powerstate":"Normal","tv_mode":"Cable (1)","volume":"9","channel_number":"45","channel_name":"Nat Geo HD","program_name":"Planeta dezastrelor","resolution":"1920x1080","error":false}
to reboot TV request for action=REBOOT:

Code: Select all

$ wget -O - http://tv-ip:1080/cgi-bin/samygo-web-api.cgi?challenge=oyd4uIz5WWAkWPo5MzfxBFraI05C3FDorSPE7xiMLCVAQ40a&action=REBOOT
to send key events request for action=KEY and key=KEY_1:

Code: Select all

$ wget -O - http://tv-ip:1080/cgi-bin/samygo-web-api.cgi?challenge=oyd4uIz5WWAkWPo5MzfxBFraI05C3FDorSPE7xiMLCVAQ40a&action=KEY&key=KEY_1

{"error":false,"message":"Sent key 4"}
The list and codes of supported keys are available inside the script in the $KEYS array: https://github.com/mad-ady/samygo-web/b ... eb-api.cgi

to get a snapshot from the TV request for action=SNAPSHOT:

Code: Select all

$ wget -O /tmp/image.jpg http://tv-ip:1080/cgi-bin/samygo-web-api.cgi?challenge=oyd4uIz5WWAkWPo5MzfxBFraI05C3FDorSPE7xiMLCVAQ40a&action=SNAPSHOT
Real world applications examples: Integrating your TV into Home Assistant: viewtopic.php?f=79&t=11882
H6400, firmware 2602.2 downgraded to 2130

User avatar
lekron
SamyGO Project Donor
Posts: 28
Joined: Thu Apr 28, 2016 12:59 pm
Location: Germany

Re: [API] SamyGO web API

Post by lekron » Fri Jul 14, 2017 3:34 pm

Nice project man!
UE40H6740 T-MST2130

User avatar
mad_ady
SamyGO Project Donor
Posts: 235
Joined: Sun May 03, 2015 10:42 am

Re: [API] SamyGO web API

Post by mad_ady » Mon Jul 17, 2017 5:54 am

I accept push requests for bug fixes or new features. Also, from what I've read the functionality exists also on tizen TVs, but with different APIs. If somebody can give me shell access to their J+ tv (or at least some outputs), I can update the API as well.
H6400, firmware 2602.2 downgraded to 2130

Post Reply

Return to “[H] Software”