DebugSmartPlayer/en: различия между версиями

Материал из SmartPlayer
(Новая страница: «==<span id="localDebugConsoleJS">Displaying the local console</span>== Sometimes it is not clear what is happening with the device and there is no way to get logs through your personal account, then you need to run the local debug console to get messages about the problem. 20px In the case of Android OS <br> Starting with version v1.33.*, logging on the device is disabled by default. To enab...»)
(Новая страница: «==<span id="DebugGetLogs">Getting log from device (logs)</span>== мини мини Each client application writes an event log to its internal device memory, if necessary, it can be obtained and sent for analysis to SmartPLayer technical support, to get the most useful logs, do the following: # In the device settings (Select device -> In the right toolbar Settings), when it is in online status (green),...»)
 
(не показано 5 промежуточных версий этого же участника)
Строка 3: Строка 3:
SmartPlayer platform provides many tools for debugging when an abnormality occurs.  
SmartPlayer platform provides many tools for debugging when an abnormality occurs.  


==<span id="DebugGetLogs">Получение журнала с устройства (логи) </span>==
==<span id="DebugGetLogs">Getting log from device (logs)</span>==
[[Файл:Get logs 1.png|мини]]
[[Файл:Get logs 1.png|мини]]
[[Файл:Get logs 2.png|мини]]
[[Файл:Get logs 2.png|мини]]
Каждое клиентское приложение пишет журнал событий в свою внутреннею память устройства, при необходимости его можно получить и отправить для анализа в техническую поддержку SmartPLayer, чтобы получить максимально полезные логи сделайте следующие действия:
Each client application writes an event log to its internal device memory, if necessary, it can be obtained and sent for analysis to SmartPLayer technical support, to get the most useful logs, do the following:
# В настройках устройства (Выбрать устройство -> В правом тулбаре Настройки), когда оно в онлайн статусе (зеленое) включите режим логирования Debug или Trace. Этим вы настроите устройство, чтобы оно писала более детальные сообщения по своей работе
# In the device settings (Select device -> In the right toolbar Settings), when it is in online status (green), enable the Debug or Trace logging mode. This will configure the device so that it writes more detailed messages about its operation
# Постарайтесь воспроизвести нештатную ситуацию на устройстве
# Try to reproduce the abnormal situation on the device
# Перейдите в карточку устройства (Выбрать устройство -> В правом тулбаре Информация) и выгрузите архив с журналом.
# Go to the device card (Select device -> Info in the right toolbar) and download the archive with the log.


There are two parameters:  
There are two parameters:  
Строка 39: Строка 39:
After the download starts, depending on the size of the broadcast, we wait for it to download to the working computer. Then you need to transfer the archive without modification when you open a request on the technical support portal.
After the download starts, depending on the size of the broadcast, we wait for it to download to the working computer. Then you need to transfer the archive without modification when you open a request on the technical support portal.


==<span id="ClearDevice">Очистка устройства</span>==
==<span id="ClearDevice">Clearing the device</span>==
Очистка устройства, позволяет удалить все данные приложения записанные с помощью ПО SmartPlayer, данные действия сбрасывают кеш приложения. Повторная регистрация устройства - не потребуется. Перейдите в карточку устройства (Выбрать устройство -> В правом тулбаре Информация) и нажмите значок "очистить", на выбор будет предложено два параметра:  
Clearing the device allows you to delete all application data recorded using the SmartPlayer software, these actions reset the application cache. Re-registration of the device is not required. Go to the device card (Select device -> Information in the right toolbar) and click the "clear" icon, you will be offered two options to choose from:
* '''Удалить все файлы на устройстве''' - данный параметр удалить медиафайлы скаченный для оффлайн проигрывания контента. При следующем запуске приложения, если актуальная трансляция не закеширована на устройстве, произойдет повторное скачивание файлов.  
* '''Delete all files on the device''' - this option deletes media files downloaded for offline playback of content. The next time you start the application, if the current broadcast is not cached on the device, the files will be downloaded again.
* '''Очистить локальное хранилище''' - данный параметр удалить метаданные необходимые для проигрывания в оффлайн режиме. При следующем запуске приложения, если по актуальной трансляции не хватает метаданных, они будут получены с сервера SmartPlayer.  
* '''Clear local storage''' - this option deletes metadata required for offline playback. The next time you start the application, if there is not enough metadata for the current broadcast, they will be obtained from the SmartPlayer server.  


Depending on the operating system of the client application, it will either be rebooted or restarted.
Depending on the operating system of the client application, it will either be rebooted or restarted.
Строка 49: Строка 49:
If the device does not connect to the server, first check the device's access to the server. To do this, simply open the built-in browser on the Android OS device and enter the server address. If the connection goes to https://cms.smartplayer.org, then enter https://api.smartplayer.org as a result, the message '''Cannot GET /''' should appear, this means that the device "sees" the server.  
If the device does not connect to the server, first check the device's access to the server. To do this, simply open the built-in browser on the Android OS device and enter the server address. If the connection goes to https://cms.smartplayer.org, then enter https://api.smartplayer.org as a result, the message '''Cannot GET /''' should appear, this means that the device "sees" the server.  


Если после проверки устройство остается оффлайн в личном кабинете (серым), можно забрать логи локально с устройства для последующей передачи их в тех. поддержку SmartPlayer. Для этого установите (или воспользуйтесь стандартным) файловым менеджером (например: [https://play.google.com/store/apps/details?id=com.File.Manager.Filemanager&hl=ru&gl=US ES File Manager]), чтобы пройти по пути:<br> '''/sdcard/Android/data/org.smartplayer.android.client/files/Logs/*''' <br>
If after checking the device remains offline in your account (gray), you can collect logs locally from the device for subsequent transfer to SmartPlayer technical support. To do this, install (or use the standard) file manager (for example: [https://play.google.com/store/apps/details?id=com.File.Manager.Filemanager&hl=ru&gl=US ES File Manager]) to follow the path:<br> '''/sdcard/Android/data/org.smartplayer.android.client/files/Logs/*''' <br>
Вставьте флешку (предварительно отформатировав в fat32) в устройство и скопируйте содержимое всей папки. Далее передайте данные файлы в технический отдел SmartPlayer.
Insert the flash drive (pre-formatted in fat32) into the device and copy the contents of the entire folder. Then transfer these files to the SmartPlayer technical department.


==<span id="selfIdentificationdevice">Determine which account the device belongs to (device identification)</span>==
==<span id="selfIdentificationdevice">Determine which account the device belongs to (device identification)</span>==
Строка 67: Строка 67:
Starting with version v1.33.*, logging on the device is disabled by default. To enable logging, press the '''"Green"''' button on the remote, then open the local console. <br>  
Starting with version v1.33.*, logging on the device is disabled by default. To enable logging, press the '''"Green"''' button on the remote, then open the local console. <br>  


Для открытия локальной консоли устройства с пульта необходимо разблокировать устройство (если заблокирован пульт) и нажать на кнопку '''"Blue"''' на пульте, далее необходимо сфотографировать в хорошем разрешении (чтобы читались строки) и прислать фото в support@smartplayer.org или сотруднику тех. поддержки SmartPlayer <br>
To open the local console of the device from the remote control, you need to unlock the device (if the remote control is locked) and press the '''"Blue"''' button on the remote control, then you need to take a photo in good resolution (so that the lines are readable) and send the photo to support@smartplayer.org or to a SmartPlayer technical support employee <br>


Интерфейс можно скрыть, не дожидаясь таймера нажав '''"Blue"''' на пульте <br>
The interface can be hidden without waiting for the timer by pressing '''"Blue"''' on the remote control <br>
Поддержка платформ: WebOS/SSSP/BrightSign <br>
Supported platforms: WebOS/SSSP/BrightSign <br>


[[Файл:InfoDeviceDebugConsole.png]]
[[Файл:InfoDeviceDebugConsole.png]]


==<span id="localDebugConsoleBrowser">Получение отладочных сообщений от личного кабинета</span>==
==<span id="localDebugConsoleBrowser">Receiving debug messages from your personal account </span> ==
Для анализа, что происходит в личном кабинете достаточно предоставить информацию с двух вкладок инструментов отладки браузера (Network и Console). Откройте в браузере Google Chrome инструменты отладки, нажав F12, далее произведите действие которое вызывает непонятное поведение. После этого скопируйте в текстовый файл вкладки Network и Console. Далее пришлите данные на support@smartplayer.org или ответственному человеку за поддержку в вашем случае в системе технической поддержки.
To analyze what is happening in your personal account, it is enough to provide information from two tabs of the browser debugging tools (Network and Console). Open the debugging tools in the Google Chrome browser by pressing F12, then take an action that causes incomprehensible behavior. After that, take a photo in readable quality of the Network and Console tabs. Next, send the details to support@smartplayer.org or the person in charge of support in your case.
[[Файл:DebugConsoleBrowser.png|мини|центр]]
[[Файл:DebugConsoleBrowser.png|мини|центр]]


==<span id="howIcanGetServerUrl">Как узнать адрес / версию серверного в платформе и личного кабинета SmartPlayer</span>==
==<span id="howIcanGetServerUrl">How to find out the address / version of the server in the platform and personal account SmartPlayer</span>==
Для определения адреса серверного приложения, необходимо зайти в личный кабинет
To determine the address of the server application, you need to go to your personal account
[[Файл:Screenshot from 2024-06-03 17-56-18.jpg|безрамки|центр]]
[[Файл:Screenshot from 2024-06-03 17-56-18.jpg|безрамки|центр]]
and go to the "Settings" tab, scroll down the page and click the "About software" hyperlink.
и перейти в вкладку "Настройки", прокрутить вниз страницы и нажать гиперссылку "О программном обеспечении".
[[Файл:Screenshot from 2024-06-03 17-58-21.png|безрамки|центр]]
[[Файл:Screenshot from 2024-06-03 17-58-21.png|безрамки|центр]]


Вы попадете на страницу, где есть таблица и удобная кнопка чтобы её скопировать. Нажмите кнопку "Скопировать таблицу" и передайте информацию сотруднику запросившему её.
You will be taken to a page with a table and a button to copy it. Click the "Copy table" button and pass the information to the employee who requested it.
[[Файл:Screenshot from 2024-06-03 17-59-23.png|безрамки|центр]]
[[Файл:Screenshot from 2024-06-03 17-59-23.png|безрамки|центр]]

Текущая версия от 16:58, 6 октября 2024

Другие языки:

Debugging Tools

SmartPlayer platform provides many tools for debugging when an abnormality occurs.

Getting log from device (logs)

Each client application writes an event log to its internal device memory, if necessary, it can be obtained and sent for analysis to SmartPLayer technical support, to get the most useful logs, do the following:

  1. In the device settings (Select device -> In the right toolbar Settings), when it is in online status (green), enable the Debug or Trace logging mode. This will configure the device so that it writes more detailed messages about its operation
  2. Try to reproduce the abnormal situation on the device
  3. Go to the device card (Select device -> Info in the right toolbar) and download the archive with the log.

There are two parameters:

  • current - the archive with the event log for the current day will be unloaded, as a result of its smaller size. If the network is unstable, the best choice.
  • full - the archive with the event log for several days will be unloaded. It can transmit a large amount of data, the network should be more stable.

Getting full device information

Each client application contains full device information, to get it, do the following:

  1. Log in to your account with your credentials
  2. Go to the "Devices" menu tab
  3. Select a device (by clicking on it or in the list), without checking the box
  4. The device menu will open on the right, select the Information menu item
  5. In the open device card, click on the "copy to clipboard" icon (in the upper right corner)

The data is copied to the clipboard for further pasting into the required document.

Download broadcast

To analyze the broadcast playback, you can download it from your personal account and send it to SmartPlayer for analysis. To do this, do the following:

  1. Log in to your personal account
  2. Go to the "Broadcasts" menu item
  3. Select the desired broadcast
  4. In the right toolbar, click the icon - "Download"

After the download starts, depending on the size of the broadcast, we wait for it to download to the working computer. Then you need to transfer the archive without modification when you open a request on the technical support portal.

Clearing the device

Clearing the device allows you to delete all application data recorded using the SmartPlayer software, these actions reset the application cache. Re-registration of the device is not required. Go to the device card (Select device -> Information in the right toolbar) and click the "clear" icon, you will be offered two options to choose from:

  • Delete all files on the device - this option deletes media files downloaded for offline playback of content. The next time you start the application, if the current broadcast is not cached on the device, the files will be downloaded again.
  • Clear local storage - this option deletes metadata required for offline playback. The next time you start the application, if there is not enough metadata for the current broadcast, they will be obtained from the SmartPlayer server.

Depending on the operating system of the client application, it will either be rebooted or restarted.

Download the log of the Android OS device in offline mode

If the device does not connect to the server, first check the device's access to the server. To do this, simply open the built-in browser on the Android OS device and enter the server address. If the connection goes to https://cms.smartplayer.org, then enter https://api.smartplayer.org as a result, the message Cannot GET / should appear, this means that the device "sees" the server.

If after checking the device remains offline in your account (gray), you can collect logs locally from the device for subsequent transfer to SmartPlayer technical support. To do this, install (or use the standard) file manager (for example: ES File Manager) to follow the path:
/sdcard/Android/data/org.smartplayer.android.client/files/Logs/*
Insert the flash drive (pre-formatted in fat32) into the device and copy the contents of the entire folder. Then transfer these files to the SmartPlayer technical department.

Determine which account the device belongs to (device identification)

To identify the device from the remote control, you need to unlock the device (if the remote control is locked) and press the "1" button on the remote control, the application will show an interface in which:

  1. The device name is indicated (similar to the personal account)
  2. List of accounts participating in the company for which the device is registered
  3. After what time the information will be hidden (in seconds)

The interface can be hidden without waiting for the timer by pressing "2" on the remote control
Platform Support: WebOS / SSSP / BrightSign

Displaying the local console

Sometimes it is not clear what is happening with the device and there is no way to get logs through your personal account, then you need to run the local debug console to get messages about the problem. In the case of Android OS
Starting with version v1.33.*, logging on the device is disabled by default. To enable logging, press the "Green" button on the remote, then open the local console.

To open the local console of the device from the remote control, you need to unlock the device (if the remote control is locked) and press the "Blue" button on the remote control, then you need to take a photo in good resolution (so that the lines are readable) and send the photo to support@smartplayer.org or to a SmartPlayer technical support employee

The interface can be hidden without waiting for the timer by pressing "Blue" on the remote control
Supported platforms: WebOS/SSSP/BrightSign

Receiving debug messages from your personal account

To analyze what is happening in your personal account, it is enough to provide information from two tabs of the browser debugging tools (Network and Console). Open the debugging tools in the Google Chrome browser by pressing F12, then take an action that causes incomprehensible behavior. After that, take a photo in readable quality of the Network and Console tabs. Next, send the details to support@smartplayer.org or the person in charge of support in your case.

How to find out the address / version of the server in the platform and personal account SmartPlayer

To determine the address of the server application, you need to go to your personal account

and go to the "Settings" tab, scroll down the page and click the "About software" hyperlink.

You will be taken to a page with a table and a button to copy it. Click the "Copy table" button and pass the information to the employee who requested it.