From kobe
Jump to: navigation, search

OnePro - calls   ❖

plánovaná volání[edit]

Tato volání jsou repetitivně opakované v určených intervalech. O volání rozhoduje asociovaná akce
Dokumentace API od RailFormers zde

log[edit]

Posílá na server logy o přehraných playlistech.

  • volání: api/devices/log?device_sn=SN123456
  • metoda: POST
  • associated action: SEND_LOG

posílaná data

{
  "playlist_token": "34b7570787cacbdc1ba77a665f94c209",
  "hash_list": [
    {
      "id": 7,
      "count": 5,
      "date": "2020-06-18"
    }
  ]
}

get_plan[edit]

Získává ze serveru aktuální scénář

  • volání: api/devices/plan?device_sn=SN123456
  • metoda: GET
  • associated action: CHECK_PLAN

obdržená data

{
  "play_type": "plan",
  "groups": [
    {
      "id": 1,
      "from": {
        "hours": 0,
        "mins": 0
      },
      "to": {
        "hours": 23,
        "mins": 59
      },
      "has_black_alarm": 1,
      "playlists": [

      ]
    }
  ],
  "last_change_token": "f71dc25839153873b989c22560345829",
  "files": [

  ]
}

update_device[edit]

Na server se posílají informace o zařízení a zpátky se obdrží požadavky na nové nastavení.

  • volání: /api/devices/update_device?device_sn=SN123456
  • metoda: PATCH
  • associated action: UPDATE_DEVICE

posílaná data

{
  "device": {
    "android_online": true,
    "black_level": -77,
    "boot_on_source": "-77",
    "brightness": -77,
    "build_number": 1363,
    "contrast": -77,
    "device_datetime": "2024-01-03 07:23:27",
    "device_refresh_time": 45,
    "fw_version": "0115",
    "gamma": -77,
    "memory_space_free": 1786376192,
    "memory_space_total": 2850803712,
    "model_number": "32BDL3650Q\/00",
    "net_device": "lan",
    "net_ip": "192.168.1.82",
    "ondemand_refresh_time": 10,
    "orientation": "landscape",
    "plan_type": "plan",
    "power_safe": "mode2",
    "screen_online": true,
    "sdcard_space_free": 10453155840,
    "sdcard_space_total": 11314765824,
    "sharpness": -77,
    "show_clock": 0,
    "sicp_version": "2.09",
    "speed_test_date": "2024-01-02 10:18:40",
    "speed_test_speed": 2375,
    "speed_test_success": true,
    "switch_on_state": "force_on",
    "temperature": "24",
    "time_zone": "Europe\/Brussels",
    "volume": 10
  },
  "device_sn": "AU0A2320004299"
}

obdržená data

{
  "brightness": 80,
  "black_level": 50,
  "sharpness": 50,
  "boot_on_source": "custom",
  "power_save": "mode3",
  "switch_on_state": "last_status",
  "gamma": 1,
  "contrast": 50,
  "volume": 10,
  "show_clock": 0,
  "build_number": 9,
  "speed_test_success": true,
  "speed_test_speed": 10,
  "speed_test_date": "2020-06-18T14:35:12.000+02:00",
  "schedules": [
    {
      "active": true,
      "schedule_number": 1,
      "video_source": 24,
      "playlist": null,
      "working_days": 18,
      "start_time": {
        "hours": 12,
        "minutes": 35
      },
      "end_time": {
        "hours": 14,
        "minutes": 35
      }
    }
  ]
}

poslední změny

Od verze 2.7.23

apk_version[edit]

Získá ze serveru informaci o dostupné verzi nového APK.

  • volání: api/system/apk_version
  • metoda: GET
  • associated action: APK_VERSION

obdržená data

{
  "build_number": 1,
  "apk_name": "apk1.apk"
}

check_connection[edit]

Slouží ke kontrole dostupnosti Artemis serveru.

  • volání: api/system/check_connection
  • metoda: GET
  • associated action: CHECK_CONNECTION

obdržená data

{
  "status": "connected"
}

requested_actions[edit]

