You are using an ad blocker that is interfering with our web typography and internal javascript. Please whitelist our domain to live in a more beautiful world. No ads here, just really great software!

April 2nd Webinar: Remote Working – Putting the Employee First Register Now

cookie alert

We use cookies to offer you a better browsing experience, analyze site traffic, personalize content, and serve targeted advertisements. If you continue to use this site, you consent to our use of cookies.

Nexthink Library

Battery Status

Get the battery status to diagnose battery health, capacity for possible replacements and modify power plan.

Get Battery Status Set Power Plan

Content

Campaigns - 1
Remote actions - 2

Required Modules

Nexthink Act
Nexthink Engage

Platforms

Windows 10

Compatibility

V6.14 and later
Install

Description

Determine the health status of laptops' batteries in terms of capacity that they can still hold, identify which batteries need to be replaced and optimize the power settings of devices. Also change the power plan to optimize battery usage.

  • 2.0.0.0 - 23 Mar 2020 - Added "Set Power Plan" Remote Action
  • 1.3.0.0 - 17 Mar 2020 - Updated "Get Battery Status" Remote Action and documentation
  • 1.2.0.0 - 02 Mar 2020 - Updated "Get Battery Status" Remote Action
  • 1.1.0.0 - 20 Jun 2019 - Major refactoring and bugfixing of Get Battery Status Remote Action
  • 1.0.0.0 - Initial release

Get Battery Status

Script Description

Returns the health status of the battery installed on the laptop, in terms of capacity that it can still hold. It also retrieves the currently active power plan. Useful for identifying the batteries to be replaced and optimize the power settings of the devices.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed manually.

A timeout of 120 seconds is recommended.

Parameters

None.

Outputs

Label Type Description
Battery Health Ratio Health ratio, expressed as a percentage
Battery Designed Capacity Int Initial capacity, in milliamp hour (mAh)
Battery Full Charge Capacity Int Current full charge capacity, in milliamp hour (mAh)
Battery Cycle Count Int Number of charge cycles the battery has so far
Estimated Battery Life Millisecond Estimated battery life time with one full charge
Power Plan String The power plan which is currently active on the device. It will display "Custom" if the power plan is not any of the default ones (Balanced, High performance, Power saving) and it will display "Unknown" in the case the information could not be retrieved

Restrictions

Test Scenarios

OneBattery
Test Case Device has one battery
Environment Windows 10 x64 (English)
Results Successful - The output fields show correct data
NoBattery
Test Case Device has no battery
Environment Windows 10 x64 (English), VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Failure - The battery in this device cannot be detected
UnsupportedOperatingSystem
Test Case Device has Windows 7 installed
Environment Windows 7 x86 (English), VM Windows 7 x86/x64 (Multi-language)
Results Failure - The remote action is only compatible with Windows 10

Set Power Plan

Script Description

Sets the device power plan (Balanced, High performance or Power saver) on Windows Configuration. By default the user will be asked before changing their current power plan.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed manually.

A timeout of 120 seconds is recommended.

Parameters

Label Description
Campaign Id GUID of the campaign that ask the user if they want to change their plan. Use an empty GUID (00000000-0000-0000-0000-000000000000) to avoid asking the user and force the change
Power Plan To Set Power plan to set. Valid values are Balanced, High performance and Power saver

Outputs

None.

Restrictions

Test Scenarios

AcceptedCampaign
Test Case Device power plan is different than PowerPlanToSet.
The user accepts to change the power plan through the campaign.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - The power plan is correctly modified.
NoCampaign
Test Case Device power plan is different than PowerPlanToSet.
CampaignId is 00000000-0000-0000-0000-000000000000.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - The power plan is correctly modified.
RejectedCampaign
Test Case Device power plan is different than PowerPlanToSet.
The user rejects to change the power plan through the campaign.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - The power plan was not modified because the user rejected the campaign.
NoChangeNeeded
Test Case Device power plan is the same that PowerPlanToSet.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - The recommended power plan was already configured.
Thank you!