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!

Experience Everywhere On-Demand: Learn how Global 2000 firms are approaching Digital Employee Experience in 2021. Get Access

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

Latest Version: 4.0.0.0
Install

Content

Campaigns - 1
Remote actions - 3
Get Battery Status Get Multiple Batteries Status Set Power Plan

Required Products

Nexthink Act
Nexthink Engage

Platforms

Windows 10
Windows 7

Compatibility

V6.14 and later

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.

Versions

  • 4.0.0.0 - 23 Mar 2021 - Added macOS compatibility for the "Get Battery Status" Remote Action
  • 3.0.2.0 - 15 Jul 2020 - Updated "Get Battery Status" Remote Action
  • 3.0.1.0 - 08 May 2020 - Updated "Set Power Plan" Campaign to be compatible with previous Nexthink Finder versions
  • 3.0.0.0 - 17 Apr 2020 - Added "Get Multiple Batteries Status" Remote Action
  • 2.1.0.0 - 02 Apr 2020 - Updated "Get Battery Status" Remote Action
  • 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, for Windows devices, 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. It will be 0 on Windows 7 devices
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
Battery information List StringList List with all available information from the battery

Restrictions

Test Scenarios

OneBattery
Test Case Device has one battery
Environment Windows 7 Pro x86 (English), Windows 10 x64 (English)
Results Successful - The output fields show correct data
NoBattery
Test Case Device has no battery
Environment VM Windows 7 x86/x64 (Multi-language), VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Failure - The battery on this device cannot be detected
DevicePluggedIn
Test Case The device has a battery and is plugged in.
Environment macOS 10.14 EN
Results Success - The information is gathered execpt for the estimated battery life which is 0.
DeviceNotPluggedIn
Test Case The device has a battery and is drawing energy from it.
Environment macOS 10.14 EN
Results Success - The information is gathered including the estimated battery life.

Get Multiple Batteries Status

Script Description

Returns the health status of the batteries installed on the laptop, in terms of capacity that they 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
Battery1 Health Ratio Health ratio for battery 1, expressed as a percentage
Battery1 Designed Capacity Int Initial capacity for battery 1, in milliamp hour (mAh)
Battery1 Full Charge Capacity Int Current full charge capacity for battery 1, in milliamp hour (mAh)
Battery1 Cycle Count Int Number of charge cycles the battery 1 has so far
Battery2 Health Ratio Health ratio for battery 2, expressed as a percentage
Battery2 Designed Capacity Int Initial capacity for battery 2, in milliamp hour (mAh)
Battery2 Full Charge Capacity Int Current full charge capacity for battery 2, in milliamp hour (mAh)
Battery2 Cycle Count Int Number of charge cycles the battery 2 has so far
Estimated Battery Life Millisecond Estimated life time with one full charge. It will be 0 on Windows 7 devices
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 7 Pro x86 (English), Windows 10 x64 (English)
Results Successful - The output fields show correct data
NoBattery
Test Case Device has no battery
Environment VM Windows 7 x86/x64 (Multi-language), VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Failure - The battery on this device cannot be detected

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!