Velmi rychlý cyklus komunikace. Slouží pro rychlé vyvolání akce na klientovy prostřednictvím serveru

  • volání: api/system/requested_actions
  • metoda: GET
  • associated action: REQUESTED_ACTIONS

obdržená data

{
  "actions": [
    "screenshot",
    "reboot",
    "screen_on",
    "content_update",
    "speed_test",
    "playlist_kill"
  ],
  "last_device_change": 1592483713
}

Registrované příkazy[edit]

public class RequestedActions implements Callback<RequestedActionsResponse> {
	public static final String ACT_SCR = "screenshot";
	public static final String ACT_REB = "reboot";
	public static final String ACT_SON = "screen_on";
	public static final String ACT_SOF = "screen_off";
	public static final String ACT_UPD = "content_update";
	public static final String ACT_SPT = "speed_test";
	public static final String ACT_KPL = "playlist_kill";
	public static final String ACT_OND = "ondemand";
	public static final String ACT_SUP = "selective_update";
	public static final String ACT_4550D = "update_4550D";
	public static final String ACT_4650D = "update_4650D";
	public static final String ACT_3550Q = "update_3550Q";
	public static final String ACT_3650Q = "update_3650Q";
	...
}

clearing volání[edit]

Oznamují severu, že akce na požadavek requested_action byla vykonána. Bez těchto volání by server neustále požadoval určitou akci.

update_done[edit]

Informuje server, že update byl úspěšně vykonán. Toto volání je prováděno po úspěšném stažení posledního playlistu.

  • volání: api/devices/update_done?device_sn=SN123456
  • metoda: GET
  • worker routine: actionLoadDone()

playlist_kill_done[edit]

Informuje server, že aktuálně přehrávaný scénář byl přerušen.

  • volání: api/devices/playlist_kill_done?device_sn=SN123456
  • metoda: POST
  • worker routine: actionPlaylistKill()

selective_update_done[edit]

Informuje server, že selective update byl vykonán.

  • volání: api/devices/selective_update_done?device_sn=SN123456
  • metoda: POST
  • worker routine: actionSelectiveUpdate()

fw_update_done[edit]

Informuje server, že ZIP soubor s FW byl stažen a je připraveno jeho spuštění. Akce je vyvolaná ze serveru přes volání requested_action

  • volání: api/devices/fw_update_done?device_sn=SN123456
  • metoda: POST
  • worker routine: call_FwUpdateDone()
  • implementace od: 2.7.23

reboot_done[edit]

Informuje server, že požadovaný reboot byl vyvolán. Toto volání má poněkud převrácenou logiku. Oznámí se serveru, že požadavek byl registrován a poté co server odpoví že to bere na vědomí, tak se teprve zavolá reboot.

  • volání: api/devices/reboot_done?device_sn=SN123456
  • metoda: POST
  • worker routine: call_RebootDone()

speed_test_done[edit]

Informuje server, že požadovaný měření rychlosti sítě bylo provedeno a zároveň pošle poslední měření

  • volání: api/devices/speed_test_done?device_sn=
  • metoda: POST
  • worker routine: processTest()

posílaná data

{
  "speed_test_date": "2024-01-02 08:30:26",
  "speed_test_speed": 2535,
  "speed_test_success": true
}

posílání dat[edit]

Posílá data na server

upload_screenshot[edit]

Na požadavek serveru přes requested_action pošle na server screenshot.

  • volání: api/devices/upload_screenshot?device_sn=SN123456
  • metoda: PATCH
  • worker routine: call_UploadScreenshot()

posílaná data

{
  "device": {
    "screen_base64": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="
  },
  "device_sn": "SN123456"
}

obdržená data

{
  "transport": true
}

neimplementovaná volání[edit]

exist[edit]

Klient si ověřuje, zda je registrovaný na serveru?

  • volání: api/devices/exists?device_sn=SN123456
  • metoda: GET
  • associated action: není implementováno

single_playlist[edit]

Netuším účel?

  • volání: api/devices/exists?single_playlist=SN123456
  • metoda: GET
  • associated action: není implementováno
Retrieved from "https://devel.framexx.com/mediawiki/index.php?title=Philips/onepro/calls&oldid=6665"