Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 30 additions & 10 deletions docs/support/docs/HOBL_Scenarios.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,27 @@ Preforms various tasks that prepare a device for testing. This includes queuing

`final_reboot` - Sets if the device will reboot at the conclusion of process_idle_tasks **Default:** `1` **Options:** `0, 1`

## standby

Puts the device into standby mode, still conneccted to the network.


<u>Parameters:</u>

`cs_duration` - **Default:** `1200`

`button_to_record_delay` - **Default:** `900`

`button_sleep_callback` - **Default:** ``

`button_wake_callback` - **Default:** ``

`local_button` - **Default:** `1`

`sleep_mode` - **Default:** ``

`connection` - Connected or Disconnected from the network during standby **Default:** `Connected` **Options:** `Disconnected, Connected`

## system_prep

Preforms various tasks that prepare a device for testing.
Expand Down Expand Up @@ -595,23 +616,22 @@ Steps:

`full_screen` - Full Screen mode **Default:** `0` **Options:** `0, 1`

## youtube25
## brightness_study_report

Plays a YouTube video in a web browser in Default View mode.
Extract brightness value from a path containing a Brightness-XX folder.

Steps:

1. Navigate to Tears of Steel YouTube video URL: [youtu.be/41hv2tW5Lc4](https://youtu.be/41hv2tW5Lc4)
2. Change video quality to 1080p.
3. Let video play for specified duration and loops.
4. Close web browser.
<u>Parameters:</u>

`result_path` - **Default:** ``

<u>Parameters:</u>
`name` - **Default:** ``

`device_name` - **Default:** ``

`duration` - **Default:** `600`
`backlight_key` - Metric name for backlight power in brightness curve report. **Default:** `DisplayLight Power (W)`

`loops` - **Default:** `1`
`analog_key` - Metric name for analog/panel power in brightness curve report. **Default:** `DisplayLogic Power (W)`

## comm_check

Expand Down
12 changes: 12 additions & 0 deletions docs/support/docs/HOBL_Setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,3 +104,15 @@ Set up a Device Profile for each DUT in the HOBLweb UI, giving it a unique name
1. Run Cmd or Powershell on the Host, and make sure sure DUT responds to pings: `ping <dut_ip>`
1. Make sure DUT can ping host as well.
1. Run the "comm_check" scenario to make sure that all communications needs are met.

One thing to be aware of on Mac is that as icon count in the dock increases, macos reduces their size so that they all fit. However, in our automation we need them to stay constant size for proper image matching. So the solution is remove unneeded icons to make sure there is plenty of space on the left and right of the dock. So you might need to remove a few unused ones, such as Calendar, Reminders, etc. Make sure the dock is always visible.


Verify these settings have been set in System Settings -> Privacy & Security:
- Files & Folders -> SimpleRemoteconsole:
- Documents Folder
- Downloads Folder
- Accessibility -> SimpleRemoteConsole
- Local Network -> SimpleRemoteConsole
- Screen & System Audio Recording -> SimpleRemoteConsole

7 changes: 7 additions & 0 deletions docs/support/docs/HOBL_Tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ Pause run and recharge device when battery drops below [charge_threshold], then

`resume_threshold` - **Default:** `95`

`post_charge_delay` - How many seconds to wait after reaching the resume_threshold before disconnecting charger. **Default:** `1800`

`charge_on_call` - **Default:** ``

`charge_off_call` - **Default:** ``
Expand Down Expand Up @@ -441,6 +443,11 @@ Record periodic screen shots, for debug purposes.

Records a screen cast from the DUT for debug purposes. Has considerable power impact.


<u>Parameters:</u>

`device_index` - MacOS-only. 1 for older or non-Pro macbooks **Default:** `2` **Options:** `1, 2`

## serialize_copyback

Deprecated.
Expand Down
50 changes: 35 additions & 15 deletions docs/support/site/HOBL_Scenarios.html
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,13 @@
process_idle_tasks
</a>

</li>

<li class="md-nav__item">
<a href="#standby" class="md-nav__link">
standby
</a>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -411,8 +418,8 @@
</li>

<li class="md-nav__item">
<a href="#youtube25" class="md-nav__link">
youtube25
<a href="#brightness_study_report" class="md-nav__link">
brightness_study_report
</a>

</li>
Expand Down Expand Up @@ -579,6 +586,13 @@
process_idle_tasks
</a>

</li>

<li class="md-nav__item">
<a href="#standby" class="md-nav__link">
standby
</a>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -666,8 +680,8 @@
</li>

<li class="md-nav__item">
<a href="#youtube25" class="md-nav__link">
youtube25
<a href="#brightness_study_report" class="md-nav__link">
brightness_study_report
</a>

</li>
Expand Down Expand Up @@ -769,6 +783,16 @@ <h2 id="process_idle_tasks">process_idle_tasks</h2>
<p><code>loops</code> - Number of times the automation will attempt to perform tasks <strong>Default:</strong> <code>3</code> </p>
<p><code>run_idle_tasks</code> - Queues Windows idle tasks so they will not be running during tests <strong>Default:</strong> <code>1</code> <strong>Options:</strong> <code>0, 1</code></p>
<p><code>final_reboot</code> - Sets if the device will reboot at the conclusion of process_idle_tasks <strong>Default:</strong> <code>1</code> <strong>Options:</strong> <code>0, 1</code></p>
<h2 id="standby">standby</h2>
<p>Puts the device into standby mode, still conneccted to the network.</p>
<p><u>Parameters:</u></p>
<p><code>cs_duration</code> - <strong>Default:</strong> <code>1200</code> </p>
<p><code>button_to_record_delay</code> - <strong>Default:</strong> <code>900</code> </p>
<p><code>button_sleep_callback</code> - <strong>Default:</strong> `` </p>
<p><code>button_wake_callback</code> - <strong>Default:</strong> `` </p>
<p><code>local_button</code> - <strong>Default:</strong> <code>1</code> </p>
<p><code>sleep_mode</code> - <strong>Default:</strong> `` </p>
<p><code>connection</code> - Connected or Disconnected from the network during standby <strong>Default:</strong> <code>Connected</code> <strong>Options:</strong> <code>Disconnected, Connected</code></p>
<h2 id="system_prep">system_prep</h2>
<p>Preforms various tasks that prepare a device for testing.</p>
<p><u>Parameters:</u></p>
Expand Down Expand Up @@ -1009,18 +1033,14 @@ <h2 id="youtube">youtube</h2>
<p><code>duration</code> - Total scenario duration <strong>Default:</strong> <code>600</code> </p>
<p><code>loop_duration</code> - YouTube video playback duration before looping (max 480s) <strong>Default:</strong> <code>300</code> </p>
<p><code>full_screen</code> - Full Screen mode <strong>Default:</strong> <code>0</code> <strong>Options:</strong> <code>0, 1</code></p>
<h2 id="youtube25">youtube25</h2>
<p>Plays a YouTube video in a web browser in Default View mode.</p>
<p>Steps:</p>
<ol>
<li>Navigate to Tears of Steel YouTube video URL: <a href="https://youtu.be/41hv2tW5Lc4">youtu.be/41hv2tW5Lc4</a></li>
<li>Change video quality to 1080p.</li>
<li>Let video play for specified duration and loops.</li>
<li>Close web browser.</li>
</ol>
<h2 id="brightness_study_report">brightness_study_report</h2>
<p>Extract brightness value from a path containing a Brightness-XX folder.</p>
<p><u>Parameters:</u></p>
<p><code>duration</code> - <strong>Default:</strong> <code>600</code> </p>
<p><code>loops</code> - <strong>Default:</strong> <code>1</code> </p>
<p><code>result_path</code> - <strong>Default:</strong> `` </p>
<p><code>name</code> - <strong>Default:</strong> `` </p>
<p><code>device_name</code> - <strong>Default:</strong> `` </p>
<p><code>backlight_key</code> - Metric name for backlight power in brightness curve report. <strong>Default:</strong> <code>DisplayLight Power (W)</code> </p>
<p><code>analog_key</code> - Metric name for analog/panel power in brightness curve report. <strong>Default:</strong> <code>DisplayLogic Power (W)</code> </p>
<h2 id="comm_check">comm_check</h2>
<p>Checks for valid communications between host and DUT.</p>
<p>Steps:</p>
Expand Down
33 changes: 25 additions & 8 deletions docs/support/site/HOBL_Setup.html
Original file line number Diff line number Diff line change
Expand Up @@ -554,28 +554,45 @@ <h2 id="dut-setup-for-windows">DUT Setup For Windows</h2>
</li>
<li>Test network connection to the DUT:<ol>
<li>Host and DUT need to be on the same subnet (first 2 octets of the IP address).</li>
<li>Run Cmd or Powershell on the Host.</li>
<li>Make sure sure DUT responds to pings: <code>ping &lt;dut_ip&gt;</code></li>
<li>Run Cmd or Powershell on the Host, and make sure sure DUT responds to pings: <code>ping &lt;dut_ip&gt;</code></li>
<li>Make sure DUT can ping host as well.</li>
<li>Run the "comm_check" scenario to make sure that all communications needs are met.</li>
</ol>
</li>
</ol>
<h2 id="dut-setup-for-macos">DUT Setup For macOS</h2>
<ol>
<li>Manually make sure the device is onnected to the appropriate Wi-Fi netowrk, on the same subnet as the Host.</li>
<li>After running host_setup.exe, dut_setup.sh should be found in the /downloads/Setup folder. Copy dut_setup.sh from here to a USB stick.</li>
<li>Plug the USB stick into the DUT and execute dut_setup.sh.</li>
<li>There will be numerous prompts for password and to enable various security items. It's critical to enable all.</li>
<li>Manually set up the Mac with an account and connect the device to the appropriate Wi-Fi netowrk, on the same subnet as the Host.</li>
<li>If Global Secure Access app exists, disable it. It prevents peer-to-peer communication.</li>
<li>Change settings to do auto-login:
a. System Settings -&gt; Users &amp; Groups -&gt; Automatically log in as: specify account and password</li>
<li>Copy hobl\downloads\setup\dut_setup_<ver>.sh to Mac using a FAT32 formatted USB stick, and execute from terminal window. You will be prompted for password and access permissions multiple times. Be sure to enable everything. If you don't see dut_setup_\<ver>.sh in the hobl\downloads\setup folder, then do <a href="#host-setup">Host Setup</a>.</li>
<li>Either disable firewall, or disable "Stealth Mode" in Firewall Options (to allow pings to go through)</li>
<li>Use light meter to adjust screen brightness to 150 nits, on DC with white background. Then run /users/Shared/hobl_bin/brightness -l to report setting level. Multiply that fraction by 100 to turn to percentage, to set display:brightness in profile.</li>
<li>Leave audio level at out-of-box setting.</li>
<li>The first time you run some tests or tools there may be various permissions popups. Manually allow them all. Then subsequent runs should work without interference.</li>
<li>Set keyboard shortcut Shift-Cmd-H to Safari "Clear History…"
a. Settings -&gt; Keyboard -&gt; Keyboard Shortcuts -&gt; App Shortcuts
b. Application: "Safari"
c. Menu title: "Clear History…" (the three dots are critical)
d. Keyboard shortcut: "Shift-Cmd-H"</li>
<li>Set Safari history clear to "All History"</li>
<li>Test network connection to the DUT:<ol>
<li>Host and DUT need to be on the same subnet (first 2 octets of the IP address).</li>
<li>Run Cmd or Powershell on the Host.</li>
<li>Make sure sure DUT responds to pings: <code>ping &lt;dut_ip&gt;</code></li>
<li>Run Cmd or Powershell on the Host, and make sure sure DUT responds to pings: <code>ping &lt;dut_ip&gt;</code></li>
<li>Make sure DUT can ping host as well.</li>
<li>Run the "comm_check" scenario to make sure that all communications needs are met.</li>
</ol>
</li>
</ol>
<p>One thing to be aware of on Mac is that as icon count in the dock increases, macos reduces their size so that they all fit. However, in our automation we need them to stay constant size for proper image matching. So the solution is remove unneeded icons to make sure there is plenty of space on the left and right of the dock. So you might need to remove a few unused ones, such as Calendar, Reminders, etc. Make sure the dock is always visible.</p>
<p>Verify these settings have been set in System Settings -&gt; Privacy &amp; Security:
- Files &amp; Folders -&gt; SimpleRemoteconsole:
- Documents Folder
- Downloads Folder
- Accessibility -&gt; SimpleRemoteConsole
- Local Network -&gt; SimpleRemoteConsole
- Screen &amp; System Audio Recording -&gt; SimpleRemoteConsole</p>



Expand Down
3 changes: 3 additions & 0 deletions docs/support/site/HOBL_Tools.html
Original file line number Diff line number Diff line change
Expand Up @@ -1129,6 +1129,7 @@ <h2 id="auto_recharge">auto_recharge</h2>
<p><u>Parameters:</u></p>
<p><code>charge_threshold</code> - <strong>Default:</strong> <code>40</code> </p>
<p><code>resume_threshold</code> - <strong>Default:</strong> <code>95</code> </p>
<p><code>post_charge_delay</code> - How many seconds to wait after reaching the resume_threshold before disconnecting charger. <strong>Default:</strong> <code>1800</code> </p>
<p><code>charge_on_call</code> - <strong>Default:</strong> `` </p>
<p><code>charge_off_call</code> - <strong>Default:</strong> `` </p>
<h2 id="battery_bar">battery_bar</h2>
Expand Down Expand Up @@ -1328,6 +1329,8 @@ <h2 id="screenshot">screenshot</h2>
<p><code>pause</code> - <strong>Default:</strong> <code>0</code> </p>
<h2 id="screen_record">screen_record</h2>
<p>Records a screen cast from the DUT for debug purposes. Has considerable power impact.</p>
<p><u>Parameters:</u></p>
<p><code>device_index</code> - MacOS-only. 1 for older or non-Pro macbooks <strong>Default:</strong> <code>2</code> <strong>Options:</strong> <code>1, 2</code></p>
<h2 id="serialize_copyback">serialize_copyback</h2>
<p>Deprecated.</p>
<p><u>Parameters:</u></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/support/site/search/search_index.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/support/site/search/search_index.json

Large diffs are not rendered by default.

Binary file modified docs/support/site/sitemap.xml.gz
Binary file not shown.