Mini-box.com Wiki Page - User contributions [en]

OpenUPS2

2026-03-03T12:08:02Z

Admin: /* Bootloader Mode */

'''11-24V Intelligent DC-DC Uninterruptible Power Supply using LiFePO4'''<br><br>
'''New Feature 13-24V Intelligent DC-DC Uninterruptible Power Supply using Li-Ion (section 7.6)'''<br><br>
'''Before you start…<br>
Often times, rushing into installing the unit can result in serious damage to your OPENUPS2 board or computer. Always double check the polarity of your wires with a voltmeter.<br><br>
'''Always double check the polarity of the batteries before introducing into the UPS device.'''<br>
'''Improper configuration leads to system damage!!!'''<br>
Use batteries from same lot, same age with same resting voltage for best results.<br>
<br>

==Introduction==
The '''openUPS2''' was designed to provide user specified regulated power output from a wide input voltage, battery backup, [http://en.wikipedia.org/wiki/Lithium_iron_phosphate_battery LiFePO4] (18650 size) battery charging and cell balancing in a single PCBA.<br>
Battery cells are integrated in the device, no need for special cabling between cells and UPS.<br>
The UPS contains a synchronous boost Converter with high accuracy voltage and current regulation and automatic system power path selection from adapter or battery.<br>
It charges the battery in three phases: preconditioning, constant current/constant voltage mode. <br>
The unit can be used as an embedded UPS or as a Portable Energy Pack providing user regulated 12V-24V wherever is needed.

==Features==
'''openUPS2 features include:'''<br>

* USB interface, works with Windows devices (Linux API planned)<br>
* SMBUS slave<br>
* Input between 11-24V<br>
* Programmable voltage thresholds<br>
* Generate any output voltage between 12-24V, booster based design<br>
* Supports LiFePO4 (3.2V) battery chemistry<br>
* Supports Li-Ion (3.7V) battery chemistry<br>
* 3 state charger(precharge,constant current/constant voltage)<br>
* Balances 3 series batteries.<br>
* Charge voltage 3x3.5V, charge current 1A, precharge current 0.3A<br>
* Coulomb counting<br>
* Battery temperature monitoring for each cell and temperature compensated charging<br>
* Start/Stop button<br>
* Relay output<br>
* External LED connection<br>
* Motherboard ON/OFF pulse control*<br>
* Missing battery cells detection<br>
* Ultra low power consumption(1uA- in Deep Sleep mode) or (530uA- in Sleep mode)<br>
* Windows detects device as “Battery”, no special drivers required **
* [http://wiki.mini-box.com/images/9/9e/OPENUPS2_Dimensions.PDF Physical dimensions]

<span style="display: block; width: 80%; margin-left: 0px; margin-right: 20px; padding: 10px; background-color: #FEFEFE; border: 1px dotted black;">
'''<nowiki>*</nowiki> MotherBoard ON/OFF control'''<br>
The device is able to send ON/OFF 'pulse signals' to motherboard based on coulomb counter and/or battery voltage level, or based on input voltage level or when starting by button<br>
'''<nowiki>**</nowiki> Windows “no driver support”'''<br>
Installs itself as a battery in Windows, using the Windows hid driver without any driver installation, visible as an icon in tray bar.
</span>

==Diagram & Schematics==
'''Pin1 is marked with red color.'''
<div style="display: inline; float: left;">[[File:Connection-diagram.png|230px|thumb|left|Connection diagram]]</div><div style="display: inline; float: left;">[[File:Block-schematic-of-the-UPS.jpg|195px|thumb|left|Block schematics of the UPS]]</div>
<div style="clear: both;"></div>
'''3D Step Model''' - [http://arm.mini-box.com/releases/OPENUPS2_2014_jun_11.step.zip download]
<div style="clear: both;"></div>

==Connectors==
===Power Input connectors===
;P1 Input (4pin mini-FIT JR)
: P1.1,P1.2-GND
: P1.3,P1.4-Input voltage
;P2 Output (4 pin mini-FIT JR)
: P2.1,P2.2-GND
: P2.3,P2.4-Output voltage
===Interface connectors===
;P3 USB header (JST PH connector, 5pin)
: P3.1: +5V
: P3.2: USB D-
: P3.3: USB D+
: P3.4: NC
: P3.5: GND
;P4 bottom side programming header, bootloader jumper, MCU reset (POGO pins)
: P4.1: nMCLR
: P4.2: GND
: P4.3: +3.3V
: P4.4: PGD
: P4.5: PGC
;P6 Motherboard POWER SW connection, no polarity (JST PH connector, 3pin)
: P6.1: SW1
: P6.2: GND
: P6.3: SW2
;P7 External Led header in parallel connection with D10 (JST PH connector, 2pin)
: P7.1: Cathode connection
: P7.2:+3.3V, Anode connection
;P8 SMBUS slave header (JST PH connector, 4pin)
: P8.1: +3.3V
: P8.2: SMBUS CLOCK
: P8.3: SMBUS DATA
: P8.4: GND
;P9 Relay output (JST PH connector, 2pin)
;P10 Start/Stop button header (JST PH connector, 2pin)

===Display connectors===
<div style="display: inline; float: left;">'''Relay output'''<br>
[[File:Relay-connection.png‎|200px|thumb|left|Relay Connection]]
</div>
<div style="display: inline; float: left;">'''D10 Green Led, in parallel with P7'''<br>
[[File:ExternalLED.png|155px|thumb|left|External LED]]</div>
<div style="clear: both;"></div>

==Bootloader Mode==
It is recommended that you only connect USB power to the device
when making a firmware update via “bootloader mode”.
There are two ways to enter in bootloader mode: 1a) or 1b).<br>
1a) Short connections between P4.4 and P4.5, than connect the unit to USB to enter bootloader mode '''OR'''<br>
1b) Press the Enter Bootloader button on the configuration software's user interface.<br>
2) Start the [https://arm.mini-box.com/releases/exe/HIDBootLoader.zip '''HIDBootLoader.exe'''] software provided to flash the new firmware.<br>
3) Press Open new Hex File for [https://wiki.mini-box.com/images/e/e7/OpenUPS_2_-FW_ver_1.5_for_loading_with_bootloader_for_Li-FePo4_2017_oct_22.zip '''LiFePO4''']
or new Hex File for [https://wiki.mini-box.com/images/7/73/OpenUPS_2_-FW_ver_1.6_for_loading_with_bootloader_for_Li-Ion_2017_oct_06.zip '''LiIon'''] .<br>
4) Locate the hex file and open it.<br>
5) Press Program/Verify.<br>
6) Press Reset Device.<br>
7) After the device reconnects on USB with the configuration software the new firmware version will be displayed in the title bar of the software.<br>

==Getting started==
Before you start you would need to connect the unit to USB and configure:<br>
- Mode of Operation<br>
- battery capacity (default is 1000mAh)<br>
- output voltage (default is 12V)<br>
- Low power mode (default is Sleep mode) see UPSCONFIG2 parameter for detail
- other advanced configuration parameters if needed<br><br>
'''NOTE''': After changing parameters the device needs to be restarted so the new configuration becomes active. Restart the UPS by pressing the restart button in the user configuration software. It is recommended to disconnect large loads at the output of the UPS before pressing the restart button on the user interface.<br>

<font color="red">'''Warning''': Improper configuration (ex: wrong under-voltage, over-voltage), reverse polarity can lead to battery damage or your system damage (ex: wrong output value)</font>

==UPS Configuration==

The UPS can behave differently depending on settings. The OPENUPSMODE parameter sets this behaviour.
0-Autorestart when input is present=yes (UPS)
1-Autorestart when input is present=no (LAPTOP)
2-Energy Pack mode (ON/OFF)

===Mode 0 and 1===
:When using the UPS embedded in a system together with a motherboard the modes 0 and 1 should be used.
:Connect USB header P3 to the motherboard's internal USB header. USB connection is used to sense the motherboard's ON or OFF state.
:Connect P6 header's 1 and 3 pins to the motherboard's POWER SW header. (cable provided). Connect P10 header to a push button. This push button completely eliminates the need for any additional buttons to start or stop your system.

;Starting your system

: Mode 0 - when adapter input voltage is present a momentary pulse is sent through P6 header starting your system immediately.
: Mode 1 - the momentary pulse is not sent and your system will not be started but battery charging is possible just like in a laptop.
===Mode 2===
::In this mode the UPS can be a portable energy pack. Shutting down the UPS does not depend on USB connection. With the use of a push button connected to the P10 header you can instantly start and stop the UPS's output when running on battery. Connecting input power will charge the pack just like in any other modes. It also acts as an UPS providing uninterrupted output in this mode. This mode is recommended for powering devices other than motherboards or for portable energy use when working on the field and regulated 12-24V power is needed from batteries.

;Stopping your system
: When your system is up and running you can always stop it by pressing again on the push button or by shutting down from the OS(Operating System).<br>In case your system is on battery and under-voltage situation is present it will be automatically shut down.
: When the system is on battery and it is shut down by OS the UPS can also immediately shut down to preserve battery. This is a configurable feature.
: When the UPS runs on batteries for a predefined time can initiate a shut down sequence. This is configurable feature.

NOTES:
- When the UPS is shutting down it senses the motherboard's state by measuring the +5VUSB signal.
If the motherboard was shut down by the OS (+5VUSB is not present) no pulse will be sent.
- When shutting down from battery If the OS does not graciously shut down during
predetermined UPS_HARDOFF_TOUT (60s by default) the motherboard will be forced off
by turning off the UPS's output in order to conserve the battery.

===Output configuration===
There are two ways of setting the output voltage.<br>
1)If bit0 in UPS_CONFIG parameter is set to '1' the output value is set by the OUT_VOLTAGE parameter.(default is 12V)<br>
2)If bit0 in UPS_CONFIG is set to '0' the the output value is set by the configuration switch P5 on the back side of the unit.<br>
:The hardcoded values depending the switches position are:

{| class="wikitable" style="text-align: center; color: blue;"

|'''P5.1'''||'''P5.2'''||'''P5.3'''||'''OUTPUT[V]'''
|-
||OFF||OFF||OFF||12V
|-
||OFF||OFF||ON||13.5V
|-
||OFF||ON||OFF||15V
|-
||OFF||ON||ON||16V
|-
||ON||OFF||OFF||18V
|-
||ON||OFF||ON||19V
|-
||ON||ON||OFF||21V
|-
||ON||ON||ON||24V
|-
|}

The second method is useful when using the UPS in '''Mode 2''' as a Portable Energy Pack on the field to configure the required output voltage.

===Temperature compensated charge current regulation===
:The temperature threshold parameters can be adjusted from software.
:The configurable parameters are: CHG_TEMP_COLD < CHG_TEMP_COOL < CHG_TEMP_WARM < CHG_TEMP_HOT.
:[[File:Charge-regulation.png|325px|thumb|left|]]
<div style="clear: both;"></div>

===Setting Power plans under Windows Operating Systems (Vista, Windows 7)===
:1) Right click on the battery icon from the tray bar then choose power options from the context menu. Alternatively you can choose '''Power Option''' also from '''Control Panel''' Items.
:2) Select/Create a power plan or modify existing ones.
:3) In the '''Change Advanced Power Settings''' section, the critical and low battery levels and actions can be also modified

===NEW FEATURE, Configuring OPENUPS2 to work with Li-ION 3.7V===
:'''Recomended input power supply should provide >=13V and capable of providing at least 1A for charging + the current needed to sustain the required output power. Using a 12V power supply is not recomended for Li-ION since the input would be close to battery voltage or lower and the batteries can't be charged enough and the system will run mostly on batteries.'''
:''PCB changes:''
:Resistor R20 should be changed to 576k, charge voltage is set to 12.168V (3x4.056V)
:Proposed part number and description: RES 576K OHM 1/10W 1% 0603 SMD
:http://www.digikey.com/product-detail/en/RC0603FR-07576KL/311-576KHRTR-ND/727311
[[File:PCB_change_for_Li-Ion_3.7V.PNG]]
:''Firmware and parameter changes:''
:'''Update the device with Li-Ion version of firmware which includes support for Li-Ion chemistry!'''
:'''It can be downloaded from''' [http://resources.mini-box.com/online/PWR-OpenUPS2/firmware/PWR-OpenUPS2-firmware-1-3-bootloader-Li-ION-2014_09_09.zip]
:''The default parameters for Li-Ion are as below:''
:UPS_VCELL_MIN_START =3.6V
:UPS_VCELL_MIN_STOP =3.3V
:UPS_VCELL_MIN_HARD_STOP=3V
:CHG_VCOND=3.3V
:CHG_BULK_STOP_VOLTAGE= 4.1V
:CHG_START_VOLTAGE=3.85V
:CHG_GLOBAL_TOUT=240
:BAL_VCELL_MIN=3.4V
:CAPACITY=2400mAH, should be changed to match the cell's capacity
:OCV_SOC0=3.3V
:OCV_SOC10=3.68V
:OCV_SOC25=3.76V
:OCV_SOC50=3.82V
:OCV_SOC75=3.97V
:OCV_SOC100=4.17V
:Feel free to adjust these parameters if needed

==Connecting DC input power==
Connect a proper input voltage source to the P1 connector.<br>
If input voltage is present , the UPS will enable the proper power path and energy will be flowing from input to output and, if necessary, battery charging is started.<br>
A gratuitous pulse is sent through P6 to wake up the motherboard depending configured '''Mode'''.<br>
Each cell is carefully monitored so that in case of an under-voltage or over-voltage event proper actions are taken. <br>
The charger is a BUCK converter so in order to charge batteries input voltage should be higher than battery voltage.

==Blink modes==
===Status of Main LED(green)===
:-Steady ON: UPS is on Input Power
:-ON for 0.5sec,OFF for 2.5sec: UPS is Battery Powered
:-Blinking On/OFF every 2 sec : OFFDELAY
:-3 fast blinks and pause repeated every 2 seconds: HARDOFF delay
:-Steady OFF:UPS is in ship mode
:-high frequency blinking: battery cell is missing(cell voltage is less than 100mV)

===Status of Battery LED(red)===
:-Steady ON: UPS is Battery Powered
:-Steady OFF: Battery is not being charged
:-Blinking On/OFF every 2 sec: Battery is being charged

;All LEDs OFF
: Unit is in Ship mode consuming less than 1uA. MCU is not powered. Can be waked up by pressing P10 or if input voltage is present.

==Fuel gauge==
The initial remaining capacity is detected based on an open-circuit voltage based state-of-charge estimation, using the predefined values set by the OCV_SOCxx parameters.
Further estimation is based on coulomb counting method which is more precise after a full charge cycle has been performed.<br>
The UPS doesn't save the coulomb counter in its internal flash memory when it is shut down.
After wakeup the open-circuit voltage based estimation is used again.

==Characteristics==
<div style="display: inline; float: left; padding-right: 10px; border-right: 1px solid #ccc;">
Minimum Input Operating voltage<br>
Maximum input Operating voltage<br>
Deep-Discharge shutdown threshold<br>
Deep Sleep(Ship mode) Current Consumption<br>
Sleep mode Current Consumption<br>
Storage and operating temperature<br>
MTBF<br>
Input connectors<br>
Output Connector<br>
</div>
<div style="display: inline; float: left; margin-left: 10px;">
11V<br>
24V <br>
configurable<br>
< 1uA, see UPS_CONFIG2 parameter for detail<br>
530uA, see UPS_CONFIG2 parameter for detail<br>
-40<sup>o</sup>C to +85<sup>o</sup>C (storage), -40<sup>o</sup>C to +65<sup>o</sup>C (operating)<br>
50K Hrs @ 85<sup>o</sup>C, >= 200K Hrs at 65<sup>o</sup>C (projected)<br>
Mini-Fit JR<br>
Mini-Fit JR
</div>
<div style="clear: both;"></div>

'''Output/Input Rail Output Current (buck/boost converter)'''
<br>
Maximum input current: 5A(consult with battery manufacturer for ratings)<br>
Peak Input current: 6A(<30 seconds)<br>
Maximum output current: 5A (input current dependent)<br>
Peak output Current: 6A(<30 seconds)<br>

NOTE:
When operating at high voltage (input or output) or/or operating at elevated temperatures
de-rating up to 30% might be necessary, forced ventilation required.
For long life operation, please ensure that hottest component on-board is kept below 65C.

===Output Booster measurements===
:<div style="display: inline; float: left;">[[File:Output-booster-01.png|150px|thumb|left|]]</div><div style="display: inline; float: left;">[[File:Output-booster-02.png|150px|thumb|left|]]</div>
<div style="clear: both;"></div>

==Support and warranty==
Standard Hardware Warranty 1Year / US, 2 Year EU.

==Parameter List==
{| class="wikitable"
! NAME
! Description
|-
| OPENUPSMODE
| <pre>
OPENUPS mode
0-Autorestart when input is present=yes (UPS)
1-Autorestart when input is present=no (LAPTOP)
2-Energy Pack mode (ON/OFF)
</pre>
|-
| CAPACITY[mAh]
|
Battery Capacity<br>
Default is 1000mAh.
|-
| MOB_ONOFF_TOUT[ms]
|
The power switch on the motherboard(if connected) will be shorted this period to turn the Motherboard ON or OFF.<br>
Default is 500ms.

|-
| UPS_BUTTON_ON_TOUT[ms]
|
The pushbutton connected on the P10 header must be shorted this period to be considered as pressed.<br>
Default is 100ms.

|-
|UPS_CONFIG[bit7..bit0]
|
Configuration register. Used for enabling disabling modules.0-disabled;1-enabled<br>
bit7-reserved<br>
bit6-reserved<br>
bit5-reserved<br>
bit4-reserved<br>
bit3-reserved<br>
bit2:Enable temperature compensated charge algorithm<br>
bit1:Enable shutdown from battery if system was shut down from OS sensed by USB<br>
bit0:Enable output voltage settings directly from OUT_VOLTAGE parameter. If disabled output voltage is set by configuration switch on the back side of the PCBA.<br>

|-
|UPS_CONFIG2[bit7..bit0]
|
Configuration register.Used for enabling disabling modules.0-disabled;1-enabled<br>
bit7-reserved<br>
bit6-reserved<br>
bit5-reserved<br>
bit4-reserved<br>
bit3-reserved<br>
bit2:reserved<br>
bit1:Enable Ship mode, consumption is less than 1uA. Unit can be waked up only by input power presence.<br>
bit0:Enable Sleep mode, consumption is 530uA. Unit can be waked up by button or input power presence.<br>
The combination of bit1 ,bit0 sets the configurable low power modes
-----01: Sleep mode CPU OFF (530uA)
-----10: Ship mode CPU OFF(1uA)
-----11 or 00: Standby mode CPU ON(15mA) ==> Ship mode CPU OFF(1uA)
|-
|UPS_VIN_MIN_START [V]
|
If input voltage is above this threshold the UPS will start and take power from the input.<br>
Default is 11V.

|-
|UPS_VCELL_MIN_START [V]
|
If Vin is not present and all the battery cells are above this threshold the UPS can start and runs on battery
Default is 3V.<br>

|-
|UPS_VCELL_MIN_STOP [V]
|
If VIN is not present and one of the battery cells is less than this threshold during the time period specified by UPS_VBAT_UVP_OFF_TOUT parameter the UPS will initiate shut down procedure.<br>
Default is 2.8V

|-
|UPS_VCELL_MIN_HARD_STOP [V]
|
If VIN is not present and one of the battery cells is less than this threshold the UPS will instantly shut down to preserve battery.<br>
Default is 2.5V

|-
|UPS_VBAT_UVP_OFF_TOUT [s]
|
During this period battery cells are checked against UPS_VCELL_MIN_STOP. If cell voltage exceeds UPS_VCELL_MIN_STOP the timer is rearmed so it can filter unwanted noise in the system.<br>
Default is 5 sec.

|-
|UPS_HARDOFF_TOUT[s]
|
After UPS_VBAT_UVP_OFF_TOUT passed motherboard is signaled to shut down. The UPS will wait this period so that the Motherboard can shut down gracefully, than cut power and enter deep sleep. This period should not be too long to prevent battery drain.<br>
Default is 60 sec.

|-
|UPS_VBAT_SLEEP_TOUT[s]
|
Deep sleep timeout..If system is running on battery and this period has elapsed with no input power applied, then the UPS will initiate shut down procedure. "Never" is allowed as value (to disable this feature).<br>
Default is "Never".

|-
|DCHG_IMAX[A]
|
Max allowed discharge current. In case discharge current exceeds this threshold shutdown will be initiated.<br>
Default is 10A.

|-
|CHG_VCOND[V]
|
Conditioning/Pre-charge voltage. Charge current is limited until cell voltage exceeds this value and for at least
CHG_TCOND time .<br>
Default is 3V.

|-
|CHG_TCOND[V]
|
Conditioning/Precharge time. Charge current is limited until cell voltage exceeds CHG_VCOND value and it is applied during this time.<br>
Default is 30 sec.

|-
|CHG_BULK_STOP_VOLTAGE[V/cell]
|
Maximum allowed bulk charge voltage/cell during constant current/constant voltage charging.<br>
Default is 3.5[V/cell]

|-
|CHG_HYSTERESIS[V/cell]
|
An over-voltage value (CHG_BULK_STOP_VOLTAGE+CHG_HYSTERESIS ) that it is allowed when charging. If one of the cells exceeds this value charging is immediately stopped.<br>
Default is 100mV/cell.

|-
|CHG_START_VOLTAGE [V/cell]
|
If cell voltage is below this value charging can be started.<br>
Default is 3.3V/cell

|-
|CHG_GLOBAL_TOUT[min]
|
Global charge timeout.<br>
Default is 180 min.

|-
|CHG_TOPPING_TIMER[s]
|
For Lithium based batteries after an overvoltage condition is detected for a cell a resting period is set by this timer before applying a small topping charge in case other cells are still not charged.<br>
Default is 60s.

|-
|CHG_BAT_TYPE
|
The battery chemistry to be charged.<br>
1-LiFePO4

|-
|CHG_TEMP_COLD[°C]
|
COLD temperature treshold for temperature compensated charge current regulation.<br>
Default 5°C(FW ver 1.2)

|-
|CHG_TEMP_COOL[°C]
|
COOL temperature treshold for temperature compensated charge current regulation.<br>
Default 10°C(FW ver 1.2)

|-
|CHG_TEMP_WARM[°C]
|
WARM temperature treshold for temperature compensated charge current regulation.<br>
Default 50°C(FW ver 1.2)

|-
|CHG_TEMP_HOT[°C]
|
HOT temperature treshold for temperature compensated charge current regulation.<br>
Default 55°C(FW ver 1.2)

|-
|BAL_VCELL_MIN[V]
|
Balancing is allowed if cell voltages are above this value.<br>
Default is 3.1V

|-
|BAL_VCELL_DIFF_START [V]
|
If the voltage difference between cells exceeds this value start balancing the cells.<br>
Default is 70mV.

|-
|BAL_VCELL_DIFF_STOP[V]
|
If the voltage difference between cells is less than this value stop balancing the cells.<br>
Default is 40mV.

|-
|OUT_VOLTAGE[V]
|
The output voltage. Bit0 in UPS_CONFIG parameter should be set to “1” in order this parameter has effect.<br>
Default is 12V.

|-
|OUT_MAX_REGULATOR_STEP[steps]
|
Maximum allowed regulation step number for output module (0-255)<br>
Default 255.

|-
|OUT_FOLLOW_OFFSET[V]
|
Offset for adaptive output regulation.<br>
Default is 1V.

|-
|OCV_SOC0[V]
|
Open Circuit Voltage State Of Charge detection for initial 0% fuel gauge estimation.<br>
Default is 3.1V

|-
|OCV_SOC10[V]
|
Open Circuit Voltage State Of Charge detection for initial 10% fuel gauge estimation.<br>
Default is 3.2V

|-
|OCV_SOC25[V]
|
Open Circuit Voltage State Of Charge detection for initial 25% fuel gauge estimation.<br>
Default is 3.25V

|-
|OCV_SOC50[V]
|
Open Circuit Voltage State Of Charge detection for initial 50% fuel gauge estimation.<br>
Default is 3.30V

|-
|OCV_SOC75[V]
|
Open Circuit Voltage State Of Charge detection for initial 75% fuel gauge estimation.<br>
Default is 3.32V

|-
|OCV_SOC100[V]
|
Open Circuit Voltage State Of Charge detection for initial 100% fuel gauge estimation.<br>
Default is 3.35V

|-
|AFE_OLV[-]
|
Advanced parameter.<br>
AFE Overload Voltage treshold configuration register.<br>
Default is 0x00.<br>

|-
|AFE_OLD[-]
|
Advanced parameter.<br>
AFE Overload Delay time configuration register.<br>
Default is 0x00.<br>

|-
|AFE_SCC[-]
|
Advanced parameter.<br>
AFE Short Circuit In Charge configuration register.<br>
Default is 0x50.<br>

|-
|AFE_SCD[-]
|
Advanced parameter.<br>
AFE Short Circuit In Discharge configuration register.<br>
Default is 0x50.<br>

|-
|WRITE_COUNT[cycle]
|
Number of times the flash memory has been written. Parameter is Read only.
|}

==Software manual==
===Windows OS built-in support===
The OpenUPS implements two generic USB classes, therefore most of the
operating systems are recognizing it without any additional driver installation. This two
classes are:
a.) "HID UPS Battery" for OS built-in communication.
Microsoft Windows versions are recognizing this class automatically and the device should
appear in device manager at Batteries as a "Hid ups battery", together with all settings and
power plan possibilities provided by the OS for any battery.
b.) "HID" for communication and configuration
This endpoint is a generic HID and it is used by our configuration and monitor softwares to
read/write voltages and other important parameters of the OpenUPS2
===Configuration software===
The configuration software provides interface for OpenUPS2 monitoring, logging and setup.
It's recommended to be used by users with deeper understanding of the OpenUPS2 hardware since permits setting voltages, currents and other parameters which can be
dangerous if they are set without precaution.<br />
The configuration software has two main screens (Status and Settings) and a header with the important voltage/current values.<br />

====The first main screen is the "Status"====
Examples of this screen is shown in the next images:<br />
<div style="display: inline; float: left;">
[[File:Openups2_sm_status1.jpg‎|x350px|thumb|left|Status screen]]
</div>
<div style="display: inline; float: left;">
[[File:Openups2_sm_status2.jpg|x350px|thumb|left|Extended status screen]]</div>
<div style="clear: both;"></div>

The title bar shows the connection status and the firmware version of the OpenUPS2. Example: "OpenUPS2 Connected v1.0"

The header of the status screen contains:
: Two icons:
:: The upper one is the Mini-box.com logo and it does not changes.
:: The second icon is present only when OpenUPS2 is connected to the UPS and can be "Battery powered" (like int the example screenshots), "Line powered" and "USB powered". It displays the state of the OpenUPS2
: Capacity: shows the remaining capacity of the batteries
: RTE: run time to empty
: Input: input voltage applied to the OpenUPS2 (P1 Input)
: Battery: battery voltage
: Output: output voltage of the OpenUPS2 (P2 Output)

The "Status" screen contains extended information about the current state of the OpenUPS2 like battery voltages, charge/discharge currents, temperature/voltage of the batteries and different states.
The user also have the possibility to log the current state into a *.csv file.
The "Extended state" flags are for debug/support and can change between different firmware versions.

====The second main screen is the "Settings"====
Example of this screen is shown in the next image:<br />
<div style="display: inline; float: left;">
[[File:Openups2_sm_settings.jpg‎|x350px|thumb|left|Settings screen]]
</div>
<div style="clear: both;"></div>

This screen contains two main sections: the individual parameter setup for experienced users and the parameter save/load into/from file section.

IMPORTANT: any parameter setting or battery wizard data is taken into account by the OpenUPS2 only after a full restart either with power cut from all sources (usb, battery, vin), either by the "Restart OpenUPS (full restart and reload parameters)" button. Do this with precaution, check the parameters and wires before doing it!

The main section of the "Settings" screen is the individual parameter settings.<br>
This is recommended to be done only by experienced users. Any parameter of the OpenUPS2 can be set from here.
Changing one parameter is simple:
:- select the desired parameter from the "Parameters" drop down menu. The current value is displayed in the "Value" field together with the unit ([V], [mA] etc.).
:- introduce the new value
:- the introduced value is checked whenever you change the current selection for the "Parameters" or choose to sync with "Sync all parameters to the OpenUPS". If the
result of the check is correct, the resulting value is shown in the "Change log" field, otherwise error message might be popped up and the parameters selector jumps back to
the wrong value.
:- after You have done with all parameter setting press the "Sync all parameters to the OpenUPS" button to send all values to the OpenUPS2.
IMPORTANT: without this step the new values will be lost, nothing is sent to the OpenUPS2!

For users who need to setup more devices with the same OpenUPS2 settings, it is recommended to use the save/load parameters buttons.
The "All parameters: OpenUPS ===> File (settings.ini)" button loads a full configuration from the OpenUPS and saves it to the settings.ini file. You can disconnect
the current OpenUPS2 from the USB and insert a new one, than press the "All parameters: File ===> OpenUPS (settings.ini)" button to send the last saved configuration into the new OpenUPS2.

The "All parameters: OpenUPS ===> CSV File (settings.csv)" button loads all parameters from the connected OpenUPS2 and saves it into a csv file. This type of file can be opened by any spreadsheet editor (OpenOffice, Microsoft Excel etc.) and contains the full set of parameters in human readable form.

The "Enter bootloader mode (device restarted in bootloader mode)" button is intended to be used for firmware updates. After You press this button the OpenUPS2 will disconnect, it will switch to bootloader mode and firmware can be updated as described [[OpenUPS2#Bootloader_Mode|here]]

Every save/load/sync operation on the "Settings" screen affects the progress bar and the status bar on the bottom of the screen (labelled with "State:"). In rare cases You
might get error here with "try again" message. This happens in case of one parameter byte get's corrupted or timeout occurs during USB communication and/or OpenUPS flashing
operation. Please try again and contact our support team only if the device gives this error 4-5 times in a row.

===Windows System monitor===
The system monitor is a tray bar software which shows the current state on the tray bar icon and a semi transparent "always on top" capable small window.<br>
The popup window can be moved anywhere on the screen and can be customised. Our current setup has two skins but any combination is possible playing with the
"skin*.mbs" files installed together with this application. The current skin can be selected right clicking on the try icon.
The "skin*.mbs" files are simple text ones editable with any text editor (notepad for example).<br>
Adding a new skin is pretty simple – make a skin2.mbs (use the existing skin0.mbs or skin1.mbs for starting content) and start playing with the values from the new
file.<br>
The values are self explanatory – skin name, background image files, font descriptions and label/value pair coordinates for all the important OpenUPS2 values.
The size of the popup is defined by the background image – transparent parts can be defined as well (see for example: "bubble1.bmp").
Example screenshots:<br />
<div style="display: inline; float: left;">
[[File:Openups2_sm_tray1.jpg‎|x150px|thumb|left|System monitor skin1 connected]]
</div>
<div style="display: inline; float: left;">
[[File:Openups2_sm_tray2.jpg‎|x150px|thumb|left|System monitor skin2 connected]]
</div>
<div style="display: inline; float: left;">
[[File:Openups2_sm_tray3.jpg‎|x150px|thumb|left|System monitor skin2 disconnected]]
</div>
<div style="display: inline; float: left;">
[[File:Openups2_sm_traysettings.jpg‎|x150px|thumb|left|System monitor settings]]
</div>
<div style="clear: both;"></div>

===Developer manual===
Mini-box.com provides one OpenUPS2 API in a DLL (OpenUPS2Lib.dll) and examples in Visual C++, Visual Basic and Visual C#.<br>
Basic C++/Visual Basic/C# knowledge is needed to use this examples together with the API.
The API dll has manifest embedded to permit C# and Visual Basic dynamic load, external manifest is also provided in case if it is needed.

The API has a set of functions exported to access the full functionality of the OpenUPS2.
This functions are:
<code>
: unsigned char upsOpenDeviceHandler(unsigned int timer); //open device handler. timer sets the refresh period in milliseconds (4 messages will be sent in this period), don't use values lower than 40msec here (cpu usage and usb traffic will increase with lower values). IMPORTANT: the handler can be kept open to notice any OpenUPS2 plugged in
: void upsCloseDeviceHandler();//close device handler
: void getUPSDevicePath(char* path);//get device path
: unsigned char isUPSConnected();//0=not connected, 1=normal state,2=loading settings from device,3=saving settings from pc,4=saving settings from file
: float getUPSVIN();//UPS Voltage IN
: float getUPSVBat();//UPS Voltage Battery
: float getUPSVOut();//UPS Voltage out
: float getUPSCCharge();//UPS charge current
: float getUPSCDischarge();//UPS discharge current
: float getUPSVDuty();//duty cycle
: float getUPSVCell(int i);//cell voltages (i=0,1,2)
: float getUPSTemperature(int i);//cell temperatures (i=0,1,2)
: unsigned char getUPSVerMajor();//firmware version major number
: unsigned char getUPSVerMinor();//firmware version minor number
: unsigned char getUPSState();//ups state (0=disconnnected, 1=running from battery, 2=running from VIn, 3=running from USB)
: unsigned char getUPSRemainingCapacity();//remaining capacity
: unsigned char getUPSVOutPot();//voltage out regulator %
: unsigned char getUPSConfigSwitch();//config switch/debug info
: unsigned char getUPSStateByteUPS();//state byte/debug info
: unsigned char getUPSStateByteCHG();//charger state/debug info
: unsigned char getUPSStateByteDBG();//debug byte
: unsigned char getUPSBatteryOn(int i);//battery connected (i=0,1,2)
: unsigned int getUPSRTE();//Remaining time to empty
: unsigned char getUPSMode();//mode byte/reserved
: unsigned char getUPSDbgByte(int i);//more debug bytes
: unsigned char getUPSDbg2Byte(int i);//even more debug bytes
: unsigned char getUPSCheck23(int i);//extended state flags/debug info
: unsigned char getUPSCheck24(int i);//extended state flags/debug info
: unsigned char getUPSCheck25(int i);//extended state flags/debug info
: void restartUPS();//restart ups and reload parameters
: void restartUPSInBootloaderMode();//restart ups into bootloader mode (for updating fimware)
: void setUPSCommand1Byte(unsigned char command, unsigned char value);//debug states/reserved
: void setUPSCommand2Byte(unsigned char command, unsigned int value);//debug states/reserved
: void incDecVOutVolatile(unsigned char inc);//dynamically increase/decrease voltage (not saved into parameters for next startup)
: void setVOutVolatile(float vout);//directly set voltage (not saved into parameters for next startup)
: unsigned int getUPSMaxVariableCnt();//return variable count of the OpenUPS2
: unsigned char getUPSVariableData(unsigned int cnt, char* name, char* value, char* unit, char* comment);//get name, value, measuring unit and explication by variable index
: void startUPSLoadingSettings(unsigned char to_file, unsigned char compare_with_old);//start to load settings from device
: unsigned char getUPSLoadingSettingsState();//load settings state: 0-64 - steps, 100=success, 0xF1-0xFF=failure/errorcode
: unsigned char setUPSVariableData(unsigned int cnt, char* value);//set individual variable by index (string form, permitted values described in hardware manual)
: void startUPSSaveSettings(unsigned char from_file);//start saving parameters into device
: unsigned char getUPSSaveSettingsState();//saving state: 0-64 - steps, 100=success, 0xF1-0xFF=failure/errorcode
See the examples for usage.
</code>

IMPORTANT: the API dll needs 4 files from Visual Studio 2005 redistribution pack (Microsoft.VC80.CRT.manifest, msvcm80.dll, msvcp80.dll, msvcr80.dll).

IMPORTANT: the API supports only one OpenUPS2 connected to the computer.

====Visual C++ Example====
Open CLibTest.sln from the package, run it and see CLibTest.cpp for usage example.
====Visual Basic Example====
Open VBLibTest.sln from the package, run it and see Module1.vb for usage example.
====Visual C# Example====
Open CSLibTest.sln from the package, run it and see Program.cs for usage example.

NUC-UPS

2022-11-22T08:17:08Z

Admin:

'''6-38V Intelligent Automotive grade Uninterruptible Power Supply'''<br><br>
'''Before you start…<br>
Often times, rushing into installing the unit can result in serious damage to your DCDC-NUC UPS board or computer.
Always double check the polarity of your wires with a voltmeter.<br><br>
'''Always double check the polarity of the batteries before introducing into the UPS device.'''<br>
'''Improper configuration leads to system damage!!!'''<br><br>
<nowiki>*</nowiki> NOTE: Forced ventilation or 40% input or output current de-rating or both is required if any of the following conditions are met:<br>
If V(IN) 24-38V <br>
If I(Out) > 2A and T(ambient) > 30°C, open air operation.<br>
In order to prevent premature battery damage due to thermal exposure, always check NUC-UPS board temp and ensure it does not exceed 55C for your application.

==Introduction==
The NUC-UPS was designed to provide +12V regulated power output from a wide input voltage(6V-38V).<br>
It has a range of intelligent functions not found in any of the traditional USB converters.<br>
The unit is able to gracefully shut down motherboards based on Ignition sensing or battery voltage level, by pulsing

the motherboard on/off pins. This makes it an ideal device for automotive or battery powered installations.<br>
It features 4 replaceable Li-Ion batteries for battery backup integrated in the device, there is no need for any

kind of special cabling between cells and UPS.
The charger is a Synchronous Buck-Boost converter capable of charging the batteries with input voltage below, equal

or above battery voltage level.
It charges the battery in three phases: preconditioning, constant current mode and constant voltage mode. <br>
The output converter is a synchronous Buck converter providing regulated 12V output.
The unit can be used as an embedded UPS or as a Portable Energy Pack providing the user with regulated 12V wherever

needed.

==Features==
* USB interface, works with Windows devices (Linux API planned)<br>
* Input between 6-38V<br>
* Programmable thresholds, timings and configuration modes<br>
* Generates regulated 12V output voltage<br>
* Output current 5A continuous
* Supports Li-Ion (3.7V) battery chemistry<br>
* 3 state charger(precharge, constant current, constant voltage)<br>
* Battery balancing, 4S configuration.<br>
* Charge voltage 4x4.2V, charge current 1A, precharge current ~0.3A<br>
* Coulomb counting<br>
* Battery temperature monitoring for each cell and temperature compensated charge<br>
* Start/Stop button and header<br>
* Motherboard ON/OFF pulse control*<br>
* Motherboard detection by power consumption or 5VUSB presence
* Missing battery cells detection<br>
* Ultra low power consumption(5uA- in Deep Sleep mode) or (250uA- in Dumb mode Standby) or (5mA- Automotive mode

Standby)<br>
* Windows detects device as “Battery”, with no special drivers required **<br><br>

==Diagram & Schematics==
==Connectors==
<div style="display: inline; float: left;">[[File:Nucupslegend.jpg|230px|thumb|left|Connectors nomenclature]]</div>
<div style="clear: both;"></div>
===Power Input connectors===
;P1 Input (mini-FIT JR, 1x4 pins)
: P1.1,P1.2-GND
: P1.3-Ignition sensing
: P1.4-Input voltage
;P2 Input (DC Power Jack:2DC-G213-B49, Mating plug 5.50x2.50)

;P3 Output (mini-FIT JR, 1x4 pins)
: P3.1,P3.2-GND
: P3.3,P3.4-Output voltage
;P4 Output (B4B-EH-A(LF)(SN), 1x4 pins)
: P4.1,P4.2-GND
: P4.3,P4.4-Output voltage

===Interface connectors===
;P5 Motherboard POWER SW connection, no polarity (JST_B3B-PH-KL, 1x3pins)
: P5.1: SW1
: P5.2: GND
: P5.3: SW2
;P7 USB header (B4B-PH-K-S(LF)(SN), 1x4pins)
: P7.1: GND
: P7.2: USB D-
: P7.3: USB D+
: P7.4: +5V
;S1&P9 Start/Stop button header (M20-9990246, 1x2pins)
;P8 Programming header
P8.1: MCLR
P8.2: GND
P8.3: 5V
P8.4: PGD
P8.5: PGC

==NUC and OS Settings==
<br>
*'''NUC related settings'''<br><br>
<div>
<div style="display: inline; float: left;">[[File:BIOS.png|230px|thumb|left|NUC Visual BIOS 2.0 Setting]]</div>
:Setting up the NUC's behavior when power is re-applied:<br>
:- press '''F2''' key during the boot sequence to entering the NUC's BIOS (Visual BIOS 2.0)<br>
:- first click on '''Advanced''' then click on '''Power''' menu button<br>
:- in '''Secondary Power Settings''' section select '''Power On''' option for '''After Power Failure'''<br>
:- the picture shows the right option in a red framework<br>
:- now the power supply should be able to '''START''' the NUC by applying corresponding voltage to its power

input<br>
</div>
<div style="clear: both;"></div>

==Firmware update==
It is recommended that you only connect USB power to the device
when making a firmware update via “bootloader mode”.

There are two ways to enter in bootloader mode: 1a) or 1b).<br>
1a) Place a jumper on the P8.4 and P8.5 pins then connect the unit to USB<br>
1b) Connect the unit to USB then press the Switch to bootloader button on the configuration software's user

interface.<br>
2) Start the [https://wiki.mini-box.com/images/a/ae/Bootloader_Software.zip '''HIDBootloader v2.9j.exe'''] software

provided to flash the new firmware.<br>
3) Press File->Import Firmware Image<br>
4) Press Open new Hex [https://wiki.mini-box.com/images/4/4b/DCDC-NUC_UPS-_FW_ver_1.3_for_loading_with_bootloader_2017.oct.09.zip '''File''']<br>
5) Press Program->Erase/Program/Verify Device<br>
6) If used option 1a) remove the jumper
6) Press Program->Reset Device<br>
7) After the device reconnects on USB with the configuration software the new firmware version will be displayed in

the title bar of the software.<br>

==NUC-UPS operating modes==
For configuration purposes only the unit can be started by connecting the unit to USB.<br>
Inserting the batteries should be the first step to perform.<br>
Waking the unit for the first time implies applying input voltage.<br>
The operating modes can be selected by setting the NUC_UPS_MODE parameter to 0(DUMB mode) or 1(AUTOMOTIVE mode).<br>
Further parameters can be customized by changing in the [[NUC-UPS#Parameter_List|'''Parameter List''']].<br>
===Dumb Mode===
:When in this mode the unit still works as an UPS or it can be used as a general purpose battery pack.<br>
;Starting the unit
:In this mode starting can be performed either by applying input voltage or pressing the button for 500ms.<br>
;Stopping the unit
:In this mode stop sequence can be initiated by pressing the button for 500ms.<br>

===Automotive Mode===
;Starting the unit
:In this mode Starting can be performed by applying input voltage and applying ignition voltage.<br>
:The ignition voltage thresholds are configurable set by the IGN_HIGH_THRESHOLD, IGN_LOW_THRESHOLD parameters.The

Ignition voltage must be higher than IGN_HIGH_THRESHOLD for the duration set by the IGN_COUNT parameter in order to

filter out unwanted noise in automotive environment.<br>
;Stopping the unit
:In this mode stop sequence can be initiated if Ignition voltage is lower than IGN_LOW_THRESHOLD parameter for the

duration set by the IGN_COUNT parameter.<br>

===Stop conditions that apply in both modes===
:When the unit is running on batteries the following conditions can initiate shutdown(the shutdown reason can be

identified on the Status-UPS tab,Shutdown groupbox in the Configuration software):<br>
:-one of the cell voltages is less than UPS_VCELL_MIN_STOP parameter, shutdown sequence is initiated.<br>
:-the unit is on battery for more than UPS_ON_BATTERY_TOUT parameter, shutdown sequence is initiated.<br>
:-one of the cell voltages is less than UPS_VCELL_MIN_HARD_STOP parameter, shutdown is immediate.<br>
:-one of the batteries temperature is out of the limits set by the DCHG_TEMP_COLD, DCHG_TEMP_HOT parameters.<br>
:-overload, when the maximum allowed discharge current exceeds the value set by UPS_OVERLOAD parameter.<br>
:If output is out of regulation the unit is immediately stopped.

===Startup and Shutdown sequence===
====Startup sequences====
[[File:Dumb_mode_waking_with_VIN.PNG|600px]]
[[File:Dumb_mode_waking_with_button.PNG|600px]]
[[File:Automotive_mode_waking_with_Ignition.PNG|600px]]<br>
====Shutdown sequences====
[[File:Gracious_shutdown.PNG|600px]]
[[File:Immediate_shutdown.PNG|600px]]

===Motherboard control===
The following options are available to control the motherboard by pulsing the on/off pins on the motherboard.
First the the motherboard On/OFF pins should be connected to the P5.1,P5.3 pin on the P5 [[NUC-UPS#Interface_connectors|'''Interface_connector''']].<br>
The pulse width is 500ms by default which can be altered by changing MOB_PULSEWIDTH parameter from the [[NUC-UPS#Parameter_List|'''Parameter_List''']].<br>
There are various ways to control the motherboard depending the configuration of the CONFIG1 register from the [[NUC-UPS#Parameter_List|'''Parameter_List''']].<br>
Example:If startup of the motherboard is not needed when input is present, the startup pulse can be disabled by setting CONFIG1.b0 to 0.<br>
The same way the shutdown pulse can be inhibited by setting CONFIG1.b1 to 0.<br>
There are cases when motherboard started(ON) or OFF presence must be detected in order starting/stopping by pulses behavior work properly.<br>
For example the Operating System could be shutdown already from software. In case the unit is is a shutdown sequence not knowing this piece of information would lead by sending the shutdown pulse which would wake up instead the system.<br>
There are two kinds of feedback information to detect motherboard status.<br><br>
The first detection mode is by measuring the consumed output power, knowing that a motherboard when started consumes much more power than when in standby.<br>
In order to enable this feature the following steps should be performed:<br>
1. Enable this feature, CONFIG1.b2 should be set to 1.<br>
2. Observe and note the consumption of the connected motherboard when in standby and when is ON.
Our unit measures the output power(POUT) which is displayed in the configuration software.<br>
3. Set POUT_HIGH_THRESHOLD and POUT_LOW_THRESHOLD parameters from the [[NUC-UPS#Parameter_List|'''Parameter_List''']] accordingly with a good margin. <br>
POUT<POUT_LOW_THRESHOLD motherboard is considered OFF.<br>
POUT>POUT_HIGH_THRESHOLD motherboard is considered ON.<br><br>
The second detection mode is by measuring the +5VUSB signal. Usually motherboards turn OFF the +5VUSB signal when they are OFF.<br>
In order to enable this feature CONFIG1.b3 must be set to 1.

==NUC-UPS charger==
The charger is a Synchronous Buck-Boost converter capable of charging the batteries with an input voltage below, equal or above battery voltage level.<br>
The charging happens three phases: preconditioning, constant current mode and constant voltage mode:
:• The charging is starting with a preconditioning phase, where the current is limited to ~350mA. The preconditioning phase has a minimum duration set by CHG_COND_TOUT which is extended if one of the cells voltage is below the limit set by CHG_CELL_VCOND.<br>
:• In constant current phase charge current is limited to 1A. After battery voltage rises to the value set by the hardware charger, the charger will enter constant voltage mode.<br>
:• In constant voltage phase the battery will absorb less current as time passes and charge current will decrease. When the charge current decreases below ~150mA, charging is stopped.<br>

During low power state the charger is disabled, so the charger module is also disabled in automotive mode when the Ignition is OFF, even if input is present.<br>

Charging will be terminated if a global charge timer elapses, this can be set by CHG_GLOBAL_TOUT parameter.<br>
Charging is limited to precharge value if one of the batteries temperature exceeds limits set by CHG_TEMP_COOL,CHG_TEMP_WARM parameters.<br>
Charging is terminated if one of the batteries temperature exceeds the limits set by CHG_TEMP_COLD,CHG_TEMP_HOT. <br>
In order to work properly the following conditions when changing parameters must be fulfilled: CHG_TEMP_COLD < CHG_TEMP_COOL < CHG_TEMP_WARM < CHG_TEMP_HOT.

The temperature sensors are located just below the batteries for proper temperature detection of each cell.<br>
:[[File:Charge-regulation.png|325px|thumb|left|]]
<div style="clear: both;"></div>

==NUC-UPS Charge Balancer==
The balancing algorithm is voltage based. Balancing is allowed if cell voltage exceeds the value set in the BAL_VCELL_MIN parameter.<br>
Balancing is started if the voltage difference between the cells is higher than BAL_VCELL_DIFF_START, and will be stopped if the difference is lower than the value defined in BAL_VCELL_DIFF_STOP parameter.<br>

==NUC-UPS Fuel gauge==
The initial remaining capacity is detected based on an open-circuit voltage based state-of-charge estimation, using the predefined values set by the OCV_SOCxx parameters.
Further estimation is based on coulomb counting method which is more precise after a full charge cycle has been performed.<br>

==Led Blinking==
The unit has two LEDs on board (Red and Green), located on the right and left side of the USB connector.<br>
While there are scenarios where both LEDs are blinking with a certain pattern, the LEDs generally help identifying the power source that runs the UPS output at any given moment.
:• The green LED signals that the NUC-UPS is running from input voltage
:• The red LED signals that the NUC-UPS is running from batteries

The blinking patterns that can occur during operation are shown in the images below. The duration of LED blinks can also be seen on the images, displayed in milliseconds.<br>

[[File:LED_LPWR_Mode_On_USB_Or_In_Automotive_Standby.PNG|600px]]
[[File:LED_Initial_Delay.PNG.PNG|600px]]<br>
[[File:LED_Batteries_Charging.PNG|600px]]
[[File:LED_Running_From_Vin.PNG|600px]]<br>
[[File:LED_Running_From_Battery.PNG|600px]]
[[File:LED_Wait_Hardoff_Running_From_Vin.PNG|600px]]<br>
[[File:LED_Wait_Hardoff_Running_From_Battery.PNG|600px]]
[[File:LED_Missing.PNG|600px]]<br>

==Parameter List==

{| class="wikitable"
! NAME
! Description
|-
| NUC_UPS_MODE[-]
| <pre>
0-Dumb mode (DUMB)
1-Automotive mode (AUTOMOTIVE)
</pre>
NUC_UPS_MODE

|-
| UPS_ON_BATTERY_TOUT
|
Deep sleep timeout. If system is running on battery and this period has elapsed with no input power applied, the UPS

will initiate shut down procedure. "Never" is allowed as value (to disable this feature). Default is "Never".

|-
| INIT_TOUT
|
When all power supply start-up conditions are met, the PSU will wait this time before continuing with the start-up

sequence.

|-
| VIN_MIN_STARTUP
|
If the input voltage is beyond this threshold and all other start-up conditions are met, the PSU can start. Default

is 11000mV.

|-
| VIN_MIN_RUNNING
|
If input voltage is below this threshold, the output is powered from battery. Default is 8000mV.

|-
| VIN_COUNT
|
Input voltage filtering. Default is 100ms.

|-
| IGN_COUNT
|
Ignition voltage filtering. Default is 100ms.

|-
| IGN_HIGH_THRESHOLD
|
If ignition voltage is beyond this threshold, ignition is considered to be ON. Default is 6000mV.

|-
| IGN_LOW_THRESHOLD
|
If ignition voltage is below this threshold, ignition is considered to be OFF. Default is 5000mV.

|-
| IGN_ON_TO_OUTPUT_ON_TOUT
|
After ignition is considered ON, the PSU will wait this time before the output is turned ON. Default is 2000ms.

|-
| IGN_CANCEL_TOUT
|
After the motherboard boots up, the ignition voltage sensing will be disabled for this period. Default is 60s.

|-
| OUTPUT_ON_TO_MOB_PULSE_ON_TOUT
|
After the output was turned on, the UPS will wait this period before sending the ON pulse to the motherboard.

Default is 20ms

|-
| IGN_OFF_TO_MOB_PULSE_OFF_TOUT
|
In automotive mode, after the ignition is considered OFF, this UPS will wait this period before sending the OFF

pulse to the motherboard. Default is 5s

|-
| MOB_PULSEWIDTH
|
The length of the start-up/shutdown pulse sent to the motherboard. Default is 500ms.

|-
| HARD_OFF_TOUT
|
After the shutdown pulse is sent to the motherboard, the UPS will wait this period before the output is turned OFF.
This time-out allows the operating system to perform a clean shutdown. Default is 60s.

|-
| PWM_SPREAD_MODULATING_FREQ
|
Modulation frequency parameter of the Random Spread Frequency Modulation module (used for EMI reduction purposes)

|-
| PWM_SPREAD_PERCENT
|
Frequency deviation parameter of the Random Spread Frequency Modulation module (used for EMI reduction purposes)

|-
| PWM_FREQ
|
Operating frequency of the Switched Mode Power Supply

|-
| CONFIG1
|
Configuration register [b7..b0]. Used for enabling/disabling modules. 0 - disabled, 1 - enabled <br>
b7 - Unused <br>
b6 - Unused <br>
b5 - Unused <br>
b4 - Unused <br>
b3 - If set, the USB sense is enabled, +5V USB is used to detect the Motherboard alive status<br>
b2 - If set, the Power measurement (Vout x Iout) is used to detect the Motherboard alive status<br>
b1 - If set, shutdown pulse is enabled through the PWRSW connector.<br>
b0 - If set, startup pulse is enabled through the PWRSW connector.<br>

Depending motherboard alive status the shutdown/startup pulse is sent if b2/b3 is enabled.
The motherboard presence can be smartly detected if b2/b3 is enabled.
For example: In case motherboard is already shut down the pulse is not sent in case of a shutdown scenario.
This is also true in case of a startup scenario.

|-
| CONFIG2
|
Configuration register. Used for enabling/disabling modules. 0 - disabled, 1 - enabled <br>
b7..b0 - Reserved/Unused <br>

|-
| WRITE_COUNT
|
The number of times the internal Flash program memory has been written.

|-
| IOUT_OFFSET
|
This value will be summed with the measured input current, this is a calibration parameter. Default is 0mA

|-
| CAPACITY
|
Battery Capacity.
Default is 1000mAh.

|-
| UPS_BUTTON_ON_TOUT
|
Filtering time for button pressing. Default is 100ms.

|-
| UPS_VCELL_MIN_START
|
If Vin is not present and all the battery cells are above this threshold, the UPS can start and will run on battery.
Default is 3.6V.

|-
| UPS_VCELL_MIN_STOP
|
If VIN is not present and one of the battery cells is less than this threshold , the UPS will initiate a shutdown

procedure.
Default is 3.3V.

|-
| UPS_VCELL_MIN_HARD_STOP
|
If VIN is not present and one of the battery cells is less than this threshold, the UPS will instantly shut down to

preserve battery.
Default is 3V.

|-
| UPS_OVERLOAD
|
Max allowed discharge current. In case the discharge current exceeds this threshold, shutdown will be initiated.
Default is 6000mA

|-
| DCHG_TEMP_COLD
|
COLD temperature threshold for discharge. In case exceeded UPS will shutdown when on battery. Default is -20°C (FW

ver 1.1)

|-
| DCHG_TEMP_HOT
|
HOT temperature threshold for discharge. In case exceeded UPS will shutdown when on battery. Default is 60°C (FW ver

1.1)

|-
| CHG_COND_TOUT
|
Conditioning/Precharge time. Charge current is limited until cell voltage exceeds CHG_VCOND value and it is applied

during this time.
Default is 30 sec.

|-
| CHG_BULK_STOP_VOLTAGE
|
Maximum allowed bulk charge voltage/cell during constant current/constant voltage charging.
Default is 4.1 [V/cell].

|-
| CHG_HYSTERESIS
|
An overvoltage value ( CHG_BULK_STOP_VOLTAGE + CHG_HYSTERESIS ) that is allowed when charging. If one of the cells

exceeds this value, charging is immediately stopped.
Default is 100mV/cell.

|-
| CHG_START_VOLTAGE
|
If cell voltage is below this value, charging can be started.
Default is 3.85V/cell.

|-
| CHG_GLOBAL_TOUT
|
Global charge timeout.
Default is 240 min.

|-
| CHG_TOPPING_TOUT
|
After an overvoltage condition is detected for a cell (for Lithium based batteries), a resting period is set by this

timer before applying a small topping charge - in case other cells are still not charged.
Default is 60s.

|-
| CHG_TEMP_COLD
|
COLD temperature threshold for temperature compensated charge current regulation.
Default 5°C(FW ver 1.0)

|-
| CHG_TEMP_COOL
|
COOL temperature threshold for temperature compensated charge current regulation.
Default 10°C(FW ver 1.0)

|-
| CHG_TEMP_WARM
|
WARM temperature threshold for temperature compensated charge current regulation.
Default 50°C(FW ver 1.0)

|-
| CHG_TEMP_HOT
|
HOT temperature threshold for temperature compensated charge current regulation.
Default 55°C(FW ver 1.0)

|-
| UPS_VCELL_ADC_OFFSET
|
This value will be summed with the measured cell voltages, this is a calibration parameter. Default is 0mV.

|-
| CHG_CELL_VCOND
|
Conditioning/Pre-charge voltage. Charge current is limited until cell voltage exceeds this value and for at least

CHG_TCOND time . Default is 3.3V

|-
| BAL_VCELL_MIN
|
Balancing is allowed if cell voltages are above this value.
Default is 3.4V

|-
| BAL_VCELL_DIFF_START
|
If the voltage difference between cells exceeds this value, cell balancing will start.
Default is 80mV.

|-
| BAL_VCELL_DIFF_STOP
|
If the voltage difference between cells is less than this value, cell balancing will stop.
Default is 40mV.

|-
| OCV_SOC0
|
Open Circuit Voltage State Of Charge detection for initial 0% fuel gauge estimation.
Default is 3.3V.

|-
| OCV_SOC10
|
Open Circuit Voltage State Of Charge detection for initial 10% fuel gauge estimation.
Default is 3.68V.

|-
| OCV_SOC25
|
Open Circuit Voltage State Of Charge detection for initial 25% fuel gauge estimation.
Default is 3.76V.

|-
| OCV_SOC50
|
Open Circuit Voltage State Of Charge detection for initial 50% fuel gauge estimation.
Default is 3.82V.

|-
| OCV_SOC75
|
Open Circuit Voltage State Of Charge detection for initial 75% fuel gauge estimation.
Default is 3.97V.

|-
| OCV_SOC100
|
Open Circuit Voltage State Of Charge detection for initial 100% fuel gauge estimation.
Default is 4.17V.

|-
| POUT_HIGH_THRESHOLD
|
If output power measured is higher than this threshold the connected motherboard is considered to be ON.
Together with POUT_LOW_THRESHOLD parameter sets a hysteresis for motherboard status. CONFIG1.b2 must be set in order to be active. Default is 3000mW.

|-
| POUT_LOW_THRESHOLD
|
If output power measured is lower than this threshold the connected motherboard is considered to be OFF.
Together with POUT_HIGH_THRESHOLD parameter sets a hysteresis for motherboard status. CONFIG1.b2 must be set in order to be active. Default is 1000mW.
|}

==Software manual==
===Windows OS built-in support===
The NUC-UPS implements two generic USB classes, therefore most of the operating systems are recognizing it without

any additional driver installation. This two classes are:
a.) "HID UPS Battery" for OS built-in communication.
Microsoft Windows versions are recognizing this class automatically and the device should appear in device manager

at Batteries as a "Hid ups battery", together with all settings and power plan possibilities provided by the OS for

any battery.
b.) "HID" for communication and configuration
This endpoint is a generic HID and it is used by our configuration and monitor software to read/write voltages and

other important parameters of the NUC-UPS. This endpoint does not needs any additional driver either, Microsoft

Windows OS should recognize it as a generic HID USB device.

===Configuration software===
The configuration software provides interface for NUC-UPS monitoring, logging and setup.
It's recommended to be used by users with deeper understanding of the NUC-UPS hardware since permits setting

voltages, currents and other parameters which can be
dangerous if they are set without precaution.<br />
The configuration software has three main screens (Status-UPS, Status-Charger and Settings) and a header with the

important voltage/current values.<br />

====The first main screen is the "Status-UPS"====
Example of this screen is shown in the next image:<br />
<div style="display: inline; float: left;">
[[File:NUC-UPS-Status.JPG‎|x350px|thumb|left|Status screen]]
</div>

The title bar shows the connection status, the firmware version and the mode of the NUC-UPS. Example: "NUC-UPS

Connected v1.0 Mode: Dumb"

The header of the status screen contains:
:VIn: Input Voltage
:VIgn: Ignition Voltage
:VBat: Battery Voltage
:VOut: Output Voltage
:POut: Output Power
:IOut: Output Current
:Battery pack %: Battery percentage
:[0]: Battery 0 status
:[1]: Battery 1 status
:[2]: Battery 2 status
:[3]: Battery 3 status
:[Pack]: Battery pack overall voltage and current

The "Status-UPS" screen contains extended information about the current state of the NUC-UPS like internal state

machine, voltages, currents, temperature, different read only state flags.
The user also have the possibility to log the current state into a *.csv file in the "Log" section.
<div style="clear: both;"></div>

====The second main screen is the "Status-Charger"====
<div style="display: inline; float: left;">
[[File:NUC-UPS-Charger.JPG‎|x350px|thumb|left|Status screen]]
</div>
Contains extended information about current state of the NUC-UPS battery charger (internal state machines, flags)
<div style="clear: both;"></div>

====The third main screen is the "Settings"====
Example of this screen is shown in the next image:<br />
<div style="display: inline; float: left;">
[[File:NUC-UPS-Settings.JPG‎|x350px|thumb|left|Settings screen]]
</div>

This screen contains two main sections: the individual parameter setup for experienced users and the parameter

save/load into/from file section.

The main section of the "Settings" screen is the individual parameter settings.<br>
This is recommended to be done only by experienced users. Any parameter of the NUC-UPS can be set from here.

Changing one parameter is simple:
:- select the desired parameter from the "Parameter" list (simple click to select, double-click to edit). Below the

parameter list a helper text is displayed (same from this manual).
:- after double click introduce the new value in the new popup dialog and press OK
:- the introduced value is checked - if something is wrong (out of limit, bad value etc.) error message will be

shown
:- the ! sign will blink on the "Sync all parameters to the NUC-UPS" button to show edited but not saved/synced

variables
:- after You have done with all parameter setting press the "Sync all parameters to the NUC-UPS" button to send all

values to the NUC-UPS. IMPORTANT: without this step the new values will be lost, nothing is sent to the NUC-UPS!

IMPORTANT: any parameter setting is taken into account by the NUC-UPS in this cases:
: - after a full restart either with power cut from all sources (usb, vin)
: - hitting the "Restart NUC-UPS" button
: - keeping the "Reload parameters on the fly after sync" checked.
Do any parameter change with precaution, check the parameters and wires before applying it!

For users who need to setup more devices with the same NUC-UPS settings, it is recommended to use the save/load

parameters buttons.
The "Parameters: NUC-UPS ===> File (settings.ini)" button loads a full configuration from the NUC-UPS and saves it

to the settings.ini file. You can disconnect
the current NUC-UPS from the USB and insert a new one, than press the "Parameters: NUC-UPS <=== File (settings.ini)"

button to send the last saved configuration into the new NUC-UPS.

The "Parameters: NUC-UPS ===> CSV File (settings.csv)" button loads all parameters from the connected NUC-UPS and

saves it into a csv file. This type of file can be opened by any spreadsheet editor (OpenOffice, Microsoft Excel

etc.) and contains the full set of parameters in human readable form.

The "Switch to bootloader" button is intended to be used for firmware updates. After You press this button the NUC-

UPS will disconnect, it will switch to bootloader mode and firmware can be updated as described [[NUC-

UPS#Bootloader_Mode|here]]

Every save/load/sync operation on the "Settings" screen affects the progress bar and the status bar on the bottom of

the screen (labelled with "State:"). In rare cases You
might get error here with "try again" message. This happens in case of one parameter byte get's corrupted or timeout

occurs during USB communication and/or NUC-UPS flashing
operation. Please try again and contact our support team only if the device gives this error 4-5 times in a row.

===Windows System monitor===
The system monitor is a tray bar software which shows the current state on the tray bar icon and a semi transparent

"always on top" capable small window.<br>
The popup window can be moved anywhere on the screen and can be customized. Our current setup has two skins but any

combination is possible playing with the
"skin*.mbs" files installed together with this application. The current skin can be selected right clicking on the

try icon.
The "skin*.mbs" files are simple text ones editable with any text editor (notepad for example).<br>
Adding a new skin is pretty simple – make a skin1.mbs (use the existing skin0.mbs for starting content) and start

playing with the values from the new
file.<br>
The values are self explanatory – skin name, background image files, font descriptions and label/value pair

coordinates for all the important NUC-UPS values.
The size of the popup is defined by the background image – transparent parts can be defined as well (see for

example: "bubble1.bmp").
Example screenshots:<br />
<div style="display: inline; float: left;">
[[File:NUCUPS_sm_tray2.jpg‎|x150px|thumb|left|System monitor skin1 connected]]
</div>
<div style="display: inline; float: left;">
[[File:NUCUPS_sm_tray3.jpg‎|x150px|thumb|left|System monitor skin1 disconnected]]
</div>
<div style="clear: both;"></div>

Right clicking on the tray icon will pop-up a simple menu:
<div style="display: inline; float: left;">
[[File:NUCUPS_sm_menu.jpg‎|x150px|thumb|left|System monitor settings]]
</div>
<div style="clear: both;"></div>
From which You can see firmware version and state of the NUC-UPS from the NUC-UPS Properties and set some visual

parameters of the application (transparency, skin) from Skin:
<div style="display: inline; float: left;">
[[File:NUCUPS_sm_traysettings.jpg‎|x150px|thumb|left|System monitor settings]]
</div>
<div style="clear: both;"></div>

For auto start with the system make a shortcut of AppTray.exe from the standalone package in the system Startup ([https://windows.microsoft.com/en-us/windows/run-program-automatically-windows-starts#1TC=windows-7 Windows 7], [https://support.microsoft.com/kb/2806079 Windows 8]).

===Download software===

{| class="wikitable" style="text-align: center;"

|'''Version'''||'''Change list'''
|-
||[https://wiki.mini-box.com/images/3/33/NUCUPSv1.0.zip '''1.0''']||First version
|-
||[https://wiki.mini-box.com/images/5/55/NUCUPSv1.1.zip '''1.1''']||Update for Firmware 1.1
|}

===Developer manual===
Mini-box.com provides one NUC-UPS API in a DLL (NUCUpsLib.dll) and examples in Visual C++, Visual Basic and Visual

C#.<br>
Basic C++/Visual Basic/C# knowledge is needed to use this examples together with the API.
The API dll has manifest embedded to permit C# and Visual Basic dynamic load.

The API has a set of functions exported to access the full functionality of the NUC-UPS.
This functions are:
<code>
:extern "C" NUCUPSLIB_API const char* STATE_MACHINE_UPS[14];//state machine UPS
:extern "C" NUCUPSLIB_API const char* STATE_MACHINE_AFE[8];//state machine AFE
:extern "C" NUCUPSLIB_API const char* STATE_MACHINE_CHG[16];//state machine Charger
:extern "C" NUCUPSLIB_API const char* STATE_MACHINE_DTCT[16];//state machine Detect
:extern "C" NUCUPSLIB_API const char* STATE_MACHINE_LOWP[4];//state machine low power states
:extern "C" NUCUPSLIB_API unsigned char nucupsOpenDeviceHandler(unsigned int timer);//open device handler. timer

sets the refresh period in miliseconds (4 or 5 messages will be sent in this period e ending from debug mode)

IMPORTANT: the handler can be kept open to notice any NUC-UPS plugged in
:extern "C" NUCUPSLIB_API void nucupsCloseDeviceHandler();//close device handler
:extern "C" NUCUPSLIB_API void getNUCUpsDevicePath(char* path);//Get opened device path @param path - recommended

length 1024, will return empty string if no device opened
:extern "C" NUCUPSLIB_API unsigned char isNUCUpsConnected();//0=not connected, 1=normal state,2=loading settings

from device,3=saving settings from pc,4=saving settings from file
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsMode();//get NUC-UPS mode: 0=Dumb, 1=Automotive
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsInputFlags();//get NUC-UPS input flags
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsOutputFlags();//get NUC-UPS output flags
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsChargerFlags();//get NUC-UPS charger flags
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsStateFlags();//get NUC-UPS state flags
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsShutdownFlags();//get NUC-UPS shutdown flags
:extern "C" NUCUPSLIB_API float getNUCUpsVIn();//get NUC-UPS Input Voltage
:extern "C" NUCUPSLIB_API float getNUCUpsIOut();//get NUC-UPS Output Current
:extern "C" NUCUPSLIB_API float getNUCUpsVOut();//get NUC-UPS Output voltage
:extern "C" NUCUPSLIB_API float getNUCUpsVBats(int i);//get NUC-UPS battery voltages
:extern "C" NUCUPSLIB_API float getNUCUpsTemperature(int i);//get NUC-UPS battery temperature
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsCellBalanceOn(int i);//get NUC-UPS balanced battery (discharged)
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsCellDetected(int i);//get NUC-UPS battery detected
:extern "C" NUCUPSLIB_API float getNUCUpsVIgnition();//get NUC-UPS Ignition Voltage
:extern "C" NUCUPSLIB_API float getNUCUpsPOut();//get NUC-UPS Output Power
:extern "C" NUCUPSLIB_API float getNUCUpsVBat();//get NUC-UPS Bat voltage
:extern "C" NUCUPSLIB_API float getNUCUpsVPack();//get NUC-UPS Pack voltage
:extern "C" NUCUPSLIB_API float getNUCUpsIChgDchg();//get NUC-UPS Charge/Discharge current
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsSpecConsts(unsigned int type, unsigned int index);//get NUC-UPS

special constants
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsVerMajor();//get NUC-UPS major version of the firmware
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsVerMinor();//get NUC-UPS minor version of the firmware
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsState();//0 - not connected, 1 - running from battery, 2 - from

vin, 3 - from USB
:extern "C" NUCUPSLIB_API void setNUCUpsDBGMode(unsigned char dbg);//set dbg mode
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsDbgByte(int i);//get NUC-UPS debug bytes - valid only after

setNUCUpsDBGMode(1)
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsDbg2Byte(int i);//get NUC-UPS debug bytes - valid only after

setNUCUpsDBGMode(1)
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsDbg3Byte(int i);//get NUC-UPS debug bytes - valid only after

setNUCUpsDBGMode(1)
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsTimer(unsigned int cnt);//get NUC-UPS timer
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsStateMachines(unsigned int cnt);//get NUC-UPS internal state

machines 0=UPS 1=AFE 2=Charger 3=Detect 4=Batterymanager
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsChgTimer(unsigned int cnt);//get NUC-UPS charger timers
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsChargeEndedCondition();//get NUC-UPS charge ended
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsBatteryLevel();//get NUC-UPS battery level (percents 0-100)
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsCPUUsage();//get NUC-UPS CPU usage
:extern "C" NUCUPSLIB_API void restartNUCUps();//restart NUC-UPS
:extern "C" NUCUPSLIB_API void restartNUCUpsInBootloaderMode();//restart NUC-UPS in bootloader mode
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsMaxVariableCnt();//get NUC-UPS maximum variable count
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsVariableData(unsigned int cnt, char* name, char* value, char* unit,

char* comment);//get NUC-UPS variable data
:extern "C" NUCUPSLIB_API void startNUCUpsLoadingSettings(unsigned char to_file, unsigned char

compare_with_old);//start loading data from device
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsLoadingSettingsState();//get load settings current state: 0-64 -

steps, 100=success, 0xF1-0xFF=failure
:extern "C" NUCUPSLIB_API unsigned char setNUCUpsVariableData(unsigned int cnt, char* value);//set NUC-UPS variable

data for a given variable
:extern "C" NUCUPSLIB_API void startNUCUpsSaveSettings(unsigned char from_file);//start saving data to device
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsSaveSettingsState();//get saving current state: 0-64 - steps,

100=success, 0xF1-0xFF=failure
See the examples for usage.
</code>

IMPORTANT: the API dll needs 4 files from Visual Studio 2005 redistribution pack (Microsoft.VC80.CRT.manifest,

msvcm80.dll, msvcp80.dll, msvcr80.dll).

IMPORTANT: the API supports only one NUC-UPS connected to the computer.

====Visual C++ Example====
Open TestAPI.sln from the package, set CLibTest project as active project, run it and see CLibTest.cpp for usage

example.
====Visual Basic Example====
Open TestAPI.sln from the package, set VBLibTest project as active project, run it and see Module1.vb for usage

example.
====Visual C# Example====
Open TestAPI.sln from the package, set CSLibTest project as active project, run it and see Program.cs for usage

example.

===Download API and example projects===

{| class="wikitable" style="text-align: center;"

|'''Version'''||'''Change list'''
|-
||[https://wiki.mini-box.com/images/3/35/NUCUPSApiTestV1.0.zip '''1.0''']||First version
|-
||[https://wiki.mini-box.com/images/a/af/NUCUPSApiTestV1.1.zip '''1.1''']||Update for Firmware 1.1
|}

Main Page

2020-10-21T14:37:13Z

Admin:

{{DISPLAYTITLE:<span style="display:none">{{FULLPAGENAME}}</span>}}
<div>
<ul>
<li style="display: inline-block;border-bottom:1px solid #ddd;margin:0.5em;"> [[File:OpenUPS2.png|link=|350px|]]<br>
<span style="display:block;text-align:center;font-size:1.5em;">[[openUPS2|openUPS2]]</span> </li>
<li style="display: inline-block;border-bottom:1px solid #ddd;margin:0.5em;"> [[File:DCDC-NUC.png|link=|350px|]]<br>
<span style="display:block;text-align:center;font-size:1.5em;">[[DCDC-NUC|DCDC-NUC]]</span></li>
<li style="display: inline-block;border-bottom:1px solid #ddd;margin:0.5em;"> [[File:NUC-UPS.png|link=|350px|]]<br>
<span style="display:block;text-align:center;font-size:1.5em;">[[NUC-UPS|NUC-UPS]]</span></li>
</ul>
</div>

<h2>PDF Manuals</h2>
[http://resources.mini-box.com/online/PWR-OpenUPS/PWR-OpenUPS-hardware-manual.pdf OpenUPS] <br>
[http://resources.mini-box.com/online/PWR-DCDC-USB/PWR-DCDC-USB-manual.pdf DCDC-USB] <br>
[http://resources.mini-box.com/online/PWR-DCDC-USB-200/PWR-DCDC-USB-200-manual.pdf DCDC-USB-200] <br>

Main Page

2020-10-21T14:32:31Z

Admin:

{{DISPLAYTITLE:<span style="display:none">{{FULLPAGENAME}}</span>}}
<div>
<ul>
<li style="display: inline-block;"> [[File:OpenUPS2.png|link=|350px|]]<br>
[[openUPS2|openUPS2]] </li>
<li style="display: inline-block;"> [[File:DCDC-NUC.png|link=|350px|]]<br>
[[DCDC-NUC|DCDC-NUC]]</li>
<li style="display: inline-block;"> [[File:NUC-UPS.png|link=|350px|]]<br>
[[NUC-UPS|NUC-UPS]]</li>
</ul>
</div>

<h2>PDF Manuals</h2>
[http://resources.mini-box.com/online/PWR-OpenUPS/PWR-OpenUPS-hardware-manual.pdf OpenUPS] <br>
[http://resources.mini-box.com/online/PWR-DCDC-USB/PWR-DCDC-USB-manual.pdf DCDC-USB] <br>
[http://resources.mini-box.com/online/PWR-DCDC-USB-200/PWR-DCDC-USB-200-manual.pdf DCDC-USB-200] <br>

Main Page

2020-10-21T14:22:34Z

Admin:

{{DISPLAYTITLE:<span style="display:none">{{FULLPAGENAME}}</span>}}

<gallery mode="traditional">
Image:OpenUPS2.png‎|''[[openUPS2|openUPS2]]''
Image:DCDC-NUC.png‎|''[[DCDC-NUC|DCDC-NUC]]''
Image:NUC-UPS.png|''[[NUC-UPS|NUC-UPS]]''
</gallery>

<h2>PDF Manuals</h2>
[http://resources.mini-box.com/online/PWR-OpenUPS/PWR-OpenUPS-hardware-manual.pdf OpenUPS] <br>
[http://resources.mini-box.com/online/PWR-DCDC-USB/PWR-DCDC-USB-manual.pdf DCDC-USB] <br>
[http://resources.mini-box.com/online/PWR-DCDC-USB-200/PWR-DCDC-USB-200-manual.pdf DCDC-USB-200] <br>

File:NUC-UPS.png

2020-10-21T14:16:08Z

Admin:

File:DCDC-NUC.png

2020-10-21T14:13:47Z

Admin:

File:OpenUPS2.png

2020-10-21T14:12:39Z

Admin:

Main Page

2020-10-21T14:08:14Z

Admin:

{{DISPLAYTITLE:<span style="display:none">{{FULLPAGENAME}}</span>}}

<gallery>
File:OpenUPS2.png‎|[[openUPS2|openUPS2]]
File:DCDC-NUC.png|[[DCDC-NUC|DCDC-NUC]]
File:NUC-UPS.png|[[NUC-UPS|NUC-UPS]]
</gallery>

[http://resources.mini-box.com/online/PWR-OpenUPS/PWR-OpenUPS-hardware-manual.pdf OpenUPS] <br>
[http://resources.mini-box.com/online/PWR-DCDC-USB/PWR-DCDC-USB-manual.pdf DCDC-USB] <br>
[http://resources.mini-box.com/online/PWR-DCDC-USB-200/PWR-DCDC-USB-200-manual.pdf DCDC-USB-200] <br>

NUC-UPS

2020-10-21T12:18:31Z

Admin: /* Windows System monitor */

'''6-38V Intelligent Automotive grade Uninterruptible Power Supply'''<br><br>
'''Before you start…<br>
Often times, rushing into installing the unit can result in serious damage to your DCDC-NUC UPS board or computer.
Always double check the polarity of your wires with a voltmeter.<br><br>
'''Always double check the polarity of the batteries before introducing into the UPS device.'''<br>
'''Improper configuration leads to system damage!!!'''<br><br>
<nowiki>*</nowiki> NOTE: Forced ventilation or 40% input or output current de-rating or both is required if any of the following conditions are met:<br>
If V(IN) 24-38V <br>
If I(Out) > 2A and T(ambient) > 30°C, open air operation.<br>
In order to prevent premature battery damage due to thermal exposure, always check NUC-UPS board temp and ensure it does not exceed 55C for your application.

==Introduction==
The NUC-UPS was designed to provide +12V regulated power output from a wide input voltage(6V-38V).<br>
It has a range of intelligent functions not found in any of the traditional USB converters.<br>
The unit is able to gracefully shut down motherboards based on Ignition sensing or battery voltage level, by pulsing

the motherboard on/off pins. This makes it an ideal device for automotive or battery powered installations.<br>
It features 4 replaceable Li-Ion batteries for battery backup integrated in the device, there is no need for any

kind of special cabling between cells and UPS.
The charger is a Synchronous Buck-Boost converter capable of charging the batteries with input voltage below, equal

or above battery voltage level.
It charges the battery in three phases: preconditioning, constant current mode and constant voltage mode. <br>
The output converter is a synchronous Buck converter providing regulated 12V output.
The unit can be used as an embedded UPS or as a Portable Energy Pack providing the user with regulated 12V wherever

needed.

==Features==
* USB interface, works with Windows devices (Linux API planned)<br>
* Input between 6-38V<br>
* Programmable thresholds, timings and configuration modes<br>
* Generates regulated 12V output voltage<br>
* Output current 5A continuous
* Supports Li-Ion (3.7V) battery chemistry<br>
* 3 state charger(precharge, constant current, constant voltage)<br>
* Battery balancing, 4S configuration.<br>
* Charge voltage 4x4.2V, charge current 1A, precharge current ~0.3A<br>
* Coulomb counting<br>
* Battery temperature monitoring for each cell and temperature compensated charge<br>
* Start/Stop button and header<br>
* Motherboard ON/OFF pulse control*<br>
* Motherboard detection by power consumption or 5VUSB presence
* Missing battery cells detection<br>
* Ultra low power consumption(5uA- in Deep Sleep mode) or (250uA- in Dumb mode Standby) or (5mA- Automotive mode

Standby)<br>
* Windows detects device as “Battery”, with no special drivers required **<br><br>

==Diagram & Schematics==
==Connectors==
<div style="display: inline; float: left;">[[File:Nucupslegend.jpg|230px|thumb|left|Connectors nomenclature]]</div>
<div style="clear: both;"></div>
===Power Input connectors===
;P1 Input (mini-FIT JR, 1x4 pins)
: P1.1,P1.2-GND
: P1.3-Ignition sensing
: P1.4-Input voltage
;P2 Input (DC Power Jack:2DC-G213-B49, Mating plug 5.50x2.50)

;P3 Output (mini-FIT JR, 1x4 pins)
: P3.1,P3.2-GND
: P3.3,P3.4-Output voltage
;P4 Output (B4B-EH-A(LF)(SN), 1x4 pins)
: P4.1,P4.2-GND
: P4.3,P4.4-Output voltage

===Interface connectors===
;P5 Motherboard POWER SW connection, no polarity (JST_B3B-PH-KL, 1x3pins)
: P5.1: SW1
: P5.2: GND
: P5.3: SW2
;P7 USB header (B4B-PH-K-S(LF)(SN), 1x4pins)
: P7.1: GND
: P7.2: USB D-
: P7.3: USB D+
: P7.4: +5V
;S1&P9 Start/Stop button header (M20-9990246, 1x2pins)
;P8 Programming header
P8.1: MCLR
P8.2: GND
P8.3: 5V
P8.4: PGD
P8.5: PGC

==NUC and OS Settings==
<br>
*'''NUC related settings'''<br><br>
<div>
<div style="display: inline; float: left;">[[File:BIOS.png|230px|thumb|left|NUC Visual BIOS 2.0 Setting]]</div>
:Setting up the NUC's behavior when power is re-applied:<br>
:- press '''F2''' key during the boot sequence to entering the NUC's BIOS (Visual BIOS 2.0)<br>
:- first click on '''Advanced''' then click on '''Power''' menu button<br>
:- in '''Secondary Power Settings''' section select '''Power On''' option for '''After Power Failure'''<br>
:- the picture shows the right option in a red framework<br>
:- now the power supply should be able to '''START''' the NUC by applying corresponding voltage to its power

input<br>
</div>
<div style="clear: both;"></div>

==Firmware update==
It is recommended that you only connect USB power to the device
when making a firmware update via “bootloader mode”.

There are two ways to enter in bootloader mode: 1a) or 1b).<br>
1a) Place a jumper on the P8.4 and P8.5 pins then connect the unit to USB<br>
1b) Connect the unit to USB then press the Switch to bootloader button on the configuration software's user

interface.<br>
2) Start the [http://wiki.mini-box.com/images/a/ae/Bootloader_Software.zip '''HIDBootloader v2.9j.exe'''] software

provided to flash the new firmware.<br>
3) Press File->Import Firmware Image<br>
4) Press Open new Hex [http://wiki.mini-box.com/images/4/4b/DCDC-NUC_UPS-_FW_ver_1.3_for_loading_with_bootloader_2017.oct.09.zip '''File''']<br>
5) Press Program->Erase/Program/Verify Device<br>
6) If used option 1a) remove the jumper
6) Press Program->Reset Device<br>
7) After the device reconnects on USB with the configuration software the new firmware version will be displayed in

the title bar of the software.<br>

==NUC-UPS operating modes==
For configuration purposes only the unit can be started by connecting the unit to USB.<br>
Inserting the batteries should be the first step to perform.<br>
Waking the unit for the first time implies applying input voltage.<br>
The operating modes can be selected by setting the NUC_UPS_MODE parameter to 0(DUMB mode) or 1(AUTOMOTIVE mode).<br>
Further parameters can be customized by changing in the [[NUC-UPS#Parameter_List|'''Parameter List''']].<br>
===Dumb Mode===
:When in this mode the unit still works as an UPS or it can be used as a general purpose battery pack.<br>
;Starting the unit
:In this mode starting can be performed either by applying input voltage or pressing the button for 500ms.<br>
;Stopping the unit
:In this mode stop sequence can be initiated by pressing the button for 500ms.<br>

===Automotive Mode===
;Starting the unit
:In this mode Starting can be performed by applying input voltage and applying ignition voltage.<br>
:The ignition voltage thresholds are configurable set by the IGN_HIGH_THRESHOLD, IGN_LOW_THRESHOLD parameters.The

Ignition voltage must be higher than IGN_HIGH_THRESHOLD for the duration set by the IGN_COUNT parameter in order to

filter out unwanted noise in automotive environment.<br>
;Stopping the unit
:In this mode stop sequence can be initiated if Ignition voltage is lower than IGN_LOW_THRESHOLD parameter for the

duration set by the IGN_COUNT parameter.<br>

===Stop conditions that apply in both modes===
:When the unit is running on batteries the following conditions can initiate shutdown(the shutdown reason can be

identified on the Status-UPS tab,Shutdown groupbox in the Configuration software):<br>
:-one of the cell voltages is less than UPS_VCELL_MIN_STOP parameter, shutdown sequence is initiated.<br>
:-the unit is on battery for more than UPS_ON_BATTERY_TOUT parameter, shutdown sequence is initiated.<br>
:-one of the cell voltages is less than UPS_VCELL_MIN_HARD_STOP parameter, shutdown is immediate.<br>
:-one of the batteries temperature is out of the limits set by the DCHG_TEMP_COLD, DCHG_TEMP_HOT parameters.<br>
:-overload, when the maximum allowed discharge current exceeds the value set by UPS_OVERLOAD parameter.<br>
:If output is out of regulation the unit is immediately stopped.

===Startup and Shutdown sequence===
====Startup sequences====
[[File:Dumb_mode_waking_with_VIN.PNG|600px]]
[[File:Dumb_mode_waking_with_button.PNG|600px]]
[[File:Automotive_mode_waking_with_Ignition.PNG|600px]]<br>
====Shutdown sequences====
[[File:Gracious_shutdown.PNG|600px]]
[[File:Immediate_shutdown.PNG|600px]]

===Motherboard control===
The following options are available to control the motherboard by pulsing the on/off pins on the motherboard.
First the the motherboard On/OFF pins should be connected to the P5.1,P5.3 pin on the P5 [[NUC-UPS#Interface_connectors|'''Interface_connector''']].<br>
The pulse width is 500ms by default which can be altered by changing MOB_PULSEWIDTH parameter from the [[NUC-UPS#Parameter_List|'''Parameter_List''']].<br>
There are various ways to control the motherboard depending the configuration of the CONFIG1 register from the [[NUC-UPS#Parameter_List|'''Parameter_List''']].<br>
Example:If startup of the motherboard is not needed when input is present, the startup pulse can be disabled by setting CONFIG1.b0 to 0.<br>
The same way the shutdown pulse can be inhibited by setting CONFIG1.b1 to 0.<br>
There are cases when motherboard started(ON) or OFF presence must be detected in order starting/stopping by pulses behavior work properly.<br>
For example the Operating System could be shutdown already from software. In case the unit is is a shutdown sequence not knowing this piece of information would lead by sending the shutdown pulse which would wake up instead the system.<br>
There are two kinds of feedback information to detect motherboard status.<br><br>
The first detection mode is by measuring the consumed output power, knowing that a motherboard when started consumes much more power than when in standby.<br>
In order to enable this feature the following steps should be performed:<br>
1. Enable this feature, CONFIG1.b2 should be set to 1.<br>
2. Observe and note the consumption of the connected motherboard when in standby and when is ON.
Our unit measures the output power(POUT) which is displayed in the configuration software.<br>
3. Set POUT_HIGH_THRESHOLD and POUT_LOW_THRESHOLD parameters from the [[NUC-UPS#Parameter_List|'''Parameter_List''']] accordingly with a good margin. <br>
POUT<POUT_LOW_THRESHOLD motherboard is considered OFF.<br>
POUT>POUT_HIGH_THRESHOLD motherboard is considered ON.<br><br>
The second detection mode is by measuring the +5VUSB signal. Usually motherboards turn OFF the +5VUSB signal when they are OFF.<br>
In order to enable this feature CONFIG1.b3 must be set to 1.

==NUC-UPS charger==
The charger is a Synchronous Buck-Boost converter capable of charging the batteries with an input voltage below, equal or above battery voltage level.<br>
The charging happens three phases: preconditioning, constant current mode and constant voltage mode:
:• The charging is starting with a preconditioning phase, where the current is limited to ~350mA. The preconditioning phase has a minimum duration set by CHG_COND_TOUT which is extended if one of the cells voltage is below the limit set by CHG_CELL_VCOND.<br>
:• In constant current phase charge current is limited to 1A. After battery voltage rises to the value set by the hardware charger, the charger will enter constant voltage mode.<br>
:• In constant voltage phase the battery will absorb less current as time passes and charge current will decrease. When the charge current decreases below ~150mA, charging is stopped.<br>

During low power state the charger is disabled, so the charger module is also disabled in automotive mode when the Ignition is OFF, even if input is present.<br>

Charging will be terminated if a global charge timer elapses, this can be set by CHG_GLOBAL_TOUT parameter.<br>
Charging is limited to precharge value if one of the batteries temperature exceeds limits set by CHG_TEMP_COOL,CHG_TEMP_WARM parameters.<br>
Charging is terminated if one of the batteries temperature exceeds the limits set by CHG_TEMP_COLD,CHG_TEMP_HOT. <br>
In order to work properly the following conditions when changing parameters must be fulfilled: CHG_TEMP_COLD < CHG_TEMP_COOL < CHG_TEMP_WARM < CHG_TEMP_HOT.

The temperature sensors are located just below the batteries for proper temperature detection of each cell.<br>
:[[File:Charge-regulation.png|325px|thumb|left|]]
<div style="clear: both;"></div>

==NUC-UPS Charge Balancer==
The balancing algorithm is voltage based. Balancing is allowed if cell voltage exceeds the value set in the BAL_VCELL_MIN parameter.<br>
Balancing is started if the voltage difference between the cells is higher than BAL_VCELL_DIFF_START, and will be stopped if the difference is lower than the value defined in BAL_VCELL_DIFF_STOP parameter.<br>

==NUC-UPS Fuel gauge==
The initial remaining capacity is detected based on an open-circuit voltage based state-of-charge estimation, using the predefined values set by the OCV_SOCxx parameters.
Further estimation is based on coulomb counting method which is more precise after a full charge cycle has been performed.<br>

==Led Blinking==
The unit has two LEDs on board (Red and Green), located on the right and left side of the USB connector.<br>
While there are scenarios where both LEDs are blinking with a certain pattern, the LEDs generally help identifying the power source that runs the UPS output at any given moment.
:• The green LED signals that the NUC-UPS is running from input voltage
:• The red LED signals that the NUC-UPS is running from batteries

The blinking patterns that can occur during operation are shown in the images below. The duration of LED blinks can also be seen on the images, displayed in milliseconds.<br>

[[File:LED_LPWR_Mode_On_USB_Or_In_Automotive_Standby.PNG|600px]]
[[File:LED_Initial_Delay.PNG.PNG|600px]]<br>
[[File:LED_Batteries_Charging.PNG|600px]]
[[File:LED_Running_From_Vin.PNG|600px]]<br>
[[File:LED_Running_From_Battery.PNG|600px]]
[[File:LED_Wait_Hardoff_Running_From_Vin.PNG|600px]]<br>
[[File:LED_Wait_Hardoff_Running_From_Battery.PNG|600px]]
[[File:LED_Missing.PNG|600px]]<br>

==Parameter List==

{| class="wikitable"
! NAME
! Description
|-
| NUC_UPS_MODE[-]
| <pre>
0-Dumb mode (DUMB)
1-Automotive mode (AUTOMOTIVE)
</pre>
NUC_UPS_MODE

|-
| UPS_ON_BATTERY_TOUT
|
Deep sleep timeout. If system is running on battery and this period has elapsed with no input power applied, the UPS

will initiate shut down procedure. "Never" is allowed as value (to disable this feature). Default is "Never".

|-
| INIT_TOUT
|
When all power supply start-up conditions are met, the PSU will wait this time before continuing with the start-up

sequence.

|-
| VIN_MIN_STARTUP
|
If the input voltage is beyond this threshold and all other start-up conditions are met, the PSU can start. Default

is 11000mV.

|-
| VIN_MIN_RUNNING
|
If input voltage is below this threshold, the output is powered from battery. Default is 8000mV.

|-
| VIN_COUNT
|
Input voltage filtering. Default is 100ms.

|-
| IGN_COUNT
|
Ignition voltage filtering. Default is 100ms.

|-
| IGN_HIGH_THRESHOLD
|
If ignition voltage is beyond this threshold, ignition is considered to be ON. Default is 6000mV.

|-
| IGN_LOW_THRESHOLD
|
If ignition voltage is below this threshold, ignition is considered to be OFF. Default is 5000mV.

|-
| IGN_ON_TO_OUTPUT_ON_TOUT
|
After ignition is considered ON, the PSU will wait this time before the output is turned ON. Default is 2000ms.

|-
| IGN_CANCEL_TOUT
|
After the motherboard boots up, the ignition voltage sensing will be disabled for this period. Default is 60s.

|-
| OUTPUT_ON_TO_MOB_PULSE_ON_TOUT
|
After the output was turned on, the UPS will wait this period before sending the ON pulse to the motherboard.

Default is 20ms

|-
| IGN_OFF_TO_MOB_PULSE_OFF_TOUT
|
In automotive mode, after the ignition is considered OFF, this UPS will wait this period before sending the OFF

pulse to the motherboard. Default is 5s

|-
| MOB_PULSEWIDTH
|
The length of the start-up/shutdown pulse sent to the motherboard. Default is 500ms.

|-
| HARD_OFF_TOUT
|
After the shutdown pulse is sent to the motherboard, the UPS will wait this period before the output is turned OFF.
This time-out allows the operating system to perform a clean shutdown. Default is 60s.

|-
| PWM_SPREAD_MODULATING_FREQ
|
Modulation frequency parameter of the Random Spread Frequency Modulation module (used for EMI reduction purposes)

|-
| PWM_SPREAD_PERCENT
|
Frequency deviation parameter of the Random Spread Frequency Modulation module (used for EMI reduction purposes)

|-
| PWM_FREQ
|
Operating frequency of the Switched Mode Power Supply

|-
| CONFIG1
|
Configuration register [b7..b0]. Used for enabling/disabling modules. 0 - disabled, 1 - enabled <br>
b7 - Unused <br>
b6 - Unused <br>
b5 - Unused <br>
b4 - Unused <br>
b3 - If set, the USB sense is enabled, +5V USB is used to detect the Motherboard alive status<br>
b2 - If set, the Power measurement (Vout x Iout) is used to detect the Motherboard alive status<br>
b1 - If set, shutdown pulse is enabled through the PWRSW connector.<br>
b0 - If set, startup pulse is enabled through the PWRSW connector.<br>

Depending motherboard alive status the shutdown/startup pulse is sent if b2/b3 is enabled.
The motherboard presence can be smartly detected if b2/b3 is enabled.
For example: In case motherboard is already shut down the pulse is not sent in case of a shutdown scenario.
This is also true in case of a startup scenario.

|-
| CONFIG2
|
Configuration register. Used for enabling/disabling modules. 0 - disabled, 1 - enabled <br>
b7..b0 - Reserved/Unused <br>

|-
| WRITE_COUNT
|
The number of times the internal Flash program memory has been written.

|-
| IOUT_OFFSET
|
This value will be summed with the measured input current, this is a calibration parameter. Default is 0mA

|-
| CAPACITY
|
Battery Capacity.
Default is 1000mAh.

|-
| UPS_BUTTON_ON_TOUT
|
Filtering time for button pressing. Default is 100ms.

|-
| UPS_VCELL_MIN_START
|
If Vin is not present and all the battery cells are above this threshold, the UPS can start and will run on battery.
Default is 3.6V.

|-
| UPS_VCELL_MIN_STOP
|
If VIN is not present and one of the battery cells is less than this threshold , the UPS will initiate a shutdown

procedure.
Default is 3.3V.

|-
| UPS_VCELL_MIN_HARD_STOP
|
If VIN is not present and one of the battery cells is less than this threshold, the UPS will instantly shut down to

preserve battery.
Default is 3V.

|-
| UPS_OVERLOAD
|
Max allowed discharge current. In case the discharge current exceeds this threshold, shutdown will be initiated.
Default is 6000mA

|-
| DCHG_TEMP_COLD
|
COLD temperature threshold for discharge. In case exceeded UPS will shutdown when on battery. Default is -20°C (FW

ver 1.1)

|-
| DCHG_TEMP_HOT
|
HOT temperature threshold for discharge. In case exceeded UPS will shutdown when on battery. Default is 60°C (FW ver

1.1)

|-
| CHG_COND_TOUT
|
Conditioning/Precharge time. Charge current is limited until cell voltage exceeds CHG_VCOND value and it is applied

during this time.
Default is 30 sec.

|-
| CHG_BULK_STOP_VOLTAGE
|
Maximum allowed bulk charge voltage/cell during constant current/constant voltage charging.
Default is 4.1 [V/cell].

|-
| CHG_HYSTERESIS
|
An overvoltage value ( CHG_BULK_STOP_VOLTAGE + CHG_HYSTERESIS ) that is allowed when charging. If one of the cells

exceeds this value, charging is immediately stopped.
Default is 100mV/cell.

|-
| CHG_START_VOLTAGE
|
If cell voltage is below this value, charging can be started.
Default is 3.85V/cell.

|-
| CHG_GLOBAL_TOUT
|
Global charge timeout.
Default is 240 min.

|-
| CHG_TOPPING_TOUT
|
After an overvoltage condition is detected for a cell (for Lithium based batteries), a resting period is set by this

timer before applying a small topping charge - in case other cells are still not charged.
Default is 60s.

|-
| CHG_TEMP_COLD
|
COLD temperature threshold for temperature compensated charge current regulation.
Default 5°C(FW ver 1.0)

|-
| CHG_TEMP_COOL
|
COOL temperature threshold for temperature compensated charge current regulation.
Default 10°C(FW ver 1.0)

|-
| CHG_TEMP_WARM
|
WARM temperature threshold for temperature compensated charge current regulation.
Default 50°C(FW ver 1.0)

|-
| CHG_TEMP_HOT
|
HOT temperature threshold for temperature compensated charge current regulation.
Default 55°C(FW ver 1.0)

|-
| UPS_VCELL_ADC_OFFSET
|
This value will be summed with the measured cell voltages, this is a calibration parameter. Default is 0mV.

|-
| CHG_CELL_VCOND
|
Conditioning/Pre-charge voltage. Charge current is limited until cell voltage exceeds this value and for at least

CHG_TCOND time . Default is 3.3V

|-
| BAL_VCELL_MIN
|
Balancing is allowed if cell voltages are above this value.
Default is 3.4V

|-
| BAL_VCELL_DIFF_START
|
If the voltage difference between cells exceeds this value, cell balancing will start.
Default is 80mV.

|-
| BAL_VCELL_DIFF_STOP
|
If the voltage difference between cells is less than this value, cell balancing will stop.
Default is 40mV.

|-
| OCV_SOC0
|
Open Circuit Voltage State Of Charge detection for initial 0% fuel gauge estimation.
Default is 3.3V.

|-
| OCV_SOC10
|
Open Circuit Voltage State Of Charge detection for initial 10% fuel gauge estimation.
Default is 3.68V.

|-
| OCV_SOC25
|
Open Circuit Voltage State Of Charge detection for initial 25% fuel gauge estimation.
Default is 3.76V.

|-
| OCV_SOC50
|
Open Circuit Voltage State Of Charge detection for initial 50% fuel gauge estimation.
Default is 3.82V.

|-
| OCV_SOC75
|
Open Circuit Voltage State Of Charge detection for initial 75% fuel gauge estimation.
Default is 3.97V.

|-
| OCV_SOC100
|
Open Circuit Voltage State Of Charge detection for initial 100% fuel gauge estimation.
Default is 4.17V.

|-
| POUT_HIGH_THRESHOLD
|
If output power measured is higher than this threshold the connected motherboard is considered to be ON.
Together with POUT_LOW_THRESHOLD parameter sets a hysteresis for motherboard status. CONFIG1.b2 must be set in order to be active. Default is 3000mW.

|-
| POUT_LOW_THRESHOLD
|
If output power measured is lower than this threshold the connected motherboard is considered to be OFF.
Together with POUT_HIGH_THRESHOLD parameter sets a hysteresis for motherboard status. CONFIG1.b2 must be set in order to be active. Default is 1000mW.
|}

==Software manual==
===Windows OS built-in support===
The NUC-UPS implements two generic USB classes, therefore most of the operating systems are recognizing it without

any additional driver installation. This two classes are:
a.) "HID UPS Battery" for OS built-in communication.
Microsoft Windows versions are recognizing this class automatically and the device should appear in device manager

at Batteries as a "Hid ups battery", together with all settings and power plan possibilities provided by the OS for

any battery.
b.) "HID" for communication and configuration
This endpoint is a generic HID and it is used by our configuration and monitor software to read/write voltages and

other important parameters of the NUC-UPS. This endpoint does not needs any additional driver either, Microsoft

Windows OS should recognize it as a generic HID USB device.

===Configuration software===
The configuration software provides interface for NUC-UPS monitoring, logging and setup.
It's recommended to be used by users with deeper understanding of the NUC-UPS hardware since permits setting

voltages, currents and other parameters which can be
dangerous if they are set without precaution.<br />
The configuration software has three main screens (Status-UPS, Status-Charger and Settings) and a header with the

important voltage/current values.<br />

====The first main screen is the "Status-UPS"====
Example of this screen is shown in the next image:<br />
<div style="display: inline; float: left;">
[[File:NUC-UPS-Status.JPG‎|x350px|thumb|left|Status screen]]
</div>

The title bar shows the connection status, the firmware version and the mode of the NUC-UPS. Example: "NUC-UPS

Connected v1.0 Mode: Dumb"

The header of the status screen contains:
:VIn: Input Voltage
:VIgn: Ignition Voltage
:VBat: Battery Voltage
:VOut: Output Voltage
:POut: Output Power
:IOut: Output Current
:Battery pack %: Battery percentage
:[0]: Battery 0 status
:[1]: Battery 1 status
:[2]: Battery 2 status
:[3]: Battery 3 status
:[Pack]: Battery pack overall voltage and current

The "Status-UPS" screen contains extended information about the current state of the NUC-UPS like internal state

machine, voltages, currents, temperature, different read only state flags.
The user also have the possibility to log the current state into a *.csv file in the "Log" section.
<div style="clear: both;"></div>

====The second main screen is the "Status-Charger"====
<div style="display: inline; float: left;">
[[File:NUC-UPS-Charger.JPG‎|x350px|thumb|left|Status screen]]
</div>
Contains extended information about current state of the NUC-UPS battery charger (internal state machines, flags)
<div style="clear: both;"></div>

====The third main screen is the "Settings"====
Example of this screen is shown in the next image:<br />
<div style="display: inline; float: left;">
[[File:NUC-UPS-Settings.JPG‎|x350px|thumb|left|Settings screen]]
</div>

This screen contains two main sections: the individual parameter setup for experienced users and the parameter

save/load into/from file section.

The main section of the "Settings" screen is the individual parameter settings.<br>
This is recommended to be done only by experienced users. Any parameter of the NUC-UPS can be set from here.

Changing one parameter is simple:
:- select the desired parameter from the "Parameter" list (simple click to select, double-click to edit). Below the

parameter list a helper text is displayed (same from this manual).
:- after double click introduce the new value in the new popup dialog and press OK
:- the introduced value is checked - if something is wrong (out of limit, bad value etc.) error message will be

shown
:- the ! sign will blink on the "Sync all parameters to the NUC-UPS" button to show edited but not saved/synced

variables
:- after You have done with all parameter setting press the "Sync all parameters to the NUC-UPS" button to send all

values to the NUC-UPS. IMPORTANT: without this step the new values will be lost, nothing is sent to the NUC-UPS!

IMPORTANT: any parameter setting is taken into account by the NUC-UPS in this cases:
: - after a full restart either with power cut from all sources (usb, vin)
: - hitting the "Restart NUC-UPS" button
: - keeping the "Reload parameters on the fly after sync" checked.
Do any parameter change with precaution, check the parameters and wires before applying it!

For users who need to setup more devices with the same NUC-UPS settings, it is recommended to use the save/load

parameters buttons.
The "Parameters: NUC-UPS ===> File (settings.ini)" button loads a full configuration from the NUC-UPS and saves it

to the settings.ini file. You can disconnect
the current NUC-UPS from the USB and insert a new one, than press the "Parameters: NUC-UPS <=== File (settings.ini)"

button to send the last saved configuration into the new NUC-UPS.

The "Parameters: NUC-UPS ===> CSV File (settings.csv)" button loads all parameters from the connected NUC-UPS and

saves it into a csv file. This type of file can be opened by any spreadsheet editor (OpenOffice, Microsoft Excel

etc.) and contains the full set of parameters in human readable form.

The "Switch to bootloader" button is intended to be used for firmware updates. After You press this button the NUC-

UPS will disconnect, it will switch to bootloader mode and firmware can be updated as described [[NUC-

UPS#Bootloader_Mode|here]]

Every save/load/sync operation on the "Settings" screen affects the progress bar and the status bar on the bottom of

the screen (labelled with "State:"). In rare cases You
might get error here with "try again" message. This happens in case of one parameter byte get's corrupted or timeout

occurs during USB communication and/or NUC-UPS flashing
operation. Please try again and contact our support team only if the device gives this error 4-5 times in a row.

===Windows System monitor===
The system monitor is a tray bar software which shows the current state on the tray bar icon and a semi transparent

"always on top" capable small window.<br>
The popup window can be moved anywhere on the screen and can be customized. Our current setup has two skins but any

combination is possible playing with the
"skin*.mbs" files installed together with this application. The current skin can be selected right clicking on the

try icon.
The "skin*.mbs" files are simple text ones editable with any text editor (notepad for example).<br>
Adding a new skin is pretty simple – make a skin1.mbs (use the existing skin0.mbs for starting content) and start

playing with the values from the new
file.<br>
The values are self explanatory – skin name, background image files, font descriptions and label/value pair

coordinates for all the important NUC-UPS values.
The size of the popup is defined by the background image – transparent parts can be defined as well (see for

example: "bubble1.bmp").
Example screenshots:<br />
<div style="display: inline; float: left;">
[[File:NUCUPS_sm_tray2.jpg‎|x150px|thumb|left|System monitor skin1 connected]]
</div>
<div style="display: inline; float: left;">
[[File:NUCUPS_sm_tray3.jpg‎|x150px|thumb|left|System monitor skin1 disconnected]]
</div>
<div style="clear: both;"></div>

Right clicking on the tray icon will pop-up a simple menu:
<div style="display: inline; float: left;">
[[File:NUCUPS_sm_menu.jpg‎|x150px|thumb|left|System monitor settings]]
</div>
<div style="clear: both;"></div>
From which You can see firmware version and state of the NUC-UPS from the NUC-UPS Properties and set some visual

parameters of the application (transparency, skin) from Skin:
<div style="display: inline; float: left;">
[[File:NUCUPS_sm_traysettings.jpg‎|x150px|thumb|left|System monitor settings]]
</div>
<div style="clear: both;"></div>

For auto start with the system make a shortcut of AppTray.exe from the standalone package in the system Startup ([http://windows.microsoft.com/en-us/windows/run-program-automatically-windows-starts#1TC=windows-7 Windows 7], [http://support.microsoft.com/kb/2806079 Windows 8]).

===Download software===

{| class="wikitable" style="text-align: center;"

|'''Version'''||'''Change list'''
|-
||[http://wiki.mini-box.com/images/3/33/NUCUPSv1.0.zip '''1.0''']||First version
|-
||[http://wiki.mini-box.com/images/5/55/NUCUPSv1.1.zip '''1.1''']||Update for Firmware 1.1
|}

===Developer manual===
Mini-box.com provides one NUC-UPS API in a DLL (NUCUpsLib.dll) and examples in Visual C++, Visual Basic and Visual

C#.<br>
Basic C++/Visual Basic/C# knowledge is needed to use this examples together with the API.
The API dll has manifest embedded to permit C# and Visual Basic dynamic load.

The API has a set of functions exported to access the full functionality of the NUC-UPS.
This functions are:
<code>
:extern "C" NUCUPSLIB_API const char* STATE_MACHINE_UPS[14];//state machine UPS
:extern "C" NUCUPSLIB_API const char* STATE_MACHINE_AFE[8];//state machine AFE
:extern "C" NUCUPSLIB_API const char* STATE_MACHINE_CHG[16];//state machine Charger
:extern "C" NUCUPSLIB_API const char* STATE_MACHINE_DTCT[16];//state machine Detect
:extern "C" NUCUPSLIB_API const char* STATE_MACHINE_LOWP[4];//state machine low power states
:extern "C" NUCUPSLIB_API unsigned char nucupsOpenDeviceHandler(unsigned int timer);//open device handler. timer

sets the refresh period in miliseconds (4 or 5 messages will be sent in this period e ending from debug mode)

IMPORTANT: the handler can be kept open to notice any NUC-UPS plugged in
:extern "C" NUCUPSLIB_API void nucupsCloseDeviceHandler();//close device handler
:extern "C" NUCUPSLIB_API void getNUCUpsDevicePath(char* path);//Get opened device path @param path - recommended

length 1024, will return empty string if no device opened
:extern "C" NUCUPSLIB_API unsigned char isNUCUpsConnected();//0=not connected, 1=normal state,2=loading settings

from device,3=saving settings from pc,4=saving settings from file
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsMode();//get NUC-UPS mode: 0=Dumb, 1=Automotive
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsInputFlags();//get NUC-UPS input flags
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsOutputFlags();//get NUC-UPS output flags
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsChargerFlags();//get NUC-UPS charger flags
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsStateFlags();//get NUC-UPS state flags
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsShutdownFlags();//get NUC-UPS shutdown flags
:extern "C" NUCUPSLIB_API float getNUCUpsVIn();//get NUC-UPS Input Voltage
:extern "C" NUCUPSLIB_API float getNUCUpsIOut();//get NUC-UPS Output Current
:extern "C" NUCUPSLIB_API float getNUCUpsVOut();//get NUC-UPS Output voltage
:extern "C" NUCUPSLIB_API float getNUCUpsVBats(int i);//get NUC-UPS battery voltages
:extern "C" NUCUPSLIB_API float getNUCUpsTemperature(int i);//get NUC-UPS battery temperature
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsCellBalanceOn(int i);//get NUC-UPS balanced battery (discharged)
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsCellDetected(int i);//get NUC-UPS battery detected
:extern "C" NUCUPSLIB_API float getNUCUpsVIgnition();//get NUC-UPS Ignition Voltage
:extern "C" NUCUPSLIB_API float getNUCUpsPOut();//get NUC-UPS Output Power
:extern "C" NUCUPSLIB_API float getNUCUpsVBat();//get NUC-UPS Bat voltage
:extern "C" NUCUPSLIB_API float getNUCUpsVPack();//get NUC-UPS Pack voltage
:extern "C" NUCUPSLIB_API float getNUCUpsIChgDchg();//get NUC-UPS Charge/Discharge current
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsSpecConsts(unsigned int type, unsigned int index);//get NUC-UPS

special constants
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsVerMajor();//get NUC-UPS major version of the firmware
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsVerMinor();//get NUC-UPS minor version of the firmware
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsState();//0 - not connected, 1 - running from battery, 2 - from

vin, 3 - from USB
:extern "C" NUCUPSLIB_API void setNUCUpsDBGMode(unsigned char dbg);//set dbg mode
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsDbgByte(int i);//get NUC-UPS debug bytes - valid only after

setNUCUpsDBGMode(1)
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsDbg2Byte(int i);//get NUC-UPS debug bytes - valid only after

setNUCUpsDBGMode(1)
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsDbg3Byte(int i);//get NUC-UPS debug bytes - valid only after

setNUCUpsDBGMode(1)
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsTimer(unsigned int cnt);//get NUC-UPS timer
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsStateMachines(unsigned int cnt);//get NUC-UPS internal state

machines 0=UPS 1=AFE 2=Charger 3=Detect 4=Batterymanager
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsChgTimer(unsigned int cnt);//get NUC-UPS charger timers
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsChargeEndedCondition();//get NUC-UPS charge ended
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsBatteryLevel();//get NUC-UPS battery level (percents 0-100)
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsCPUUsage();//get NUC-UPS CPU usage
:extern "C" NUCUPSLIB_API void restartNUCUps();//restart NUC-UPS
:extern "C" NUCUPSLIB_API void restartNUCUpsInBootloaderMode();//restart NUC-UPS in bootloader mode
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsMaxVariableCnt();//get NUC-UPS maximum variable count
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsVariableData(unsigned int cnt, char* name, char* value, char* unit,

char* comment);//get NUC-UPS variable data
:extern "C" NUCUPSLIB_API void startNUCUpsLoadingSettings(unsigned char to_file, unsigned char

compare_with_old);//start loading data from device
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsLoadingSettingsState();//get load settings current state: 0-64 -

steps, 100=success, 0xF1-0xFF=failure
:extern "C" NUCUPSLIB_API unsigned char setNUCUpsVariableData(unsigned int cnt, char* value);//set NUC-UPS variable

data for a given variable
:extern "C" NUCUPSLIB_API void startNUCUpsSaveSettings(unsigned char from_file);//start saving data to device
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsSaveSettingsState();//get saving current state: 0-64 - steps,

100=success, 0xF1-0xFF=failure
See the examples for usage.
</code>

IMPORTANT: the API dll needs 4 files from Visual Studio 2005 redistribution pack (Microsoft.VC80.CRT.manifest,

msvcm80.dll, msvcp80.dll, msvcr80.dll).

IMPORTANT: the API supports only one NUC-UPS connected to the computer.

====Visual C++ Example====
Open TestAPI.sln from the package, set CLibTest project as active project, run it and see CLibTest.cpp for usage

example.
====Visual Basic Example====
Open TestAPI.sln from the package, set VBLibTest project as active project, run it and see Module1.vb for usage

example.
====Visual C# Example====
Open TestAPI.sln from the package, set CSLibTest project as active project, run it and see Program.cs for usage

example.

===Download API and example projects===

{| class="wikitable" style="text-align: center;"

|'''Version'''||'''Change list'''
|-
||[http://wiki.mini-box.com/images/3/35/NUCUPSApiTestV1.0.zip '''1.0''']||First version
|-
||[http://wiki.mini-box.com/images/a/af/NUCUPSApiTestV1.1.zip '''1.1''']||Update for Firmware 1.1
|}

NUC-UPS

2020-10-21T12:15:25Z

Admin: /* Motherboard control */

'''6-38V Intelligent Automotive grade Uninterruptible Power Supply'''<br><br>
'''Before you start…<br>
Often times, rushing into installing the unit can result in serious damage to your DCDC-NUC UPS board or computer.
Always double check the polarity of your wires with a voltmeter.<br><br>
'''Always double check the polarity of the batteries before introducing into the UPS device.'''<br>
'''Improper configuration leads to system damage!!!'''<br><br>
<nowiki>*</nowiki> NOTE: Forced ventilation or 40% input or output current de-rating or both is required if any of the following conditions are met:<br>
If V(IN) 24-38V <br>
If I(Out) > 2A and T(ambient) > 30°C, open air operation.<br>
In order to prevent premature battery damage due to thermal exposure, always check NUC-UPS board temp and ensure it does not exceed 55C for your application.

==Introduction==
The NUC-UPS was designed to provide +12V regulated power output from a wide input voltage(6V-38V).<br>
It has a range of intelligent functions not found in any of the traditional USB converters.<br>
The unit is able to gracefully shut down motherboards based on Ignition sensing or battery voltage level, by pulsing

the motherboard on/off pins. This makes it an ideal device for automotive or battery powered installations.<br>
It features 4 replaceable Li-Ion batteries for battery backup integrated in the device, there is no need for any

kind of special cabling between cells and UPS.
The charger is a Synchronous Buck-Boost converter capable of charging the batteries with input voltage below, equal

or above battery voltage level.
It charges the battery in three phases: preconditioning, constant current mode and constant voltage mode. <br>
The output converter is a synchronous Buck converter providing regulated 12V output.
The unit can be used as an embedded UPS or as a Portable Energy Pack providing the user with regulated 12V wherever

needed.

==Features==
* USB interface, works with Windows devices (Linux API planned)<br>
* Input between 6-38V<br>
* Programmable thresholds, timings and configuration modes<br>
* Generates regulated 12V output voltage<br>
* Output current 5A continuous
* Supports Li-Ion (3.7V) battery chemistry<br>
* 3 state charger(precharge, constant current, constant voltage)<br>
* Battery balancing, 4S configuration.<br>
* Charge voltage 4x4.2V, charge current 1A, precharge current ~0.3A<br>
* Coulomb counting<br>
* Battery temperature monitoring for each cell and temperature compensated charge<br>
* Start/Stop button and header<br>
* Motherboard ON/OFF pulse control*<br>
* Motherboard detection by power consumption or 5VUSB presence
* Missing battery cells detection<br>
* Ultra low power consumption(5uA- in Deep Sleep mode) or (250uA- in Dumb mode Standby) or (5mA- Automotive mode

Standby)<br>
* Windows detects device as “Battery”, with no special drivers required **<br><br>

==Diagram & Schematics==
==Connectors==
<div style="display: inline; float: left;">[[File:Nucupslegend.jpg|230px|thumb|left|Connectors nomenclature]]</div>
<div style="clear: both;"></div>
===Power Input connectors===
;P1 Input (mini-FIT JR, 1x4 pins)
: P1.1,P1.2-GND
: P1.3-Ignition sensing
: P1.4-Input voltage
;P2 Input (DC Power Jack:2DC-G213-B49, Mating plug 5.50x2.50)

;P3 Output (mini-FIT JR, 1x4 pins)
: P3.1,P3.2-GND
: P3.3,P3.4-Output voltage
;P4 Output (B4B-EH-A(LF)(SN), 1x4 pins)
: P4.1,P4.2-GND
: P4.3,P4.4-Output voltage

===Interface connectors===
;P5 Motherboard POWER SW connection, no polarity (JST_B3B-PH-KL, 1x3pins)
: P5.1: SW1
: P5.2: GND
: P5.3: SW2
;P7 USB header (B4B-PH-K-S(LF)(SN), 1x4pins)
: P7.1: GND
: P7.2: USB D-
: P7.3: USB D+
: P7.4: +5V
;S1&P9 Start/Stop button header (M20-9990246, 1x2pins)
;P8 Programming header
P8.1: MCLR
P8.2: GND
P8.3: 5V
P8.4: PGD
P8.5: PGC

==NUC and OS Settings==
<br>
*'''NUC related settings'''<br><br>
<div>
<div style="display: inline; float: left;">[[File:BIOS.png|230px|thumb|left|NUC Visual BIOS 2.0 Setting]]</div>
:Setting up the NUC's behavior when power is re-applied:<br>
:- press '''F2''' key during the boot sequence to entering the NUC's BIOS (Visual BIOS 2.0)<br>
:- first click on '''Advanced''' then click on '''Power''' menu button<br>
:- in '''Secondary Power Settings''' section select '''Power On''' option for '''After Power Failure'''<br>
:- the picture shows the right option in a red framework<br>
:- now the power supply should be able to '''START''' the NUC by applying corresponding voltage to its power

input<br>
</div>
<div style="clear: both;"></div>

==Firmware update==
It is recommended that you only connect USB power to the device
when making a firmware update via “bootloader mode”.

There are two ways to enter in bootloader mode: 1a) or 1b).<br>
1a) Place a jumper on the P8.4 and P8.5 pins then connect the unit to USB<br>
1b) Connect the unit to USB then press the Switch to bootloader button on the configuration software's user

interface.<br>
2) Start the [http://wiki.mini-box.com/images/a/ae/Bootloader_Software.zip '''HIDBootloader v2.9j.exe'''] software

provided to flash the new firmware.<br>
3) Press File->Import Firmware Image<br>
4) Press Open new Hex [http://wiki.mini-box.com/images/4/4b/DCDC-NUC_UPS-_FW_ver_1.3_for_loading_with_bootloader_2017.oct.09.zip '''File''']<br>
5) Press Program->Erase/Program/Verify Device<br>
6) If used option 1a) remove the jumper
6) Press Program->Reset Device<br>
7) After the device reconnects on USB with the configuration software the new firmware version will be displayed in

the title bar of the software.<br>

==NUC-UPS operating modes==
For configuration purposes only the unit can be started by connecting the unit to USB.<br>
Inserting the batteries should be the first step to perform.<br>
Waking the unit for the first time implies applying input voltage.<br>
The operating modes can be selected by setting the NUC_UPS_MODE parameter to 0(DUMB mode) or 1(AUTOMOTIVE mode).<br>
Further parameters can be customized by changing in the [[NUC-UPS#Parameter_List|'''Parameter List''']].<br>
===Dumb Mode===
:When in this mode the unit still works as an UPS or it can be used as a general purpose battery pack.<br>
;Starting the unit
:In this mode starting can be performed either by applying input voltage or pressing the button for 500ms.<br>
;Stopping the unit
:In this mode stop sequence can be initiated by pressing the button for 500ms.<br>

===Automotive Mode===
;Starting the unit
:In this mode Starting can be performed by applying input voltage and applying ignition voltage.<br>
:The ignition voltage thresholds are configurable set by the IGN_HIGH_THRESHOLD, IGN_LOW_THRESHOLD parameters.The

Ignition voltage must be higher than IGN_HIGH_THRESHOLD for the duration set by the IGN_COUNT parameter in order to

filter out unwanted noise in automotive environment.<br>
;Stopping the unit
:In this mode stop sequence can be initiated if Ignition voltage is lower than IGN_LOW_THRESHOLD parameter for the

duration set by the IGN_COUNT parameter.<br>

===Stop conditions that apply in both modes===
:When the unit is running on batteries the following conditions can initiate shutdown(the shutdown reason can be

identified on the Status-UPS tab,Shutdown groupbox in the Configuration software):<br>
:-one of the cell voltages is less than UPS_VCELL_MIN_STOP parameter, shutdown sequence is initiated.<br>
:-the unit is on battery for more than UPS_ON_BATTERY_TOUT parameter, shutdown sequence is initiated.<br>
:-one of the cell voltages is less than UPS_VCELL_MIN_HARD_STOP parameter, shutdown is immediate.<br>
:-one of the batteries temperature is out of the limits set by the DCHG_TEMP_COLD, DCHG_TEMP_HOT parameters.<br>
:-overload, when the maximum allowed discharge current exceeds the value set by UPS_OVERLOAD parameter.<br>
:If output is out of regulation the unit is immediately stopped.

===Startup and Shutdown sequence===
====Startup sequences====
[[File:Dumb_mode_waking_with_VIN.PNG|600px]]
[[File:Dumb_mode_waking_with_button.PNG|600px]]
[[File:Automotive_mode_waking_with_Ignition.PNG|600px]]<br>
====Shutdown sequences====
[[File:Gracious_shutdown.PNG|600px]]
[[File:Immediate_shutdown.PNG|600px]]

===Motherboard control===
The following options are available to control the motherboard by pulsing the on/off pins on the motherboard.
First the the motherboard On/OFF pins should be connected to the P5.1,P5.3 pin on the P5 [[NUC-UPS#Interface_connectors|'''Interface_connector''']].<br>
The pulse width is 500ms by default which can be altered by changing MOB_PULSEWIDTH parameter from the [[NUC-UPS#Parameter_List|'''Parameter_List''']].<br>
There are various ways to control the motherboard depending the configuration of the CONFIG1 register from the [[NUC-UPS#Parameter_List|'''Parameter_List''']].<br>
Example:If startup of the motherboard is not needed when input is present, the startup pulse can be disabled by setting CONFIG1.b0 to 0.<br>
The same way the shutdown pulse can be inhibited by setting CONFIG1.b1 to 0.<br>
There are cases when motherboard started(ON) or OFF presence must be detected in order starting/stopping by pulses behavior work properly.<br>
For example the Operating System could be shutdown already from software. In case the unit is is a shutdown sequence not knowing this piece of information would lead by sending the shutdown pulse which would wake up instead the system.<br>
There are two kinds of feedback information to detect motherboard status.<br><br>
The first detection mode is by measuring the consumed output power, knowing that a motherboard when started consumes much more power than when in standby.<br>
In order to enable this feature the following steps should be performed:<br>
1. Enable this feature, CONFIG1.b2 should be set to 1.<br>
2. Observe and note the consumption of the connected motherboard when in standby and when is ON.
Our unit measures the output power(POUT) which is displayed in the configuration software.<br>
3. Set POUT_HIGH_THRESHOLD and POUT_LOW_THRESHOLD parameters from the [[NUC-UPS#Parameter_List|'''Parameter_List''']] accordingly with a good margin. <br>
POUT<POUT_LOW_THRESHOLD motherboard is considered OFF.<br>
POUT>POUT_HIGH_THRESHOLD motherboard is considered ON.<br><br>
The second detection mode is by measuring the +5VUSB signal. Usually motherboards turn OFF the +5VUSB signal when they are OFF.<br>
In order to enable this feature CONFIG1.b3 must be set to 1.

==NUC-UPS charger==
The charger is a Synchronous Buck-Boost converter capable of charging the batteries with an input voltage below, equal or above battery voltage level.<br>
The charging happens three phases: preconditioning, constant current mode and constant voltage mode:
:• The charging is starting with a preconditioning phase, where the current is limited to ~350mA. The preconditioning phase has a minimum duration set by CHG_COND_TOUT which is extended if one of the cells voltage is below the limit set by CHG_CELL_VCOND.<br>
:• In constant current phase charge current is limited to 1A. After battery voltage rises to the value set by the hardware charger, the charger will enter constant voltage mode.<br>
:• In constant voltage phase the battery will absorb less current as time passes and charge current will decrease. When the charge current decreases below ~150mA, charging is stopped.<br>

During low power state the charger is disabled, so the charger module is also disabled in automotive mode when the Ignition is OFF, even if input is present.<br>

Charging will be terminated if a global charge timer elapses, this can be set by CHG_GLOBAL_TOUT parameter.<br>
Charging is limited to precharge value if one of the batteries temperature exceeds limits set by CHG_TEMP_COOL,CHG_TEMP_WARM parameters.<br>
Charging is terminated if one of the batteries temperature exceeds the limits set by CHG_TEMP_COLD,CHG_TEMP_HOT. <br>
In order to work properly the following conditions when changing parameters must be fulfilled: CHG_TEMP_COLD < CHG_TEMP_COOL < CHG_TEMP_WARM < CHG_TEMP_HOT.

The temperature sensors are located just below the batteries for proper temperature detection of each cell.<br>
:[[File:Charge-regulation.png|325px|thumb|left|]]
<div style="clear: both;"></div>

==NUC-UPS Charge Balancer==
The balancing algorithm is voltage based. Balancing is allowed if cell voltage exceeds the value set in the BAL_VCELL_MIN parameter.<br>
Balancing is started if the voltage difference between the cells is higher than BAL_VCELL_DIFF_START, and will be stopped if the difference is lower than the value defined in BAL_VCELL_DIFF_STOP parameter.<br>

==NUC-UPS Fuel gauge==
The initial remaining capacity is detected based on an open-circuit voltage based state-of-charge estimation, using the predefined values set by the OCV_SOCxx parameters.
Further estimation is based on coulomb counting method which is more precise after a full charge cycle has been performed.<br>

==Led Blinking==
The unit has two LEDs on board (Red and Green), located on the right and left side of the USB connector.<br>
While there are scenarios where both LEDs are blinking with a certain pattern, the LEDs generally help identifying the power source that runs the UPS output at any given moment.
:• The green LED signals that the NUC-UPS is running from input voltage
:• The red LED signals that the NUC-UPS is running from batteries

The blinking patterns that can occur during operation are shown in the images below. The duration of LED blinks can also be seen on the images, displayed in milliseconds.<br>

[[File:LED_LPWR_Mode_On_USB_Or_In_Automotive_Standby.PNG|600px]]
[[File:LED_Initial_Delay.PNG.PNG|600px]]<br>
[[File:LED_Batteries_Charging.PNG|600px]]
[[File:LED_Running_From_Vin.PNG|600px]]<br>
[[File:LED_Running_From_Battery.PNG|600px]]
[[File:LED_Wait_Hardoff_Running_From_Vin.PNG|600px]]<br>
[[File:LED_Wait_Hardoff_Running_From_Battery.PNG|600px]]
[[File:LED_Missing.PNG|600px]]<br>

==Parameter List==

{| class="wikitable"
! NAME
! Description
|-
| NUC_UPS_MODE[-]
| <pre>
0-Dumb mode (DUMB)
1-Automotive mode (AUTOMOTIVE)
</pre>
NUC_UPS_MODE

|-
| UPS_ON_BATTERY_TOUT
|
Deep sleep timeout. If system is running on battery and this period has elapsed with no input power applied, the UPS

will initiate shut down procedure. "Never" is allowed as value (to disable this feature). Default is "Never".

|-
| INIT_TOUT
|
When all power supply start-up conditions are met, the PSU will wait this time before continuing with the start-up

sequence.

|-
| VIN_MIN_STARTUP
|
If the input voltage is beyond this threshold and all other start-up conditions are met, the PSU can start. Default

is 11000mV.

|-
| VIN_MIN_RUNNING
|
If input voltage is below this threshold, the output is powered from battery. Default is 8000mV.

|-
| VIN_COUNT
|
Input voltage filtering. Default is 100ms.

|-
| IGN_COUNT
|
Ignition voltage filtering. Default is 100ms.

|-
| IGN_HIGH_THRESHOLD
|
If ignition voltage is beyond this threshold, ignition is considered to be ON. Default is 6000mV.

|-
| IGN_LOW_THRESHOLD
|
If ignition voltage is below this threshold, ignition is considered to be OFF. Default is 5000mV.

|-
| IGN_ON_TO_OUTPUT_ON_TOUT
|
After ignition is considered ON, the PSU will wait this time before the output is turned ON. Default is 2000ms.

|-
| IGN_CANCEL_TOUT
|
After the motherboard boots up, the ignition voltage sensing will be disabled for this period. Default is 60s.

|-
| OUTPUT_ON_TO_MOB_PULSE_ON_TOUT
|
After the output was turned on, the UPS will wait this period before sending the ON pulse to the motherboard.

Default is 20ms

|-
| IGN_OFF_TO_MOB_PULSE_OFF_TOUT
|
In automotive mode, after the ignition is considered OFF, this UPS will wait this period before sending the OFF

pulse to the motherboard. Default is 5s

|-
| MOB_PULSEWIDTH
|
The length of the start-up/shutdown pulse sent to the motherboard. Default is 500ms.

|-
| HARD_OFF_TOUT
|
After the shutdown pulse is sent to the motherboard, the UPS will wait this period before the output is turned OFF.
This time-out allows the operating system to perform a clean shutdown. Default is 60s.

|-
| PWM_SPREAD_MODULATING_FREQ
|
Modulation frequency parameter of the Random Spread Frequency Modulation module (used for EMI reduction purposes)

|-
| PWM_SPREAD_PERCENT
|
Frequency deviation parameter of the Random Spread Frequency Modulation module (used for EMI reduction purposes)

|-
| PWM_FREQ
|
Operating frequency of the Switched Mode Power Supply

|-
| CONFIG1
|
Configuration register [b7..b0]. Used for enabling/disabling modules. 0 - disabled, 1 - enabled <br>
b7 - Unused <br>
b6 - Unused <br>
b5 - Unused <br>
b4 - Unused <br>
b3 - If set, the USB sense is enabled, +5V USB is used to detect the Motherboard alive status<br>
b2 - If set, the Power measurement (Vout x Iout) is used to detect the Motherboard alive status<br>
b1 - If set, shutdown pulse is enabled through the PWRSW connector.<br>
b0 - If set, startup pulse is enabled through the PWRSW connector.<br>

Depending motherboard alive status the shutdown/startup pulse is sent if b2/b3 is enabled.
The motherboard presence can be smartly detected if b2/b3 is enabled.
For example: In case motherboard is already shut down the pulse is not sent in case of a shutdown scenario.
This is also true in case of a startup scenario.

|-
| CONFIG2
|
Configuration register. Used for enabling/disabling modules. 0 - disabled, 1 - enabled <br>
b7..b0 - Reserved/Unused <br>

|-
| WRITE_COUNT
|
The number of times the internal Flash program memory has been written.

|-
| IOUT_OFFSET
|
This value will be summed with the measured input current, this is a calibration parameter. Default is 0mA

|-
| CAPACITY
|
Battery Capacity.
Default is 1000mAh.

|-
| UPS_BUTTON_ON_TOUT
|
Filtering time for button pressing. Default is 100ms.

|-
| UPS_VCELL_MIN_START
|
If Vin is not present and all the battery cells are above this threshold, the UPS can start and will run on battery.
Default is 3.6V.

|-
| UPS_VCELL_MIN_STOP
|
If VIN is not present and one of the battery cells is less than this threshold , the UPS will initiate a shutdown

procedure.
Default is 3.3V.

|-
| UPS_VCELL_MIN_HARD_STOP
|
If VIN is not present and one of the battery cells is less than this threshold, the UPS will instantly shut down to

preserve battery.
Default is 3V.

|-
| UPS_OVERLOAD
|
Max allowed discharge current. In case the discharge current exceeds this threshold, shutdown will be initiated.
Default is 6000mA

|-
| DCHG_TEMP_COLD
|
COLD temperature threshold for discharge. In case exceeded UPS will shutdown when on battery. Default is -20°C (FW

ver 1.1)

|-
| DCHG_TEMP_HOT
|
HOT temperature threshold for discharge. In case exceeded UPS will shutdown when on battery. Default is 60°C (FW ver

1.1)

|-
| CHG_COND_TOUT
|
Conditioning/Precharge time. Charge current is limited until cell voltage exceeds CHG_VCOND value and it is applied

during this time.
Default is 30 sec.

|-
| CHG_BULK_STOP_VOLTAGE
|
Maximum allowed bulk charge voltage/cell during constant current/constant voltage charging.
Default is 4.1 [V/cell].

|-
| CHG_HYSTERESIS
|
An overvoltage value ( CHG_BULK_STOP_VOLTAGE + CHG_HYSTERESIS ) that is allowed when charging. If one of the cells

exceeds this value, charging is immediately stopped.
Default is 100mV/cell.

|-
| CHG_START_VOLTAGE
|
If cell voltage is below this value, charging can be started.
Default is 3.85V/cell.

|-
| CHG_GLOBAL_TOUT
|
Global charge timeout.
Default is 240 min.

|-
| CHG_TOPPING_TOUT
|
After an overvoltage condition is detected for a cell (for Lithium based batteries), a resting period is set by this

timer before applying a small topping charge - in case other cells are still not charged.
Default is 60s.

|-
| CHG_TEMP_COLD
|
COLD temperature threshold for temperature compensated charge current regulation.
Default 5°C(FW ver 1.0)

|-
| CHG_TEMP_COOL
|
COOL temperature threshold for temperature compensated charge current regulation.
Default 10°C(FW ver 1.0)

|-
| CHG_TEMP_WARM
|
WARM temperature threshold for temperature compensated charge current regulation.
Default 50°C(FW ver 1.0)

|-
| CHG_TEMP_HOT
|
HOT temperature threshold for temperature compensated charge current regulation.
Default 55°C(FW ver 1.0)

|-
| UPS_VCELL_ADC_OFFSET
|
This value will be summed with the measured cell voltages, this is a calibration parameter. Default is 0mV.

|-
| CHG_CELL_VCOND
|
Conditioning/Pre-charge voltage. Charge current is limited until cell voltage exceeds this value and for at least

CHG_TCOND time . Default is 3.3V

|-
| BAL_VCELL_MIN
|
Balancing is allowed if cell voltages are above this value.
Default is 3.4V

|-
| BAL_VCELL_DIFF_START
|
If the voltage difference between cells exceeds this value, cell balancing will start.
Default is 80mV.

|-
| BAL_VCELL_DIFF_STOP
|
If the voltage difference between cells is less than this value, cell balancing will stop.
Default is 40mV.

|-
| OCV_SOC0
|
Open Circuit Voltage State Of Charge detection for initial 0% fuel gauge estimation.
Default is 3.3V.

|-
| OCV_SOC10
|
Open Circuit Voltage State Of Charge detection for initial 10% fuel gauge estimation.
Default is 3.68V.

|-
| OCV_SOC25
|
Open Circuit Voltage State Of Charge detection for initial 25% fuel gauge estimation.
Default is 3.76V.

|-
| OCV_SOC50
|
Open Circuit Voltage State Of Charge detection for initial 50% fuel gauge estimation.
Default is 3.82V.

|-
| OCV_SOC75
|
Open Circuit Voltage State Of Charge detection for initial 75% fuel gauge estimation.
Default is 3.97V.

|-
| OCV_SOC100
|
Open Circuit Voltage State Of Charge detection for initial 100% fuel gauge estimation.
Default is 4.17V.

|-
| POUT_HIGH_THRESHOLD
|
If output power measured is higher than this threshold the connected motherboard is considered to be ON.
Together with POUT_LOW_THRESHOLD parameter sets a hysteresis for motherboard status. CONFIG1.b2 must be set in order to be active. Default is 3000mW.

|-
| POUT_LOW_THRESHOLD
|
If output power measured is lower than this threshold the connected motherboard is considered to be OFF.
Together with POUT_HIGH_THRESHOLD parameter sets a hysteresis for motherboard status. CONFIG1.b2 must be set in order to be active. Default is 1000mW.
|}

==Software manual==
===Windows OS built-in support===
The NUC-UPS implements two generic USB classes, therefore most of the operating systems are recognizing it without

any additional driver installation. This two classes are:
a.) "HID UPS Battery" for OS built-in communication.
Microsoft Windows versions are recognizing this class automatically and the device should appear in device manager

at Batteries as a "Hid ups battery", together with all settings and power plan possibilities provided by the OS for

any battery.
b.) "HID" for communication and configuration
This endpoint is a generic HID and it is used by our configuration and monitor software to read/write voltages and

other important parameters of the NUC-UPS. This endpoint does not needs any additional driver either, Microsoft

Windows OS should recognize it as a generic HID USB device.

===Configuration software===
The configuration software provides interface for NUC-UPS monitoring, logging and setup.
It's recommended to be used by users with deeper understanding of the NUC-UPS hardware since permits setting

voltages, currents and other parameters which can be
dangerous if they are set without precaution.<br />
The configuration software has three main screens (Status-UPS, Status-Charger and Settings) and a header with the

important voltage/current values.<br />

====The first main screen is the "Status-UPS"====
Example of this screen is shown in the next image:<br />
<div style="display: inline; float: left;">
[[File:NUC-UPS-Status.JPG‎|x350px|thumb|left|Status screen]]
</div>

The title bar shows the connection status, the firmware version and the mode of the NUC-UPS. Example: "NUC-UPS

Connected v1.0 Mode: Dumb"

The header of the status screen contains:
:VIn: Input Voltage
:VIgn: Ignition Voltage
:VBat: Battery Voltage
:VOut: Output Voltage
:POut: Output Power
:IOut: Output Current
:Battery pack %: Battery percentage
:[0]: Battery 0 status
:[1]: Battery 1 status
:[2]: Battery 2 status
:[3]: Battery 3 status
:[Pack]: Battery pack overall voltage and current

The "Status-UPS" screen contains extended information about the current state of the NUC-UPS like internal state

machine, voltages, currents, temperature, different read only state flags.
The user also have the possibility to log the current state into a *.csv file in the "Log" section.
<div style="clear: both;"></div>

====The second main screen is the "Status-Charger"====
<div style="display: inline; float: left;">
[[File:NUC-UPS-Charger.JPG‎|x350px|thumb|left|Status screen]]
</div>
Contains extended information about current state of the NUC-UPS battery charger (internal state machines, flags)
<div style="clear: both;"></div>

====The third main screen is the "Settings"====
Example of this screen is shown in the next image:<br />
<div style="display: inline; float: left;">
[[File:NUC-UPS-Settings.JPG‎|x350px|thumb|left|Settings screen]]
</div>

This screen contains two main sections: the individual parameter setup for experienced users and the parameter

save/load into/from file section.

The main section of the "Settings" screen is the individual parameter settings.<br>
This is recommended to be done only by experienced users. Any parameter of the NUC-UPS can be set from here.

Changing one parameter is simple:
:- select the desired parameter from the "Parameter" list (simple click to select, double-click to edit). Below the

parameter list a helper text is displayed (same from this manual).
:- after double click introduce the new value in the new popup dialog and press OK
:- the introduced value is checked - if something is wrong (out of limit, bad value etc.) error message will be

shown
:- the ! sign will blink on the "Sync all parameters to the NUC-UPS" button to show edited but not saved/synced

variables
:- after You have done with all parameter setting press the "Sync all parameters to the NUC-UPS" button to send all

values to the NUC-UPS. IMPORTANT: without this step the new values will be lost, nothing is sent to the NUC-UPS!

IMPORTANT: any parameter setting is taken into account by the NUC-UPS in this cases:
: - after a full restart either with power cut from all sources (usb, vin)
: - hitting the "Restart NUC-UPS" button
: - keeping the "Reload parameters on the fly after sync" checked.
Do any parameter change with precaution, check the parameters and wires before applying it!

For users who need to setup more devices with the same NUC-UPS settings, it is recommended to use the save/load

parameters buttons.
The "Parameters: NUC-UPS ===> File (settings.ini)" button loads a full configuration from the NUC-UPS and saves it

to the settings.ini file. You can disconnect
the current NUC-UPS from the USB and insert a new one, than press the "Parameters: NUC-UPS <=== File (settings.ini)"

button to send the last saved configuration into the new NUC-UPS.

The "Parameters: NUC-UPS ===> CSV File (settings.csv)" button loads all parameters from the connected NUC-UPS and

saves it into a csv file. This type of file can be opened by any spreadsheet editor (OpenOffice, Microsoft Excel

etc.) and contains the full set of parameters in human readable form.

The "Switch to bootloader" button is intended to be used for firmware updates. After You press this button the NUC-

UPS will disconnect, it will switch to bootloader mode and firmware can be updated as described [[NUC-

UPS#Bootloader_Mode|here]]

Every save/load/sync operation on the "Settings" screen affects the progress bar and the status bar on the bottom of

the screen (labelled with "State:"). In rare cases You
might get error here with "try again" message. This happens in case of one parameter byte get's corrupted or timeout

occurs during USB communication and/or NUC-UPS flashing
operation. Please try again and contact our support team only if the device gives this error 4-5 times in a row.

===Windows System monitor===
The system monitor is a tray bar software which shows the current state on the tray bar icon and a semi transparent

"always on top" capable small window.<br>
The popup window can be moved anywhere on the screen and can be customized. Our current setup has two skins but any

combination is possible playing with the
"skin*.mbs" files installed together with this application. The current skin can be selected right clicking on the

try icon.
The "skin*.mbs" files are simple text ones editable with any text editor (notepad for example).<br>
Adding a new skin is pretty simple – make a skin1.mbs (use the existing skin0.mbs for starting content) and start

playing with the values from the new
file.<br>
The values are self explanatory – skin name, background image files, font descriptions and label/value pair

coordinates for all the important NUC-UPS values.
The size of the popup is defined by the background image – transparent parts can be defined as well (see for

example: "bubble1.bmp").
Example screenshots:<br />
<div style="display: inline; float: left;">
[[File:NUCUPS_sm_tray2.jpg‎|x150px|thumb|left|System monitor skin1 connected]]
</div>
<div style="display: inline; float: left;">
[[File:NUCUPS_sm_tray3.jpg‎|x150px|thumb|left|System monitor skin1 disconnected]]
</div>
<div style="clear: both;"></div>

Right clicking on the tray icon will pop-up a simple menu:
<div style="display: inline; float: left;">
[[File:NUCUPS_sm_menu.jpg‎|x150px|thumb|left|System monitor settings]]
</div>
<div style="clear: both;"></div>
From which You can see firmware version and state of the NUC-UPS from the NUC-UPS Properties and set some visual

parameters of the application (transparency, skin) from Skin:
<div style="display: inline; float: left;">
[[File:NUCUPS_sm_traysettings.jpg‎|x150px|thumb|left|System monitor settings]]
</div>
<div style="clear: both;"></div>

For auto start with the system make a shortcut of AppTray.exe from the standalone package in the system Startup

([http://windows.microsoft.com/en-us/windows/run-program-automatically-windows-starts#1TC=windows-7 '''Windows

7'''], [http://support.microsoft.com/kb/2806079 '''Windows 8''']).

===Download software===

{| class="wikitable" style="text-align: center;"

|'''Version'''||'''Change list'''
|-
||[http://wiki.mini-box.com/images/3/33/NUCUPSv1.0.zip '''1.0''']||First version
|-
||[http://wiki.mini-box.com/images/5/55/NUCUPSv1.1.zip '''1.1''']||Update for Firmware 1.1
|}

===Developer manual===
Mini-box.com provides one NUC-UPS API in a DLL (NUCUpsLib.dll) and examples in Visual C++, Visual Basic and Visual

C#.<br>
Basic C++/Visual Basic/C# knowledge is needed to use this examples together with the API.
The API dll has manifest embedded to permit C# and Visual Basic dynamic load.

The API has a set of functions exported to access the full functionality of the NUC-UPS.
This functions are:
<code>
:extern "C" NUCUPSLIB_API const char* STATE_MACHINE_UPS[14];//state machine UPS
:extern "C" NUCUPSLIB_API const char* STATE_MACHINE_AFE[8];//state machine AFE
:extern "C" NUCUPSLIB_API const char* STATE_MACHINE_CHG[16];//state machine Charger
:extern "C" NUCUPSLIB_API const char* STATE_MACHINE_DTCT[16];//state machine Detect
:extern "C" NUCUPSLIB_API const char* STATE_MACHINE_LOWP[4];//state machine low power states
:extern "C" NUCUPSLIB_API unsigned char nucupsOpenDeviceHandler(unsigned int timer);//open device handler. timer

sets the refresh period in miliseconds (4 or 5 messages will be sent in this period e ending from debug mode)

IMPORTANT: the handler can be kept open to notice any NUC-UPS plugged in
:extern "C" NUCUPSLIB_API void nucupsCloseDeviceHandler();//close device handler
:extern "C" NUCUPSLIB_API void getNUCUpsDevicePath(char* path);//Get opened device path @param path - recommended

length 1024, will return empty string if no device opened
:extern "C" NUCUPSLIB_API unsigned char isNUCUpsConnected();//0=not connected, 1=normal state,2=loading settings

from device,3=saving settings from pc,4=saving settings from file
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsMode();//get NUC-UPS mode: 0=Dumb, 1=Automotive
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsInputFlags();//get NUC-UPS input flags
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsOutputFlags();//get NUC-UPS output flags
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsChargerFlags();//get NUC-UPS charger flags
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsStateFlags();//get NUC-UPS state flags
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsShutdownFlags();//get NUC-UPS shutdown flags
:extern "C" NUCUPSLIB_API float getNUCUpsVIn();//get NUC-UPS Input Voltage
:extern "C" NUCUPSLIB_API float getNUCUpsIOut();//get NUC-UPS Output Current
:extern "C" NUCUPSLIB_API float getNUCUpsVOut();//get NUC-UPS Output voltage
:extern "C" NUCUPSLIB_API float getNUCUpsVBats(int i);//get NUC-UPS battery voltages
:extern "C" NUCUPSLIB_API float getNUCUpsTemperature(int i);//get NUC-UPS battery temperature
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsCellBalanceOn(int i);//get NUC-UPS balanced battery (discharged)
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsCellDetected(int i);//get NUC-UPS battery detected
:extern "C" NUCUPSLIB_API float getNUCUpsVIgnition();//get NUC-UPS Ignition Voltage
:extern "C" NUCUPSLIB_API float getNUCUpsPOut();//get NUC-UPS Output Power
:extern "C" NUCUPSLIB_API float getNUCUpsVBat();//get NUC-UPS Bat voltage
:extern "C" NUCUPSLIB_API float getNUCUpsVPack();//get NUC-UPS Pack voltage
:extern "C" NUCUPSLIB_API float getNUCUpsIChgDchg();//get NUC-UPS Charge/Discharge current
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsSpecConsts(unsigned int type, unsigned int index);//get NUC-UPS

special constants
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsVerMajor();//get NUC-UPS major version of the firmware
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsVerMinor();//get NUC-UPS minor version of the firmware
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsState();//0 - not connected, 1 - running from battery, 2 - from

vin, 3 - from USB
:extern "C" NUCUPSLIB_API void setNUCUpsDBGMode(unsigned char dbg);//set dbg mode
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsDbgByte(int i);//get NUC-UPS debug bytes - valid only after

setNUCUpsDBGMode(1)
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsDbg2Byte(int i);//get NUC-UPS debug bytes - valid only after

setNUCUpsDBGMode(1)
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsDbg3Byte(int i);//get NUC-UPS debug bytes - valid only after

setNUCUpsDBGMode(1)
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsTimer(unsigned int cnt);//get NUC-UPS timer
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsStateMachines(unsigned int cnt);//get NUC-UPS internal state

machines 0=UPS 1=AFE 2=Charger 3=Detect 4=Batterymanager
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsChgTimer(unsigned int cnt);//get NUC-UPS charger timers
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsChargeEndedCondition();//get NUC-UPS charge ended
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsBatteryLevel();//get NUC-UPS battery level (percents 0-100)
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsCPUUsage();//get NUC-UPS CPU usage
:extern "C" NUCUPSLIB_API void restartNUCUps();//restart NUC-UPS
:extern "C" NUCUPSLIB_API void restartNUCUpsInBootloaderMode();//restart NUC-UPS in bootloader mode
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsMaxVariableCnt();//get NUC-UPS maximum variable count
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsVariableData(unsigned int cnt, char* name, char* value, char* unit,

char* comment);//get NUC-UPS variable data
:extern "C" NUCUPSLIB_API void startNUCUpsLoadingSettings(unsigned char to_file, unsigned char

compare_with_old);//start loading data from device
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsLoadingSettingsState();//get load settings current state: 0-64 -

steps, 100=success, 0xF1-0xFF=failure
:extern "C" NUCUPSLIB_API unsigned char setNUCUpsVariableData(unsigned int cnt, char* value);//set NUC-UPS variable

data for a given variable
:extern "C" NUCUPSLIB_API void startNUCUpsSaveSettings(unsigned char from_file);//start saving data to device
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsSaveSettingsState();//get saving current state: 0-64 - steps,

100=success, 0xF1-0xFF=failure
See the examples for usage.
</code>

IMPORTANT: the API dll needs 4 files from Visual Studio 2005 redistribution pack (Microsoft.VC80.CRT.manifest,

msvcm80.dll, msvcp80.dll, msvcr80.dll).

IMPORTANT: the API supports only one NUC-UPS connected to the computer.

====Visual C++ Example====
Open TestAPI.sln from the package, set CLibTest project as active project, run it and see CLibTest.cpp for usage

example.
====Visual Basic Example====
Open TestAPI.sln from the package, set VBLibTest project as active project, run it and see Module1.vb for usage

example.
====Visual C# Example====
Open TestAPI.sln from the package, set CSLibTest project as active project, run it and see Program.cs for usage

example.

===Download API and example projects===

{| class="wikitable" style="text-align: center;"

|'''Version'''||'''Change list'''
|-
||[http://wiki.mini-box.com/images/3/35/NUCUPSApiTestV1.0.zip '''1.0''']||First version
|-
||[http://wiki.mini-box.com/images/a/af/NUCUPSApiTestV1.1.zip '''1.1''']||Update for Firmware 1.1
|}

NUC-UPS

2020-10-21T12:14:08Z

Admin: /* NUC-UPS operating modes */

'''6-38V Intelligent Automotive grade Uninterruptible Power Supply'''<br><br>
'''Before you start…<br>
Often times, rushing into installing the unit can result in serious damage to your DCDC-NUC UPS board or computer.
Always double check the polarity of your wires with a voltmeter.<br><br>
'''Always double check the polarity of the batteries before introducing into the UPS device.'''<br>
'''Improper configuration leads to system damage!!!'''<br><br>
<nowiki>*</nowiki> NOTE: Forced ventilation or 40% input or output current de-rating or both is required if any of the following conditions are met:<br>
If V(IN) 24-38V <br>
If I(Out) > 2A and T(ambient) > 30°C, open air operation.<br>
In order to prevent premature battery damage due to thermal exposure, always check NUC-UPS board temp and ensure it does not exceed 55C for your application.

==Introduction==
The NUC-UPS was designed to provide +12V regulated power output from a wide input voltage(6V-38V).<br>
It has a range of intelligent functions not found in any of the traditional USB converters.<br>
The unit is able to gracefully shut down motherboards based on Ignition sensing or battery voltage level, by pulsing

the motherboard on/off pins. This makes it an ideal device for automotive or battery powered installations.<br>
It features 4 replaceable Li-Ion batteries for battery backup integrated in the device, there is no need for any

kind of special cabling between cells and UPS.
The charger is a Synchronous Buck-Boost converter capable of charging the batteries with input voltage below, equal

or above battery voltage level.
It charges the battery in three phases: preconditioning, constant current mode and constant voltage mode. <br>
The output converter is a synchronous Buck converter providing regulated 12V output.
The unit can be used as an embedded UPS or as a Portable Energy Pack providing the user with regulated 12V wherever

needed.

==Features==
* USB interface, works with Windows devices (Linux API planned)<br>
* Input between 6-38V<br>
* Programmable thresholds, timings and configuration modes<br>
* Generates regulated 12V output voltage<br>
* Output current 5A continuous
* Supports Li-Ion (3.7V) battery chemistry<br>
* 3 state charger(precharge, constant current, constant voltage)<br>
* Battery balancing, 4S configuration.<br>
* Charge voltage 4x4.2V, charge current 1A, precharge current ~0.3A<br>
* Coulomb counting<br>
* Battery temperature monitoring for each cell and temperature compensated charge<br>
* Start/Stop button and header<br>
* Motherboard ON/OFF pulse control*<br>
* Motherboard detection by power consumption or 5VUSB presence
* Missing battery cells detection<br>
* Ultra low power consumption(5uA- in Deep Sleep mode) or (250uA- in Dumb mode Standby) or (5mA- Automotive mode

Standby)<br>
* Windows detects device as “Battery”, with no special drivers required **<br><br>

==Diagram & Schematics==
==Connectors==
<div style="display: inline; float: left;">[[File:Nucupslegend.jpg|230px|thumb|left|Connectors nomenclature]]</div>
<div style="clear: both;"></div>
===Power Input connectors===
;P1 Input (mini-FIT JR, 1x4 pins)
: P1.1,P1.2-GND
: P1.3-Ignition sensing
: P1.4-Input voltage
;P2 Input (DC Power Jack:2DC-G213-B49, Mating plug 5.50x2.50)

;P3 Output (mini-FIT JR, 1x4 pins)
: P3.1,P3.2-GND
: P3.3,P3.4-Output voltage
;P4 Output (B4B-EH-A(LF)(SN), 1x4 pins)
: P4.1,P4.2-GND
: P4.3,P4.4-Output voltage

===Interface connectors===
;P5 Motherboard POWER SW connection, no polarity (JST_B3B-PH-KL, 1x3pins)
: P5.1: SW1
: P5.2: GND
: P5.3: SW2
;P7 USB header (B4B-PH-K-S(LF)(SN), 1x4pins)
: P7.1: GND
: P7.2: USB D-
: P7.3: USB D+
: P7.4: +5V
;S1&P9 Start/Stop button header (M20-9990246, 1x2pins)
;P8 Programming header
P8.1: MCLR
P8.2: GND
P8.3: 5V
P8.4: PGD
P8.5: PGC

==NUC and OS Settings==
<br>
*'''NUC related settings'''<br><br>
<div>
<div style="display: inline; float: left;">[[File:BIOS.png|230px|thumb|left|NUC Visual BIOS 2.0 Setting]]</div>
:Setting up the NUC's behavior when power is re-applied:<br>
:- press '''F2''' key during the boot sequence to entering the NUC's BIOS (Visual BIOS 2.0)<br>
:- first click on '''Advanced''' then click on '''Power''' menu button<br>
:- in '''Secondary Power Settings''' section select '''Power On''' option for '''After Power Failure'''<br>
:- the picture shows the right option in a red framework<br>
:- now the power supply should be able to '''START''' the NUC by applying corresponding voltage to its power

input<br>
</div>
<div style="clear: both;"></div>

==Firmware update==
It is recommended that you only connect USB power to the device
when making a firmware update via “bootloader mode”.

There are two ways to enter in bootloader mode: 1a) or 1b).<br>
1a) Place a jumper on the P8.4 and P8.5 pins then connect the unit to USB<br>
1b) Connect the unit to USB then press the Switch to bootloader button on the configuration software's user

interface.<br>
2) Start the [http://wiki.mini-box.com/images/a/ae/Bootloader_Software.zip '''HIDBootloader v2.9j.exe'''] software

provided to flash the new firmware.<br>
3) Press File->Import Firmware Image<br>
4) Press Open new Hex [http://wiki.mini-box.com/images/4/4b/DCDC-NUC_UPS-_FW_ver_1.3_for_loading_with_bootloader_2017.oct.09.zip '''File''']<br>
5) Press Program->Erase/Program/Verify Device<br>
6) If used option 1a) remove the jumper
6) Press Program->Reset Device<br>
7) After the device reconnects on USB with the configuration software the new firmware version will be displayed in

the title bar of the software.<br>

==NUC-UPS operating modes==
For configuration purposes only the unit can be started by connecting the unit to USB.<br>
Inserting the batteries should be the first step to perform.<br>
Waking the unit for the first time implies applying input voltage.<br>
The operating modes can be selected by setting the NUC_UPS_MODE parameter to 0(DUMB mode) or 1(AUTOMOTIVE mode).<br>
Further parameters can be customized by changing in the [[NUC-UPS#Parameter_List|'''Parameter List''']].<br>
===Dumb Mode===
:When in this mode the unit still works as an UPS or it can be used as a general purpose battery pack.<br>
;Starting the unit
:In this mode starting can be performed either by applying input voltage or pressing the button for 500ms.<br>
;Stopping the unit
:In this mode stop sequence can be initiated by pressing the button for 500ms.<br>

===Automotive Mode===
;Starting the unit
:In this mode Starting can be performed by applying input voltage and applying ignition voltage.<br>
:The ignition voltage thresholds are configurable set by the IGN_HIGH_THRESHOLD, IGN_LOW_THRESHOLD parameters.The

Ignition voltage must be higher than IGN_HIGH_THRESHOLD for the duration set by the IGN_COUNT parameter in order to

filter out unwanted noise in automotive environment.<br>
;Stopping the unit
:In this mode stop sequence can be initiated if Ignition voltage is lower than IGN_LOW_THRESHOLD parameter for the

duration set by the IGN_COUNT parameter.<br>

===Stop conditions that apply in both modes===
:When the unit is running on batteries the following conditions can initiate shutdown(the shutdown reason can be

identified on the Status-UPS tab,Shutdown groupbox in the Configuration software):<br>
:-one of the cell voltages is less than UPS_VCELL_MIN_STOP parameter, shutdown sequence is initiated.<br>
:-the unit is on battery for more than UPS_ON_BATTERY_TOUT parameter, shutdown sequence is initiated.<br>
:-one of the cell voltages is less than UPS_VCELL_MIN_HARD_STOP parameter, shutdown is immediate.<br>
:-one of the batteries temperature is out of the limits set by the DCHG_TEMP_COLD, DCHG_TEMP_HOT parameters.<br>
:-overload, when the maximum allowed discharge current exceeds the value set by UPS_OVERLOAD parameter.<br>
:If output is out of regulation the unit is immediately stopped.

===Startup and Shutdown sequence===
====Startup sequences====
[[File:Dumb_mode_waking_with_VIN.PNG|600px]]
[[File:Dumb_mode_waking_with_button.PNG|600px]]
[[File:Automotive_mode_waking_with_Ignition.PNG|600px]]<br>
====Shutdown sequences====
[[File:Gracious_shutdown.PNG|600px]]
[[File:Immediate_shutdown.PNG|600px]]

===Motherboard control===
The following options are available to control the motherboard by pulsing the on/off pins on the motherboard.
First the the motherboard On/OFF pins should be connected to the P5.1,P5.3 pin on the P5 [http://wiki.mini-box.com/index.php?title=NUC-UPS#Interface_connectors '''Interface_connector'''].<br>
The pulse width is 500ms by default which can be altered by changing MOB_PULSEWIDTH parameter from the [http://wiki.mini-box.com/index.php?title=NUC-UPS#Parameter_List '''Parameter_List'''].<br>
There are various ways to control the motherboard depending the configuration of the CONFIG1 register from the [http://wiki.mini-box.com/index.php?title=NUC-UPS#Parameter_List '''Parameter_List'''].<br>
Example:If startup of the motherboard is not needed when input is present, the startup pulse can be disabled by setting CONFIG1.b0 to 0.<br>
The same way the shutdown pulse can be inhibited by setting CONFIG1.b1 to 0.<br>
There are cases when motherboard started(ON) or OFF presence must be detected in order starting/stopping by pulses behavior work properly.<br>
For example the Operating System could be shutdown already from software. In case the unit is is a shutdown sequence not knowing this piece of information would lead by sending the shutdown pulse which would wake up instead the system.<br>
There are two kinds of feedback information to detect motherboard status.<br><br>
The first detection mode is by measuring the consumed output power, knowing that a motherboard when started consumes much more power than when in standby.<br>
In order to enable this feature the following steps should be performed:<br>
1. Enable this feature, CONFIG1.b2 should be set to 1.<br>
2. Observe and note the consumption of the connected motherboard when in standby and when is ON.
Our unit measures the output power(POUT) which is displayed in the configuration software.<br>
3. Set POUT_HIGH_THRESHOLD and POUT_LOW_THRESHOLD parameters from the [http://wiki.mini-box.com/index.php?title=NUC-UPS#Parameter_List '''Parameter_List'''] accordingly with a good margin. <br>
POUT<POUT_LOW_THRESHOLD motherboard is considered OFF.<br>
POUT>POUT_HIGH_THRESHOLD motherboard is considered ON.<br><br>
The second detection mode is by measuring the +5VUSB signal. Usually motherboards turn OFF the +5VUSB signal when they are OFF.<br>
In order to enable this feature CONFIG1.b3 must be set to 1.

==NUC-UPS charger==
The charger is a Synchronous Buck-Boost converter capable of charging the batteries with an input voltage below, equal or above battery voltage level.<br>
The charging happens three phases: preconditioning, constant current mode and constant voltage mode:
:• The charging is starting with a preconditioning phase, where the current is limited to ~350mA. The preconditioning phase has a minimum duration set by CHG_COND_TOUT which is extended if one of the cells voltage is below the limit set by CHG_CELL_VCOND.<br>
:• In constant current phase charge current is limited to 1A. After battery voltage rises to the value set by the hardware charger, the charger will enter constant voltage mode.<br>
:• In constant voltage phase the battery will absorb less current as time passes and charge current will decrease. When the charge current decreases below ~150mA, charging is stopped.<br>

During low power state the charger is disabled, so the charger module is also disabled in automotive mode when the Ignition is OFF, even if input is present.<br>

Charging will be terminated if a global charge timer elapses, this can be set by CHG_GLOBAL_TOUT parameter.<br>
Charging is limited to precharge value if one of the batteries temperature exceeds limits set by CHG_TEMP_COOL,CHG_TEMP_WARM parameters.<br>
Charging is terminated if one of the batteries temperature exceeds the limits set by CHG_TEMP_COLD,CHG_TEMP_HOT. <br>
In order to work properly the following conditions when changing parameters must be fulfilled: CHG_TEMP_COLD < CHG_TEMP_COOL < CHG_TEMP_WARM < CHG_TEMP_HOT.

The temperature sensors are located just below the batteries for proper temperature detection of each cell.<br>
:[[File:Charge-regulation.png|325px|thumb|left|]]
<div style="clear: both;"></div>

==NUC-UPS Charge Balancer==
The balancing algorithm is voltage based. Balancing is allowed if cell voltage exceeds the value set in the BAL_VCELL_MIN parameter.<br>
Balancing is started if the voltage difference between the cells is higher than BAL_VCELL_DIFF_START, and will be stopped if the difference is lower than the value defined in BAL_VCELL_DIFF_STOP parameter.<br>

==NUC-UPS Fuel gauge==
The initial remaining capacity is detected based on an open-circuit voltage based state-of-charge estimation, using the predefined values set by the OCV_SOCxx parameters.
Further estimation is based on coulomb counting method which is more precise after a full charge cycle has been performed.<br>

==Led Blinking==
The unit has two LEDs on board (Red and Green), located on the right and left side of the USB connector.<br>
While there are scenarios where both LEDs are blinking with a certain pattern, the LEDs generally help identifying the power source that runs the UPS output at any given moment.
:• The green LED signals that the NUC-UPS is running from input voltage
:• The red LED signals that the NUC-UPS is running from batteries

The blinking patterns that can occur during operation are shown in the images below. The duration of LED blinks can also be seen on the images, displayed in milliseconds.<br>

[[File:LED_LPWR_Mode_On_USB_Or_In_Automotive_Standby.PNG|600px]]
[[File:LED_Initial_Delay.PNG.PNG|600px]]<br>
[[File:LED_Batteries_Charging.PNG|600px]]
[[File:LED_Running_From_Vin.PNG|600px]]<br>
[[File:LED_Running_From_Battery.PNG|600px]]
[[File:LED_Wait_Hardoff_Running_From_Vin.PNG|600px]]<br>
[[File:LED_Wait_Hardoff_Running_From_Battery.PNG|600px]]
[[File:LED_Missing.PNG|600px]]<br>

==Parameter List==

{| class="wikitable"
! NAME
! Description
|-
| NUC_UPS_MODE[-]
| <pre>
0-Dumb mode (DUMB)
1-Automotive mode (AUTOMOTIVE)
</pre>
NUC_UPS_MODE

|-
| UPS_ON_BATTERY_TOUT
|
Deep sleep timeout. If system is running on battery and this period has elapsed with no input power applied, the UPS

will initiate shut down procedure. "Never" is allowed as value (to disable this feature). Default is "Never".

|-
| INIT_TOUT
|
When all power supply start-up conditions are met, the PSU will wait this time before continuing with the start-up

sequence.

|-
| VIN_MIN_STARTUP
|
If the input voltage is beyond this threshold and all other start-up conditions are met, the PSU can start. Default

is 11000mV.

|-
| VIN_MIN_RUNNING
|
If input voltage is below this threshold, the output is powered from battery. Default is 8000mV.

|-
| VIN_COUNT
|
Input voltage filtering. Default is 100ms.

|-
| IGN_COUNT
|
Ignition voltage filtering. Default is 100ms.

|-
| IGN_HIGH_THRESHOLD
|
If ignition voltage is beyond this threshold, ignition is considered to be ON. Default is 6000mV.

|-
| IGN_LOW_THRESHOLD
|
If ignition voltage is below this threshold, ignition is considered to be OFF. Default is 5000mV.

|-
| IGN_ON_TO_OUTPUT_ON_TOUT
|
After ignition is considered ON, the PSU will wait this time before the output is turned ON. Default is 2000ms.

|-
| IGN_CANCEL_TOUT
|
After the motherboard boots up, the ignition voltage sensing will be disabled for this period. Default is 60s.

|-
| OUTPUT_ON_TO_MOB_PULSE_ON_TOUT
|
After the output was turned on, the UPS will wait this period before sending the ON pulse to the motherboard.

Default is 20ms

|-
| IGN_OFF_TO_MOB_PULSE_OFF_TOUT
|
In automotive mode, after the ignition is considered OFF, this UPS will wait this period before sending the OFF

pulse to the motherboard. Default is 5s

|-
| MOB_PULSEWIDTH
|
The length of the start-up/shutdown pulse sent to the motherboard. Default is 500ms.

|-
| HARD_OFF_TOUT
|
After the shutdown pulse is sent to the motherboard, the UPS will wait this period before the output is turned OFF.
This time-out allows the operating system to perform a clean shutdown. Default is 60s.

|-
| PWM_SPREAD_MODULATING_FREQ
|
Modulation frequency parameter of the Random Spread Frequency Modulation module (used for EMI reduction purposes)

|-
| PWM_SPREAD_PERCENT
|
Frequency deviation parameter of the Random Spread Frequency Modulation module (used for EMI reduction purposes)

|-
| PWM_FREQ
|
Operating frequency of the Switched Mode Power Supply

|-
| CONFIG1
|
Configuration register [b7..b0]. Used for enabling/disabling modules. 0 - disabled, 1 - enabled <br>
b7 - Unused <br>
b6 - Unused <br>
b5 - Unused <br>
b4 - Unused <br>
b3 - If set, the USB sense is enabled, +5V USB is used to detect the Motherboard alive status<br>
b2 - If set, the Power measurement (Vout x Iout) is used to detect the Motherboard alive status<br>
b1 - If set, shutdown pulse is enabled through the PWRSW connector.<br>
b0 - If set, startup pulse is enabled through the PWRSW connector.<br>

Depending motherboard alive status the shutdown/startup pulse is sent if b2/b3 is enabled.
The motherboard presence can be smartly detected if b2/b3 is enabled.
For example: In case motherboard is already shut down the pulse is not sent in case of a shutdown scenario.
This is also true in case of a startup scenario.

|-
| CONFIG2
|
Configuration register. Used for enabling/disabling modules. 0 - disabled, 1 - enabled <br>
b7..b0 - Reserved/Unused <br>

|-
| WRITE_COUNT
|
The number of times the internal Flash program memory has been written.

|-
| IOUT_OFFSET
|
This value will be summed with the measured input current, this is a calibration parameter. Default is 0mA

|-
| CAPACITY
|
Battery Capacity.
Default is 1000mAh.

|-
| UPS_BUTTON_ON_TOUT
|
Filtering time for button pressing. Default is 100ms.

|-
| UPS_VCELL_MIN_START
|
If Vin is not present and all the battery cells are above this threshold, the UPS can start and will run on battery.
Default is 3.6V.

|-
| UPS_VCELL_MIN_STOP
|
If VIN is not present and one of the battery cells is less than this threshold , the UPS will initiate a shutdown

procedure.
Default is 3.3V.

|-
| UPS_VCELL_MIN_HARD_STOP
|
If VIN is not present and one of the battery cells is less than this threshold, the UPS will instantly shut down to

preserve battery.
Default is 3V.

|-
| UPS_OVERLOAD
|
Max allowed discharge current. In case the discharge current exceeds this threshold, shutdown will be initiated.
Default is 6000mA

|-
| DCHG_TEMP_COLD
|
COLD temperature threshold for discharge. In case exceeded UPS will shutdown when on battery. Default is -20°C (FW

ver 1.1)

|-
| DCHG_TEMP_HOT
|
HOT temperature threshold for discharge. In case exceeded UPS will shutdown when on battery. Default is 60°C (FW ver

1.1)

|-
| CHG_COND_TOUT
|
Conditioning/Precharge time. Charge current is limited until cell voltage exceeds CHG_VCOND value and it is applied

during this time.
Default is 30 sec.

|-
| CHG_BULK_STOP_VOLTAGE
|
Maximum allowed bulk charge voltage/cell during constant current/constant voltage charging.
Default is 4.1 [V/cell].

|-
| CHG_HYSTERESIS
|
An overvoltage value ( CHG_BULK_STOP_VOLTAGE + CHG_HYSTERESIS ) that is allowed when charging. If one of the cells

exceeds this value, charging is immediately stopped.
Default is 100mV/cell.

|-
| CHG_START_VOLTAGE
|
If cell voltage is below this value, charging can be started.
Default is 3.85V/cell.

|-
| CHG_GLOBAL_TOUT
|
Global charge timeout.
Default is 240 min.

|-
| CHG_TOPPING_TOUT
|
After an overvoltage condition is detected for a cell (for Lithium based batteries), a resting period is set by this

timer before applying a small topping charge - in case other cells are still not charged.
Default is 60s.

|-
| CHG_TEMP_COLD
|
COLD temperature threshold for temperature compensated charge current regulation.
Default 5°C(FW ver 1.0)

|-
| CHG_TEMP_COOL
|
COOL temperature threshold for temperature compensated charge current regulation.
Default 10°C(FW ver 1.0)

|-
| CHG_TEMP_WARM
|
WARM temperature threshold for temperature compensated charge current regulation.
Default 50°C(FW ver 1.0)

|-
| CHG_TEMP_HOT
|
HOT temperature threshold for temperature compensated charge current regulation.
Default 55°C(FW ver 1.0)

|-
| UPS_VCELL_ADC_OFFSET
|
This value will be summed with the measured cell voltages, this is a calibration parameter. Default is 0mV.

|-
| CHG_CELL_VCOND
|
Conditioning/Pre-charge voltage. Charge current is limited until cell voltage exceeds this value and for at least

CHG_TCOND time . Default is 3.3V

|-
| BAL_VCELL_MIN
|
Balancing is allowed if cell voltages are above this value.
Default is 3.4V

|-
| BAL_VCELL_DIFF_START
|
If the voltage difference between cells exceeds this value, cell balancing will start.
Default is 80mV.

|-
| BAL_VCELL_DIFF_STOP
|
If the voltage difference between cells is less than this value, cell balancing will stop.
Default is 40mV.

|-
| OCV_SOC0
|
Open Circuit Voltage State Of Charge detection for initial 0% fuel gauge estimation.
Default is 3.3V.

|-
| OCV_SOC10
|
Open Circuit Voltage State Of Charge detection for initial 10% fuel gauge estimation.
Default is 3.68V.

|-
| OCV_SOC25
|
Open Circuit Voltage State Of Charge detection for initial 25% fuel gauge estimation.
Default is 3.76V.

|-
| OCV_SOC50
|
Open Circuit Voltage State Of Charge detection for initial 50% fuel gauge estimation.
Default is 3.82V.

|-
| OCV_SOC75
|
Open Circuit Voltage State Of Charge detection for initial 75% fuel gauge estimation.
Default is 3.97V.

|-
| OCV_SOC100
|
Open Circuit Voltage State Of Charge detection for initial 100% fuel gauge estimation.
Default is 4.17V.

|-
| POUT_HIGH_THRESHOLD
|
If output power measured is higher than this threshold the connected motherboard is considered to be ON.
Together with POUT_LOW_THRESHOLD parameter sets a hysteresis for motherboard status. CONFIG1.b2 must be set in order to be active. Default is 3000mW.

|-
| POUT_LOW_THRESHOLD
|
If output power measured is lower than this threshold the connected motherboard is considered to be OFF.
Together with POUT_HIGH_THRESHOLD parameter sets a hysteresis for motherboard status. CONFIG1.b2 must be set in order to be active. Default is 1000mW.
|}

==Software manual==
===Windows OS built-in support===
The NUC-UPS implements two generic USB classes, therefore most of the operating systems are recognizing it without

any additional driver installation. This two classes are:
a.) "HID UPS Battery" for OS built-in communication.
Microsoft Windows versions are recognizing this class automatically and the device should appear in device manager

at Batteries as a "Hid ups battery", together with all settings and power plan possibilities provided by the OS for

any battery.
b.) "HID" for communication and configuration
This endpoint is a generic HID and it is used by our configuration and monitor software to read/write voltages and

other important parameters of the NUC-UPS. This endpoint does not needs any additional driver either, Microsoft

Windows OS should recognize it as a generic HID USB device.

===Configuration software===
The configuration software provides interface for NUC-UPS monitoring, logging and setup.
It's recommended to be used by users with deeper understanding of the NUC-UPS hardware since permits setting

voltages, currents and other parameters which can be
dangerous if they are set without precaution.<br />
The configuration software has three main screens (Status-UPS, Status-Charger and Settings) and a header with the

important voltage/current values.<br />

====The first main screen is the "Status-UPS"====
Example of this screen is shown in the next image:<br />
<div style="display: inline; float: left;">
[[File:NUC-UPS-Status.JPG‎|x350px|thumb|left|Status screen]]
</div>

The title bar shows the connection status, the firmware version and the mode of the NUC-UPS. Example: "NUC-UPS

Connected v1.0 Mode: Dumb"

The header of the status screen contains:
:VIn: Input Voltage
:VIgn: Ignition Voltage
:VBat: Battery Voltage
:VOut: Output Voltage
:POut: Output Power
:IOut: Output Current
:Battery pack %: Battery percentage
:[0]: Battery 0 status
:[1]: Battery 1 status
:[2]: Battery 2 status
:[3]: Battery 3 status
:[Pack]: Battery pack overall voltage and current

The "Status-UPS" screen contains extended information about the current state of the NUC-UPS like internal state

machine, voltages, currents, temperature, different read only state flags.
The user also have the possibility to log the current state into a *.csv file in the "Log" section.
<div style="clear: both;"></div>

====The second main screen is the "Status-Charger"====
<div style="display: inline; float: left;">
[[File:NUC-UPS-Charger.JPG‎|x350px|thumb|left|Status screen]]
</div>
Contains extended information about current state of the NUC-UPS battery charger (internal state machines, flags)
<div style="clear: both;"></div>

====The third main screen is the "Settings"====
Example of this screen is shown in the next image:<br />
<div style="display: inline; float: left;">
[[File:NUC-UPS-Settings.JPG‎|x350px|thumb|left|Settings screen]]
</div>

This screen contains two main sections: the individual parameter setup for experienced users and the parameter

save/load into/from file section.

The main section of the "Settings" screen is the individual parameter settings.<br>
This is recommended to be done only by experienced users. Any parameter of the NUC-UPS can be set from here.

Changing one parameter is simple:
:- select the desired parameter from the "Parameter" list (simple click to select, double-click to edit). Below the

parameter list a helper text is displayed (same from this manual).
:- after double click introduce the new value in the new popup dialog and press OK
:- the introduced value is checked - if something is wrong (out of limit, bad value etc.) error message will be

shown
:- the ! sign will blink on the "Sync all parameters to the NUC-UPS" button to show edited but not saved/synced

variables
:- after You have done with all parameter setting press the "Sync all parameters to the NUC-UPS" button to send all

values to the NUC-UPS. IMPORTANT: without this step the new values will be lost, nothing is sent to the NUC-UPS!

IMPORTANT: any parameter setting is taken into account by the NUC-UPS in this cases:
: - after a full restart either with power cut from all sources (usb, vin)
: - hitting the "Restart NUC-UPS" button
: - keeping the "Reload parameters on the fly after sync" checked.
Do any parameter change with precaution, check the parameters and wires before applying it!

For users who need to setup more devices with the same NUC-UPS settings, it is recommended to use the save/load

parameters buttons.
The "Parameters: NUC-UPS ===> File (settings.ini)" button loads a full configuration from the NUC-UPS and saves it

to the settings.ini file. You can disconnect
the current NUC-UPS from the USB and insert a new one, than press the "Parameters: NUC-UPS <=== File (settings.ini)"

button to send the last saved configuration into the new NUC-UPS.

The "Parameters: NUC-UPS ===> CSV File (settings.csv)" button loads all parameters from the connected NUC-UPS and

saves it into a csv file. This type of file can be opened by any spreadsheet editor (OpenOffice, Microsoft Excel

etc.) and contains the full set of parameters in human readable form.

The "Switch to bootloader" button is intended to be used for firmware updates. After You press this button the NUC-

UPS will disconnect, it will switch to bootloader mode and firmware can be updated as described [[NUC-

UPS#Bootloader_Mode|here]]

Every save/load/sync operation on the "Settings" screen affects the progress bar and the status bar on the bottom of

the screen (labelled with "State:"). In rare cases You
might get error here with "try again" message. This happens in case of one parameter byte get's corrupted or timeout

occurs during USB communication and/or NUC-UPS flashing
operation. Please try again and contact our support team only if the device gives this error 4-5 times in a row.

===Windows System monitor===
The system monitor is a tray bar software which shows the current state on the tray bar icon and a semi transparent

"always on top" capable small window.<br>
The popup window can be moved anywhere on the screen and can be customized. Our current setup has two skins but any

combination is possible playing with the
"skin*.mbs" files installed together with this application. The current skin can be selected right clicking on the

try icon.
The "skin*.mbs" files are simple text ones editable with any text editor (notepad for example).<br>
Adding a new skin is pretty simple – make a skin1.mbs (use the existing skin0.mbs for starting content) and start

playing with the values from the new
file.<br>
The values are self explanatory – skin name, background image files, font descriptions and label/value pair

coordinates for all the important NUC-UPS values.
The size of the popup is defined by the background image – transparent parts can be defined as well (see for

example: "bubble1.bmp").
Example screenshots:<br />
<div style="display: inline; float: left;">
[[File:NUCUPS_sm_tray2.jpg‎|x150px|thumb|left|System monitor skin1 connected]]
</div>
<div style="display: inline; float: left;">
[[File:NUCUPS_sm_tray3.jpg‎|x150px|thumb|left|System monitor skin1 disconnected]]
</div>
<div style="clear: both;"></div>

Right clicking on the tray icon will pop-up a simple menu:
<div style="display: inline; float: left;">
[[File:NUCUPS_sm_menu.jpg‎|x150px|thumb|left|System monitor settings]]
</div>
<div style="clear: both;"></div>
From which You can see firmware version and state of the NUC-UPS from the NUC-UPS Properties and set some visual

parameters of the application (transparency, skin) from Skin:
<div style="display: inline; float: left;">
[[File:NUCUPS_sm_traysettings.jpg‎|x150px|thumb|left|System monitor settings]]
</div>
<div style="clear: both;"></div>

For auto start with the system make a shortcut of AppTray.exe from the standalone package in the system Startup

([http://windows.microsoft.com/en-us/windows/run-program-automatically-windows-starts#1TC=windows-7 '''Windows

7'''], [http://support.microsoft.com/kb/2806079 '''Windows 8''']).

===Download software===

{| class="wikitable" style="text-align: center;"

|'''Version'''||'''Change list'''
|-
||[http://wiki.mini-box.com/images/3/33/NUCUPSv1.0.zip '''1.0''']||First version
|-
||[http://wiki.mini-box.com/images/5/55/NUCUPSv1.1.zip '''1.1''']||Update for Firmware 1.1
|}

===Developer manual===
Mini-box.com provides one NUC-UPS API in a DLL (NUCUpsLib.dll) and examples in Visual C++, Visual Basic and Visual

C#.<br>
Basic C++/Visual Basic/C# knowledge is needed to use this examples together with the API.
The API dll has manifest embedded to permit C# and Visual Basic dynamic load.

The API has a set of functions exported to access the full functionality of the NUC-UPS.
This functions are:
<code>
:extern "C" NUCUPSLIB_API const char* STATE_MACHINE_UPS[14];//state machine UPS
:extern "C" NUCUPSLIB_API const char* STATE_MACHINE_AFE[8];//state machine AFE
:extern "C" NUCUPSLIB_API const char* STATE_MACHINE_CHG[16];//state machine Charger
:extern "C" NUCUPSLIB_API const char* STATE_MACHINE_DTCT[16];//state machine Detect
:extern "C" NUCUPSLIB_API const char* STATE_MACHINE_LOWP[4];//state machine low power states
:extern "C" NUCUPSLIB_API unsigned char nucupsOpenDeviceHandler(unsigned int timer);//open device handler. timer

sets the refresh period in miliseconds (4 or 5 messages will be sent in this period e ending from debug mode)

IMPORTANT: the handler can be kept open to notice any NUC-UPS plugged in
:extern "C" NUCUPSLIB_API void nucupsCloseDeviceHandler();//close device handler
:extern "C" NUCUPSLIB_API void getNUCUpsDevicePath(char* path);//Get opened device path @param path - recommended

length 1024, will return empty string if no device opened
:extern "C" NUCUPSLIB_API unsigned char isNUCUpsConnected();//0=not connected, 1=normal state,2=loading settings

from device,3=saving settings from pc,4=saving settings from file
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsMode();//get NUC-UPS mode: 0=Dumb, 1=Automotive
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsInputFlags();//get NUC-UPS input flags
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsOutputFlags();//get NUC-UPS output flags
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsChargerFlags();//get NUC-UPS charger flags
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsStateFlags();//get NUC-UPS state flags
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsShutdownFlags();//get NUC-UPS shutdown flags
:extern "C" NUCUPSLIB_API float getNUCUpsVIn();//get NUC-UPS Input Voltage
:extern "C" NUCUPSLIB_API float getNUCUpsIOut();//get NUC-UPS Output Current
:extern "C" NUCUPSLIB_API float getNUCUpsVOut();//get NUC-UPS Output voltage
:extern "C" NUCUPSLIB_API float getNUCUpsVBats(int i);//get NUC-UPS battery voltages
:extern "C" NUCUPSLIB_API float getNUCUpsTemperature(int i);//get NUC-UPS battery temperature
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsCellBalanceOn(int i);//get NUC-UPS balanced battery (discharged)
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsCellDetected(int i);//get NUC-UPS battery detected
:extern "C" NUCUPSLIB_API float getNUCUpsVIgnition();//get NUC-UPS Ignition Voltage
:extern "C" NUCUPSLIB_API float getNUCUpsPOut();//get NUC-UPS Output Power
:extern "C" NUCUPSLIB_API float getNUCUpsVBat();//get NUC-UPS Bat voltage
:extern "C" NUCUPSLIB_API float getNUCUpsVPack();//get NUC-UPS Pack voltage
:extern "C" NUCUPSLIB_API float getNUCUpsIChgDchg();//get NUC-UPS Charge/Discharge current
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsSpecConsts(unsigned int type, unsigned int index);//get NUC-UPS

special constants
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsVerMajor();//get NUC-UPS major version of the firmware
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsVerMinor();//get NUC-UPS minor version of the firmware
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsState();//0 - not connected, 1 - running from battery, 2 - from

vin, 3 - from USB
:extern "C" NUCUPSLIB_API void setNUCUpsDBGMode(unsigned char dbg);//set dbg mode
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsDbgByte(int i);//get NUC-UPS debug bytes - valid only after

setNUCUpsDBGMode(1)
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsDbg2Byte(int i);//get NUC-UPS debug bytes - valid only after

setNUCUpsDBGMode(1)
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsDbg3Byte(int i);//get NUC-UPS debug bytes - valid only after

setNUCUpsDBGMode(1)
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsTimer(unsigned int cnt);//get NUC-UPS timer
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsStateMachines(unsigned int cnt);//get NUC-UPS internal state

machines 0=UPS 1=AFE 2=Charger 3=Detect 4=Batterymanager
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsChgTimer(unsigned int cnt);//get NUC-UPS charger timers
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsChargeEndedCondition();//get NUC-UPS charge ended
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsBatteryLevel();//get NUC-UPS battery level (percents 0-100)
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsCPUUsage();//get NUC-UPS CPU usage
:extern "C" NUCUPSLIB_API void restartNUCUps();//restart NUC-UPS
:extern "C" NUCUPSLIB_API void restartNUCUpsInBootloaderMode();//restart NUC-UPS in bootloader mode
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsMaxVariableCnt();//get NUC-UPS maximum variable count
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsVariableData(unsigned int cnt, char* name, char* value, char* unit,

char* comment);//get NUC-UPS variable data
:extern "C" NUCUPSLIB_API void startNUCUpsLoadingSettings(unsigned char to_file, unsigned char

compare_with_old);//start loading data from device
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsLoadingSettingsState();//get load settings current state: 0-64 -

steps, 100=success, 0xF1-0xFF=failure
:extern "C" NUCUPSLIB_API unsigned char setNUCUpsVariableData(unsigned int cnt, char* value);//set NUC-UPS variable

data for a given variable
:extern "C" NUCUPSLIB_API void startNUCUpsSaveSettings(unsigned char from_file);//start saving data to device
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsSaveSettingsState();//get saving current state: 0-64 - steps,

100=success, 0xF1-0xFF=failure
See the examples for usage.
</code>

IMPORTANT: the API dll needs 4 files from Visual Studio 2005 redistribution pack (Microsoft.VC80.CRT.manifest,

msvcm80.dll, msvcp80.dll, msvcr80.dll).

IMPORTANT: the API supports only one NUC-UPS connected to the computer.

====Visual C++ Example====
Open TestAPI.sln from the package, set CLibTest project as active project, run it and see CLibTest.cpp for usage

example.
====Visual Basic Example====
Open TestAPI.sln from the package, set VBLibTest project as active project, run it and see Module1.vb for usage

example.
====Visual C# Example====
Open TestAPI.sln from the package, set CSLibTest project as active project, run it and see Program.cs for usage

example.

===Download API and example projects===

{| class="wikitable" style="text-align: center;"

|'''Version'''||'''Change list'''
|-
||[http://wiki.mini-box.com/images/3/35/NUCUPSApiTestV1.0.zip '''1.0''']||First version
|-
||[http://wiki.mini-box.com/images/a/af/NUCUPSApiTestV1.1.zip '''1.1''']||Update for Firmware 1.1
|}

MediaWiki:Common.css

2020-10-20T18:07:22Z

Admin:

/* CSS placed here will be applied to all skins */
#ca-talkm { display: none !important; }
li#ca-history, li#ca-viewsource, li#ca-talk, #p-tb { display: none; }';
h1#firstHeading.firstHeading {border-bottom: 0px;}

MediaWiki:Common.css

2020-10-20T17:29:59Z

Admin:

/* CSS placed here will be applied to all skins */
#ca-talkm { display: none !important; }
li#ca-history, li#ca-viewsource, li#ca-talk, #p-tb { display: none; }';
#firstHeading {border-bottom: 0px;}

MediaWiki:Common.css

2020-10-20T17:28:34Z

Admin:

/* CSS placed here will be applied to all skins */
#ca-talkm { display: none !important; }
li#ca-history, li#ca-viewsource, li#ca-talk, #p-tb { display: none; }';
#firstHeading h1 {border-bottom: 0px;}

MediaWiki:Common.css

2020-10-20T17:27:41Z

Admin:

MediaWiki:Common.css

2020-10-20T17:24:51Z

Admin:

/* CSS placed here will be applied to all skins */
#ca-talkm { display: none !important; }
li#ca-history, li#ca-viewsource, li#ca-talk, #p-tb { display: none; }';
h1:first-child, h2:first-child {
margin-bottom: 0.6em;
border-bottom: 0px;
}

Main Page

2020-10-20T13:28:47Z

Admin:

{{DISPLAYTITLE:<span style="display:none">{{FULLPAGENAME}}</span>}}

[[openUPS2|openUPS2]]<br>
[[DCDC-NUC|DCDC-NUC]]<br>
[[NUC-UPS|NUC-UPS]] <br>

[http://resources.mini-box.com/online/PWR-OpenUPS/PWR-OpenUPS-hardware-manual.pdf OpenUPS] <br>
[http://resources.mini-box.com/online/PWR-DCDC-USB/PWR-DCDC-USB-manual.pdf DCDC-USB] <br>
[http://resources.mini-box.com/online/PWR-DCDC-USB-200/PWR-DCDC-USB-200-manual.pdf DCDC-USB-200] <br>

MediaWiki:Common.css

2020-10-20T13:27:07Z

Admin:

/* CSS placed here will be applied to all skins */
#ca-talkm { display: none !important; }
li#ca-history, li#ca-viewsource, li#ca-talk, #p-tb { display: none; }';

MediaWiki:Common.css

2020-10-20T13:26:09Z

Admin:

/* CSS placed here will be applied to all skins */
#ca-talkm { display: none !important; }
li#ca-history, li#ca-viewsource, li#ca-edit, li#ca-talk, #p-tb { display: none; }';

MediaWiki:Common.css

2020-10-20T13:24:40Z

Admin:

/* CSS placed here will be applied to all skins */
#ca-talkm { display: none !important; }
li#ca-history, li#ca-viewsource, li#ca-edit, li#ca-talk, .vectorMenu { display: none; }';

MediaWiki:Common.css

2020-10-20T13:21:53Z

Admin:

/* CSS placed here will be applied to all skins */
#ca-talkm { display: none !important; }
#p-tb { display: none }

File:NUCUPS sm traysettings.jpg

2020-10-20T13:17:22Z

Admin:

File:NUCUPS sm menu.jpg

2020-10-20T13:17:10Z

Admin:

File:NUCUPS sm tray3.jpg

2020-10-20T13:16:39Z

Admin:

File:NUCUPS sm tray2.jpg

2020-10-20T13:16:23Z

Admin:

File:NUC-UPS-Settings.JPG

2020-10-20T13:16:06Z

Admin:

File:NUC-UPS-Charger.JPG

2020-10-20T13:15:51Z

Admin:

File:NUC-UPS-Status.JPG

2020-10-20T13:15:37Z

Admin:

File:LED Missing.PNG

2020-10-20T13:15:19Z

Admin:

File:LED Wait Hardoff Running From Battery.PNG

2020-10-20T13:14:34Z

Admin: Admin uploaded a new version of File:LED Wait Hardoff Running From Battery.PNG

File:LED Wait Hardoff Running From Battery.PNG

2020-10-20T13:13:56Z

Admin:

File:LED Wait Hardoff Running From Vin.PNG

2020-10-20T13:13:33Z

Admin:

File:LED Running From Battery.PNG

2020-10-20T13:13:16Z

Admin:

File:LED Running From Vin.PNG

2020-10-20T13:13:01Z

Admin:

File:LED Batteries Charging.PNG

2020-10-20T13:12:44Z

Admin:

File:LED Initial Delay.PNG.PNG

2020-10-20T13:12:29Z

Admin:

File:LED LPWR Mode On USB Or In Automotive Standby.PNG

2020-10-20T13:12:09Z

Admin:

File:Immediate shutdown.PNG

2020-10-20T13:11:09Z

Admin:

File:Gracious shutdown.PNG

2020-10-20T13:10:54Z

Admin:

File:Automotive mode waking with Ignition.PNG

2020-10-20T13:10:37Z

Admin:

File:Dumb mode waking with button.PNG

2020-10-20T13:10:23Z

Admin:

File:Dumb mode waking with VIN.PNG

2020-10-20T13:10:07Z

Admin:

File:Nucupslegend.jpg

2020-10-20T13:09:38Z

Admin:

NUC-UPS

2020-10-20T13:05:36Z

Admin: Created the page

'''6-38V Intelligent Automotive grade Uninterruptible Power Supply'''<br><br>
'''Before you start…<br>
Often times, rushing into installing the unit can result in serious damage to your DCDC-NUC UPS board or computer.
Always double check the polarity of your wires with a voltmeter.<br><br>
'''Always double check the polarity of the batteries before introducing into the UPS device.'''<br>
'''Improper configuration leads to system damage!!!'''<br><br>
<nowiki>*</nowiki> NOTE: Forced ventilation or 40% input or output current de-rating or both is required if any of the following conditions are met:<br>
If V(IN) 24-38V <br>
If I(Out) > 2A and T(ambient) > 30°C, open air operation.<br>
In order to prevent premature battery damage due to thermal exposure, always check NUC-UPS board temp and ensure it does not exceed 55C for your application.

==Introduction==
The NUC-UPS was designed to provide +12V regulated power output from a wide input voltage(6V-38V).<br>
It has a range of intelligent functions not found in any of the traditional USB converters.<br>
The unit is able to gracefully shut down motherboards based on Ignition sensing or battery voltage level, by pulsing

the motherboard on/off pins. This makes it an ideal device for automotive or battery powered installations.<br>
It features 4 replaceable Li-Ion batteries for battery backup integrated in the device, there is no need for any

kind of special cabling between cells and UPS.
The charger is a Synchronous Buck-Boost converter capable of charging the batteries with input voltage below, equal

or above battery voltage level.
It charges the battery in three phases: preconditioning, constant current mode and constant voltage mode. <br>
The output converter is a synchronous Buck converter providing regulated 12V output.
The unit can be used as an embedded UPS or as a Portable Energy Pack providing the user with regulated 12V wherever

needed.

==Features==
* USB interface, works with Windows devices (Linux API planned)<br>
* Input between 6-38V<br>
* Programmable thresholds, timings and configuration modes<br>
* Generates regulated 12V output voltage<br>
* Output current 5A continuous
* Supports Li-Ion (3.7V) battery chemistry<br>
* 3 state charger(precharge, constant current, constant voltage)<br>
* Battery balancing, 4S configuration.<br>
* Charge voltage 4x4.2V, charge current 1A, precharge current ~0.3A<br>
* Coulomb counting<br>
* Battery temperature monitoring for each cell and temperature compensated charge<br>
* Start/Stop button and header<br>
* Motherboard ON/OFF pulse control*<br>
* Motherboard detection by power consumption or 5VUSB presence
* Missing battery cells detection<br>
* Ultra low power consumption(5uA- in Deep Sleep mode) or (250uA- in Dumb mode Standby) or (5mA- Automotive mode

Standby)<br>
* Windows detects device as “Battery”, with no special drivers required **<br><br>

==Diagram & Schematics==
==Connectors==
<div style="display: inline; float: left;">[[File:Nucupslegend.jpg|230px|thumb|left|Connectors nomenclature]]</div>
<div style="clear: both;"></div>
===Power Input connectors===
;P1 Input (mini-FIT JR, 1x4 pins)
: P1.1,P1.2-GND
: P1.3-Ignition sensing
: P1.4-Input voltage
;P2 Input (DC Power Jack:2DC-G213-B49, Mating plug 5.50x2.50)

;P3 Output (mini-FIT JR, 1x4 pins)
: P3.1,P3.2-GND
: P3.3,P3.4-Output voltage
;P4 Output (B4B-EH-A(LF)(SN), 1x4 pins)
: P4.1,P4.2-GND
: P4.3,P4.4-Output voltage

===Interface connectors===
;P5 Motherboard POWER SW connection, no polarity (JST_B3B-PH-KL, 1x3pins)
: P5.1: SW1
: P5.2: GND
: P5.3: SW2
;P7 USB header (B4B-PH-K-S(LF)(SN), 1x4pins)
: P7.1: GND
: P7.2: USB D-
: P7.3: USB D+
: P7.4: +5V
;S1&P9 Start/Stop button header (M20-9990246, 1x2pins)
;P8 Programming header
P8.1: MCLR
P8.2: GND
P8.3: 5V
P8.4: PGD
P8.5: PGC

==NUC and OS Settings==
<br>
*'''NUC related settings'''<br><br>
<div>
<div style="display: inline; float: left;">[[File:BIOS.png|230px|thumb|left|NUC Visual BIOS 2.0 Setting]]</div>
:Setting up the NUC's behavior when power is re-applied:<br>
:- press '''F2''' key during the boot sequence to entering the NUC's BIOS (Visual BIOS 2.0)<br>
:- first click on '''Advanced''' then click on '''Power''' menu button<br>
:- in '''Secondary Power Settings''' section select '''Power On''' option for '''After Power Failure'''<br>
:- the picture shows the right option in a red framework<br>
:- now the power supply should be able to '''START''' the NUC by applying corresponding voltage to its power

input<br>
</div>
<div style="clear: both;"></div>

==Firmware update==
It is recommended that you only connect USB power to the device
when making a firmware update via “bootloader mode”.

There are two ways to enter in bootloader mode: 1a) or 1b).<br>
1a) Place a jumper on the P8.4 and P8.5 pins then connect the unit to USB<br>
1b) Connect the unit to USB then press the Switch to bootloader button on the configuration software's user

interface.<br>
2) Start the [http://wiki.mini-box.com/images/a/ae/Bootloader_Software.zip '''HIDBootloader v2.9j.exe'''] software

provided to flash the new firmware.<br>
3) Press File->Import Firmware Image<br>
4) Press Open new Hex [http://wiki.mini-box.com/images/4/4b/DCDC-NUC_UPS-_FW_ver_1.3_for_loading_with_bootloader_2017.oct.09.zip '''File''']<br>
5) Press Program->Erase/Program/Verify Device<br>
6) If used option 1a) remove the jumper
6) Press Program->Reset Device<br>
7) After the device reconnects on USB with the configuration software the new firmware version will be displayed in

the title bar of the software.<br>

==NUC-UPS operating modes==
For configuration purposes only the unit can be started by connecting the unit to USB.<br>
Inserting the batteries should be the first step to perform.<br>
Waking the unit for the first time implies applying input voltage.<br>
The operating modes can be selected by setting the NUC_UPS_MODE parameter to 0(DUMB mode) or 1(AUTOMOTIVE mode).<br>
Further parameters can be customized by changing in the [http://wiki.mini-box.com/index.php?title=NUC-UPS#Parameter_List '''Parameter List'''].<br>
===Dumb Mode===
:When in this mode the unit still works as an UPS or it can be used as a general purpose battery pack.<br>
;Starting the unit
:In this mode starting can be performed either by applying input voltage or pressing the button for 500ms.<br>
;Stopping the unit
:In this mode stop sequence can be initiated by pressing the button for 500ms.<br>

===Automotive Mode===
;Starting the unit
:In this mode Starting can be performed by applying input voltage and applying ignition voltage.<br>
:The ignition voltage thresholds are configurable set by the IGN_HIGH_THRESHOLD, IGN_LOW_THRESHOLD parameters.The

Ignition voltage must be higher than IGN_HIGH_THRESHOLD for the duration set by the IGN_COUNT parameter in order to

filter out unwanted noise in automotive environment.<br>
;Stopping the unit
:In this mode stop sequence can be initiated if Ignition voltage is lower than IGN_LOW_THRESHOLD parameter for the

duration set by the IGN_COUNT parameter.<br>

===Stop conditions that apply in both modes===
:When the unit is running on batteries the following conditions can initiate shutdown(the shutdown reason can be

identified on the Status-UPS tab,Shutdown groupbox in the Configuration software):<br>
:-one of the cell voltages is less than UPS_VCELL_MIN_STOP parameter, shutdown sequence is initiated.<br>
:-the unit is on battery for more than UPS_ON_BATTERY_TOUT parameter, shutdown sequence is initiated.<br>
:-one of the cell voltages is less than UPS_VCELL_MIN_HARD_STOP parameter, shutdown is immediate.<br>
:-one of the batteries temperature is out of the limits set by the DCHG_TEMP_COLD, DCHG_TEMP_HOT parameters.<br>
:-overload, when the maximum allowed discharge current exceeds the value set by UPS_OVERLOAD parameter.<br>
:If output is out of regulation the unit is immediately stopped.

===Startup and Shutdown sequence===
====Startup sequences====
[[File:Dumb_mode_waking_with_VIN.PNG|600px]]
[[File:Dumb_mode_waking_with_button.PNG|600px]]
[[File:Automotive_mode_waking_with_Ignition.PNG|600px]]<br>
====Shutdown sequences====
[[File:Gracious_shutdown.PNG|600px]]
[[File:Immediate_shutdown.PNG|600px]]

===Motherboard control===
The following options are available to control the motherboard by pulsing the on/off pins on the motherboard.
First the the motherboard On/OFF pins should be connected to the P5.1,P5.3 pin on the P5 [http://wiki.mini-box.com/index.php?title=NUC-UPS#Interface_connectors '''Interface_connector'''].<br>
The pulse width is 500ms by default which can be altered by changing MOB_PULSEWIDTH parameter from the [http://wiki.mini-box.com/index.php?title=NUC-UPS#Parameter_List '''Parameter_List'''].<br>
There are various ways to control the motherboard depending the configuration of the CONFIG1 register from the [http://wiki.mini-box.com/index.php?title=NUC-UPS#Parameter_List '''Parameter_List'''].<br>
Example:If startup of the motherboard is not needed when input is present, the startup pulse can be disabled by setting CONFIG1.b0 to 0.<br>
The same way the shutdown pulse can be inhibited by setting CONFIG1.b1 to 0.<br>
There are cases when motherboard started(ON) or OFF presence must be detected in order starting/stopping by pulses behavior work properly.<br>
For example the Operating System could be shutdown already from software. In case the unit is is a shutdown sequence not knowing this piece of information would lead by sending the shutdown pulse which would wake up instead the system.<br>
There are two kinds of feedback information to detect motherboard status.<br><br>
The first detection mode is by measuring the consumed output power, knowing that a motherboard when started consumes much more power than when in standby.<br>
In order to enable this feature the following steps should be performed:<br>
1. Enable this feature, CONFIG1.b2 should be set to 1.<br>
2. Observe and note the consumption of the connected motherboard when in standby and when is ON.
Our unit measures the output power(POUT) which is displayed in the configuration software.<br>
3. Set POUT_HIGH_THRESHOLD and POUT_LOW_THRESHOLD parameters from the [http://wiki.mini-box.com/index.php?title=NUC-UPS#Parameter_List '''Parameter_List'''] accordingly with a good margin. <br>
POUT<POUT_LOW_THRESHOLD motherboard is considered OFF.<br>
POUT>POUT_HIGH_THRESHOLD motherboard is considered ON.<br><br>
The second detection mode is by measuring the +5VUSB signal. Usually motherboards turn OFF the +5VUSB signal when they are OFF.<br>
In order to enable this feature CONFIG1.b3 must be set to 1.

==NUC-UPS charger==
The charger is a Synchronous Buck-Boost converter capable of charging the batteries with an input voltage below, equal or above battery voltage level.<br>
The charging happens three phases: preconditioning, constant current mode and constant voltage mode:
:• The charging is starting with a preconditioning phase, where the current is limited to ~350mA. The preconditioning phase has a minimum duration set by CHG_COND_TOUT which is extended if one of the cells voltage is below the limit set by CHG_CELL_VCOND.<br>
:• In constant current phase charge current is limited to 1A. After battery voltage rises to the value set by the hardware charger, the charger will enter constant voltage mode.<br>
:• In constant voltage phase the battery will absorb less current as time passes and charge current will decrease. When the charge current decreases below ~150mA, charging is stopped.<br>

During low power state the charger is disabled, so the charger module is also disabled in automotive mode when the Ignition is OFF, even if input is present.<br>

Charging will be terminated if a global charge timer elapses, this can be set by CHG_GLOBAL_TOUT parameter.<br>
Charging is limited to precharge value if one of the batteries temperature exceeds limits set by CHG_TEMP_COOL,CHG_TEMP_WARM parameters.<br>
Charging is terminated if one of the batteries temperature exceeds the limits set by CHG_TEMP_COLD,CHG_TEMP_HOT. <br>
In order to work properly the following conditions when changing parameters must be fulfilled: CHG_TEMP_COLD < CHG_TEMP_COOL < CHG_TEMP_WARM < CHG_TEMP_HOT.

The temperature sensors are located just below the batteries for proper temperature detection of each cell.<br>
:[[File:Charge-regulation.png|325px|thumb|left|]]
<div style="clear: both;"></div>

==NUC-UPS Charge Balancer==
The balancing algorithm is voltage based. Balancing is allowed if cell voltage exceeds the value set in the BAL_VCELL_MIN parameter.<br>
Balancing is started if the voltage difference between the cells is higher than BAL_VCELL_DIFF_START, and will be stopped if the difference is lower than the value defined in BAL_VCELL_DIFF_STOP parameter.<br>

==NUC-UPS Fuel gauge==
The initial remaining capacity is detected based on an open-circuit voltage based state-of-charge estimation, using the predefined values set by the OCV_SOCxx parameters.
Further estimation is based on coulomb counting method which is more precise after a full charge cycle has been performed.<br>

==Led Blinking==
The unit has two LEDs on board (Red and Green), located on the right and left side of the USB connector.<br>
While there are scenarios where both LEDs are blinking with a certain pattern, the LEDs generally help identifying the power source that runs the UPS output at any given moment.
:• The green LED signals that the NUC-UPS is running from input voltage
:• The red LED signals that the NUC-UPS is running from batteries

The blinking patterns that can occur during operation are shown in the images below. The duration of LED blinks can also be seen on the images, displayed in milliseconds.<br>

[[File:LED_LPWR_Mode_On_USB_Or_In_Automotive_Standby.PNG|600px]]
[[File:LED_Initial_Delay.PNG.PNG|600px]]<br>
[[File:LED_Batteries_Charging.PNG|600px]]
[[File:LED_Running_From_Vin.PNG|600px]]<br>
[[File:LED_Running_From_Battery.PNG|600px]]
[[File:LED_Wait_Hardoff_Running_From_Vin.PNG|600px]]<br>
[[File:LED_Wait_Hardoff_Running_From_Battery.PNG|600px]]
[[File:LED_Missing.PNG|600px]]<br>

==Parameter List==

{| class="wikitable"
! NAME
! Description
|-
| NUC_UPS_MODE[-]
| <pre>
0-Dumb mode (DUMB)
1-Automotive mode (AUTOMOTIVE)
</pre>
NUC_UPS_MODE

|-
| UPS_ON_BATTERY_TOUT
|
Deep sleep timeout. If system is running on battery and this period has elapsed with no input power applied, the UPS

will initiate shut down procedure. "Never" is allowed as value (to disable this feature). Default is "Never".

|-
| INIT_TOUT
|
When all power supply start-up conditions are met, the PSU will wait this time before continuing with the start-up

sequence.

|-
| VIN_MIN_STARTUP
|
If the input voltage is beyond this threshold and all other start-up conditions are met, the PSU can start. Default

is 11000mV.

|-
| VIN_MIN_RUNNING
|
If input voltage is below this threshold, the output is powered from battery. Default is 8000mV.

|-
| VIN_COUNT
|
Input voltage filtering. Default is 100ms.

|-
| IGN_COUNT
|
Ignition voltage filtering. Default is 100ms.

|-
| IGN_HIGH_THRESHOLD
|
If ignition voltage is beyond this threshold, ignition is considered to be ON. Default is 6000mV.

|-
| IGN_LOW_THRESHOLD
|
If ignition voltage is below this threshold, ignition is considered to be OFF. Default is 5000mV.

|-
| IGN_ON_TO_OUTPUT_ON_TOUT
|
After ignition is considered ON, the PSU will wait this time before the output is turned ON. Default is 2000ms.

|-
| IGN_CANCEL_TOUT
|
After the motherboard boots up, the ignition voltage sensing will be disabled for this period. Default is 60s.

|-
| OUTPUT_ON_TO_MOB_PULSE_ON_TOUT
|
After the output was turned on, the UPS will wait this period before sending the ON pulse to the motherboard.

Default is 20ms

|-
| IGN_OFF_TO_MOB_PULSE_OFF_TOUT
|
In automotive mode, after the ignition is considered OFF, this UPS will wait this period before sending the OFF

pulse to the motherboard. Default is 5s

|-
| MOB_PULSEWIDTH
|
The length of the start-up/shutdown pulse sent to the motherboard. Default is 500ms.

|-
| HARD_OFF_TOUT
|
After the shutdown pulse is sent to the motherboard, the UPS will wait this period before the output is turned OFF.
This time-out allows the operating system to perform a clean shutdown. Default is 60s.

|-
| PWM_SPREAD_MODULATING_FREQ
|
Modulation frequency parameter of the Random Spread Frequency Modulation module (used for EMI reduction purposes)

|-
| PWM_SPREAD_PERCENT
|
Frequency deviation parameter of the Random Spread Frequency Modulation module (used for EMI reduction purposes)

|-
| PWM_FREQ
|
Operating frequency of the Switched Mode Power Supply

|-
| CONFIG1
|
Configuration register [b7..b0]. Used for enabling/disabling modules. 0 - disabled, 1 - enabled <br>
b7 - Unused <br>
b6 - Unused <br>
b5 - Unused <br>
b4 - Unused <br>
b3 - If set, the USB sense is enabled, +5V USB is used to detect the Motherboard alive status<br>
b2 - If set, the Power measurement (Vout x Iout) is used to detect the Motherboard alive status<br>
b1 - If set, shutdown pulse is enabled through the PWRSW connector.<br>
b0 - If set, startup pulse is enabled through the PWRSW connector.<br>

Depending motherboard alive status the shutdown/startup pulse is sent if b2/b3 is enabled.
The motherboard presence can be smartly detected if b2/b3 is enabled.
For example: In case motherboard is already shut down the pulse is not sent in case of a shutdown scenario.
This is also true in case of a startup scenario.

|-
| CONFIG2
|
Configuration register. Used for enabling/disabling modules. 0 - disabled, 1 - enabled <br>
b7..b0 - Reserved/Unused <br>

|-
| WRITE_COUNT
|
The number of times the internal Flash program memory has been written.

|-
| IOUT_OFFSET
|
This value will be summed with the measured input current, this is a calibration parameter. Default is 0mA

|-
| CAPACITY
|
Battery Capacity.
Default is 1000mAh.

|-
| UPS_BUTTON_ON_TOUT
|
Filtering time for button pressing. Default is 100ms.

|-
| UPS_VCELL_MIN_START
|
If Vin is not present and all the battery cells are above this threshold, the UPS can start and will run on battery.
Default is 3.6V.

|-
| UPS_VCELL_MIN_STOP
|
If VIN is not present and one of the battery cells is less than this threshold , the UPS will initiate a shutdown

procedure.
Default is 3.3V.

|-
| UPS_VCELL_MIN_HARD_STOP
|
If VIN is not present and one of the battery cells is less than this threshold, the UPS will instantly shut down to

preserve battery.
Default is 3V.

|-
| UPS_OVERLOAD
|
Max allowed discharge current. In case the discharge current exceeds this threshold, shutdown will be initiated.
Default is 6000mA

|-
| DCHG_TEMP_COLD
|
COLD temperature threshold for discharge. In case exceeded UPS will shutdown when on battery. Default is -20°C (FW

ver 1.1)

|-
| DCHG_TEMP_HOT
|
HOT temperature threshold for discharge. In case exceeded UPS will shutdown when on battery. Default is 60°C (FW ver

1.1)

|-
| CHG_COND_TOUT
|
Conditioning/Precharge time. Charge current is limited until cell voltage exceeds CHG_VCOND value and it is applied

during this time.
Default is 30 sec.

|-
| CHG_BULK_STOP_VOLTAGE
|
Maximum allowed bulk charge voltage/cell during constant current/constant voltage charging.
Default is 4.1 [V/cell].

|-
| CHG_HYSTERESIS
|
An overvoltage value ( CHG_BULK_STOP_VOLTAGE + CHG_HYSTERESIS ) that is allowed when charging. If one of the cells

exceeds this value, charging is immediately stopped.
Default is 100mV/cell.

|-
| CHG_START_VOLTAGE
|
If cell voltage is below this value, charging can be started.
Default is 3.85V/cell.

|-
| CHG_GLOBAL_TOUT
|
Global charge timeout.
Default is 240 min.

|-
| CHG_TOPPING_TOUT
|
After an overvoltage condition is detected for a cell (for Lithium based batteries), a resting period is set by this

timer before applying a small topping charge - in case other cells are still not charged.
Default is 60s.

|-
| CHG_TEMP_COLD
|
COLD temperature threshold for temperature compensated charge current regulation.
Default 5°C(FW ver 1.0)

|-
| CHG_TEMP_COOL
|
COOL temperature threshold for temperature compensated charge current regulation.
Default 10°C(FW ver 1.0)

|-
| CHG_TEMP_WARM
|
WARM temperature threshold for temperature compensated charge current regulation.
Default 50°C(FW ver 1.0)

|-
| CHG_TEMP_HOT
|
HOT temperature threshold for temperature compensated charge current regulation.
Default 55°C(FW ver 1.0)

|-
| UPS_VCELL_ADC_OFFSET
|
This value will be summed with the measured cell voltages, this is a calibration parameter. Default is 0mV.

|-
| CHG_CELL_VCOND
|
Conditioning/Pre-charge voltage. Charge current is limited until cell voltage exceeds this value and for at least

CHG_TCOND time . Default is 3.3V

|-
| BAL_VCELL_MIN
|
Balancing is allowed if cell voltages are above this value.
Default is 3.4V

|-
| BAL_VCELL_DIFF_START
|
If the voltage difference between cells exceeds this value, cell balancing will start.
Default is 80mV.

|-
| BAL_VCELL_DIFF_STOP
|
If the voltage difference between cells is less than this value, cell balancing will stop.
Default is 40mV.

|-
| OCV_SOC0
|
Open Circuit Voltage State Of Charge detection for initial 0% fuel gauge estimation.
Default is 3.3V.

|-
| OCV_SOC10
|
Open Circuit Voltage State Of Charge detection for initial 10% fuel gauge estimation.
Default is 3.68V.

|-
| OCV_SOC25
|
Open Circuit Voltage State Of Charge detection for initial 25% fuel gauge estimation.
Default is 3.76V.

|-
| OCV_SOC50
|
Open Circuit Voltage State Of Charge detection for initial 50% fuel gauge estimation.
Default is 3.82V.

|-
| OCV_SOC75
|
Open Circuit Voltage State Of Charge detection for initial 75% fuel gauge estimation.
Default is 3.97V.

|-
| OCV_SOC100
|
Open Circuit Voltage State Of Charge detection for initial 100% fuel gauge estimation.
Default is 4.17V.

|-
| POUT_HIGH_THRESHOLD
|
If output power measured is higher than this threshold the connected motherboard is considered to be ON.
Together with POUT_LOW_THRESHOLD parameter sets a hysteresis for motherboard status. CONFIG1.b2 must be set in order to be active. Default is 3000mW.

|-
| POUT_LOW_THRESHOLD
|
If output power measured is lower than this threshold the connected motherboard is considered to be OFF.
Together with POUT_HIGH_THRESHOLD parameter sets a hysteresis for motherboard status. CONFIG1.b2 must be set in order to be active. Default is 1000mW.
|}

==Software manual==
===Windows OS built-in support===
The NUC-UPS implements two generic USB classes, therefore most of the operating systems are recognizing it without

any additional driver installation. This two classes are:
a.) "HID UPS Battery" for OS built-in communication.
Microsoft Windows versions are recognizing this class automatically and the device should appear in device manager

at Batteries as a "Hid ups battery", together with all settings and power plan possibilities provided by the OS for

any battery.
b.) "HID" for communication and configuration
This endpoint is a generic HID and it is used by our configuration and monitor software to read/write voltages and

other important parameters of the NUC-UPS. This endpoint does not needs any additional driver either, Microsoft

Windows OS should recognize it as a generic HID USB device.

===Configuration software===
The configuration software provides interface for NUC-UPS monitoring, logging and setup.
It's recommended to be used by users with deeper understanding of the NUC-UPS hardware since permits setting

voltages, currents and other parameters which can be
dangerous if they are set without precaution.<br />
The configuration software has three main screens (Status-UPS, Status-Charger and Settings) and a header with the

important voltage/current values.<br />

====The first main screen is the "Status-UPS"====
Example of this screen is shown in the next image:<br />
<div style="display: inline; float: left;">
[[File:NUC-UPS-Status.JPG‎|x350px|thumb|left|Status screen]]
</div>

The title bar shows the connection status, the firmware version and the mode of the NUC-UPS. Example: "NUC-UPS

Connected v1.0 Mode: Dumb"

The header of the status screen contains:
:VIn: Input Voltage
:VIgn: Ignition Voltage
:VBat: Battery Voltage
:VOut: Output Voltage
:POut: Output Power
:IOut: Output Current
:Battery pack %: Battery percentage
:[0]: Battery 0 status
:[1]: Battery 1 status
:[2]: Battery 2 status
:[3]: Battery 3 status
:[Pack]: Battery pack overall voltage and current

The "Status-UPS" screen contains extended information about the current state of the NUC-UPS like internal state

machine, voltages, currents, temperature, different read only state flags.
The user also have the possibility to log the current state into a *.csv file in the "Log" section.
<div style="clear: both;"></div>

====The second main screen is the "Status-Charger"====
<div style="display: inline; float: left;">
[[File:NUC-UPS-Charger.JPG‎|x350px|thumb|left|Status screen]]
</div>
Contains extended information about current state of the NUC-UPS battery charger (internal state machines, flags)
<div style="clear: both;"></div>

====The third main screen is the "Settings"====
Example of this screen is shown in the next image:<br />
<div style="display: inline; float: left;">
[[File:NUC-UPS-Settings.JPG‎|x350px|thumb|left|Settings screen]]
</div>

This screen contains two main sections: the individual parameter setup for experienced users and the parameter

save/load into/from file section.

The main section of the "Settings" screen is the individual parameter settings.<br>
This is recommended to be done only by experienced users. Any parameter of the NUC-UPS can be set from here.

Changing one parameter is simple:
:- select the desired parameter from the "Parameter" list (simple click to select, double-click to edit). Below the

parameter list a helper text is displayed (same from this manual).
:- after double click introduce the new value in the new popup dialog and press OK
:- the introduced value is checked - if something is wrong (out of limit, bad value etc.) error message will be

shown
:- the ! sign will blink on the "Sync all parameters to the NUC-UPS" button to show edited but not saved/synced

variables
:- after You have done with all parameter setting press the "Sync all parameters to the NUC-UPS" button to send all

values to the NUC-UPS. IMPORTANT: without this step the new values will be lost, nothing is sent to the NUC-UPS!

IMPORTANT: any parameter setting is taken into account by the NUC-UPS in this cases:
: - after a full restart either with power cut from all sources (usb, vin)
: - hitting the "Restart NUC-UPS" button
: - keeping the "Reload parameters on the fly after sync" checked.
Do any parameter change with precaution, check the parameters and wires before applying it!

For users who need to setup more devices with the same NUC-UPS settings, it is recommended to use the save/load

parameters buttons.
The "Parameters: NUC-UPS ===> File (settings.ini)" button loads a full configuration from the NUC-UPS and saves it

to the settings.ini file. You can disconnect
the current NUC-UPS from the USB and insert a new one, than press the "Parameters: NUC-UPS <=== File (settings.ini)"

button to send the last saved configuration into the new NUC-UPS.

The "Parameters: NUC-UPS ===> CSV File (settings.csv)" button loads all parameters from the connected NUC-UPS and

saves it into a csv file. This type of file can be opened by any spreadsheet editor (OpenOffice, Microsoft Excel

etc.) and contains the full set of parameters in human readable form.

The "Switch to bootloader" button is intended to be used for firmware updates. After You press this button the NUC-

UPS will disconnect, it will switch to bootloader mode and firmware can be updated as described [[NUC-

UPS#Bootloader_Mode|here]]

Every save/load/sync operation on the "Settings" screen affects the progress bar and the status bar on the bottom of

the screen (labelled with "State:"). In rare cases You
might get error here with "try again" message. This happens in case of one parameter byte get's corrupted or timeout

occurs during USB communication and/or NUC-UPS flashing
operation. Please try again and contact our support team only if the device gives this error 4-5 times in a row.

===Windows System monitor===
The system monitor is a tray bar software which shows the current state on the tray bar icon and a semi transparent

"always on top" capable small window.<br>
The popup window can be moved anywhere on the screen and can be customized. Our current setup has two skins but any

combination is possible playing with the
"skin*.mbs" files installed together with this application. The current skin can be selected right clicking on the

try icon.
The "skin*.mbs" files are simple text ones editable with any text editor (notepad for example).<br>
Adding a new skin is pretty simple – make a skin1.mbs (use the existing skin0.mbs for starting content) and start

playing with the values from the new
file.<br>
The values are self explanatory – skin name, background image files, font descriptions and label/value pair

coordinates for all the important NUC-UPS values.
The size of the popup is defined by the background image – transparent parts can be defined as well (see for

example: "bubble1.bmp").
Example screenshots:<br />
<div style="display: inline; float: left;">
[[File:NUCUPS_sm_tray2.jpg‎|x150px|thumb|left|System monitor skin1 connected]]
</div>
<div style="display: inline; float: left;">
[[File:NUCUPS_sm_tray3.jpg‎|x150px|thumb|left|System monitor skin1 disconnected]]
</div>
<div style="clear: both;"></div>

Right clicking on the tray icon will pop-up a simple menu:
<div style="display: inline; float: left;">
[[File:NUCUPS_sm_menu.jpg‎|x150px|thumb|left|System monitor settings]]
</div>
<div style="clear: both;"></div>
From which You can see firmware version and state of the NUC-UPS from the NUC-UPS Properties and set some visual

parameters of the application (transparency, skin) from Skin:
<div style="display: inline; float: left;">
[[File:NUCUPS_sm_traysettings.jpg‎|x150px|thumb|left|System monitor settings]]
</div>
<div style="clear: both;"></div>

For auto start with the system make a shortcut of AppTray.exe from the standalone package in the system Startup

([http://windows.microsoft.com/en-us/windows/run-program-automatically-windows-starts#1TC=windows-7 '''Windows

7'''], [http://support.microsoft.com/kb/2806079 '''Windows 8''']).

===Download software===

{| class="wikitable" style="text-align: center;"

|'''Version'''||'''Change list'''
|-
||[http://wiki.mini-box.com/images/3/33/NUCUPSv1.0.zip '''1.0''']||First version
|-
||[http://wiki.mini-box.com/images/5/55/NUCUPSv1.1.zip '''1.1''']||Update for Firmware 1.1
|}

===Developer manual===
Mini-box.com provides one NUC-UPS API in a DLL (NUCUpsLib.dll) and examples in Visual C++, Visual Basic and Visual

C#.<br>
Basic C++/Visual Basic/C# knowledge is needed to use this examples together with the API.
The API dll has manifest embedded to permit C# and Visual Basic dynamic load.

The API has a set of functions exported to access the full functionality of the NUC-UPS.
This functions are:
<code>
:extern "C" NUCUPSLIB_API const char* STATE_MACHINE_UPS[14];//state machine UPS
:extern "C" NUCUPSLIB_API const char* STATE_MACHINE_AFE[8];//state machine AFE
:extern "C" NUCUPSLIB_API const char* STATE_MACHINE_CHG[16];//state machine Charger
:extern "C" NUCUPSLIB_API const char* STATE_MACHINE_DTCT[16];//state machine Detect
:extern "C" NUCUPSLIB_API const char* STATE_MACHINE_LOWP[4];//state machine low power states
:extern "C" NUCUPSLIB_API unsigned char nucupsOpenDeviceHandler(unsigned int timer);//open device handler. timer

sets the refresh period in miliseconds (4 or 5 messages will be sent in this period e ending from debug mode)

IMPORTANT: the handler can be kept open to notice any NUC-UPS plugged in
:extern "C" NUCUPSLIB_API void nucupsCloseDeviceHandler();//close device handler
:extern "C" NUCUPSLIB_API void getNUCUpsDevicePath(char* path);//Get opened device path @param path - recommended

length 1024, will return empty string if no device opened
:extern "C" NUCUPSLIB_API unsigned char isNUCUpsConnected();//0=not connected, 1=normal state,2=loading settings

from device,3=saving settings from pc,4=saving settings from file
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsMode();//get NUC-UPS mode: 0=Dumb, 1=Automotive
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsInputFlags();//get NUC-UPS input flags
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsOutputFlags();//get NUC-UPS output flags
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsChargerFlags();//get NUC-UPS charger flags
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsStateFlags();//get NUC-UPS state flags
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsShutdownFlags();//get NUC-UPS shutdown flags
:extern "C" NUCUPSLIB_API float getNUCUpsVIn();//get NUC-UPS Input Voltage
:extern "C" NUCUPSLIB_API float getNUCUpsIOut();//get NUC-UPS Output Current
:extern "C" NUCUPSLIB_API float getNUCUpsVOut();//get NUC-UPS Output voltage
:extern "C" NUCUPSLIB_API float getNUCUpsVBats(int i);//get NUC-UPS battery voltages
:extern "C" NUCUPSLIB_API float getNUCUpsTemperature(int i);//get NUC-UPS battery temperature
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsCellBalanceOn(int i);//get NUC-UPS balanced battery (discharged)
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsCellDetected(int i);//get NUC-UPS battery detected
:extern "C" NUCUPSLIB_API float getNUCUpsVIgnition();//get NUC-UPS Ignition Voltage
:extern "C" NUCUPSLIB_API float getNUCUpsPOut();//get NUC-UPS Output Power
:extern "C" NUCUPSLIB_API float getNUCUpsVBat();//get NUC-UPS Bat voltage
:extern "C" NUCUPSLIB_API float getNUCUpsVPack();//get NUC-UPS Pack voltage
:extern "C" NUCUPSLIB_API float getNUCUpsIChgDchg();//get NUC-UPS Charge/Discharge current
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsSpecConsts(unsigned int type, unsigned int index);//get NUC-UPS

special constants
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsVerMajor();//get NUC-UPS major version of the firmware
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsVerMinor();//get NUC-UPS minor version of the firmware
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsState();//0 - not connected, 1 - running from battery, 2 - from

vin, 3 - from USB
:extern "C" NUCUPSLIB_API void setNUCUpsDBGMode(unsigned char dbg);//set dbg mode
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsDbgByte(int i);//get NUC-UPS debug bytes - valid only after

setNUCUpsDBGMode(1)
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsDbg2Byte(int i);//get NUC-UPS debug bytes - valid only after

setNUCUpsDBGMode(1)
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsDbg3Byte(int i);//get NUC-UPS debug bytes - valid only after

setNUCUpsDBGMode(1)
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsTimer(unsigned int cnt);//get NUC-UPS timer
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsStateMachines(unsigned int cnt);//get NUC-UPS internal state

machines 0=UPS 1=AFE 2=Charger 3=Detect 4=Batterymanager
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsChgTimer(unsigned int cnt);//get NUC-UPS charger timers
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsChargeEndedCondition();//get NUC-UPS charge ended
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsBatteryLevel();//get NUC-UPS battery level (percents 0-100)
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsCPUUsage();//get NUC-UPS CPU usage
:extern "C" NUCUPSLIB_API void restartNUCUps();//restart NUC-UPS
:extern "C" NUCUPSLIB_API void restartNUCUpsInBootloaderMode();//restart NUC-UPS in bootloader mode
:extern "C" NUCUPSLIB_API unsigned int getNUCUpsMaxVariableCnt();//get NUC-UPS maximum variable count
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsVariableData(unsigned int cnt, char* name, char* value, char* unit,

char* comment);//get NUC-UPS variable data
:extern "C" NUCUPSLIB_API void startNUCUpsLoadingSettings(unsigned char to_file, unsigned char

compare_with_old);//start loading data from device
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsLoadingSettingsState();//get load settings current state: 0-64 -

steps, 100=success, 0xF1-0xFF=failure
:extern "C" NUCUPSLIB_API unsigned char setNUCUpsVariableData(unsigned int cnt, char* value);//set NUC-UPS variable

data for a given variable
:extern "C" NUCUPSLIB_API void startNUCUpsSaveSettings(unsigned char from_file);//start saving data to device
:extern "C" NUCUPSLIB_API unsigned char getNUCUpsSaveSettingsState();//get saving current state: 0-64 - steps,

100=success, 0xF1-0xFF=failure
See the examples for usage.
</code>

IMPORTANT: the API dll needs 4 files from Visual Studio 2005 redistribution pack (Microsoft.VC80.CRT.manifest,

msvcm80.dll, msvcp80.dll, msvcr80.dll).

IMPORTANT: the API supports only one NUC-UPS connected to the computer.

====Visual C++ Example====
Open TestAPI.sln from the package, set CLibTest project as active project, run it and see CLibTest.cpp for usage

example.
====Visual Basic Example====
Open TestAPI.sln from the package, set VBLibTest project as active project, run it and see Module1.vb for usage

example.
====Visual C# Example====
Open TestAPI.sln from the package, set CSLibTest project as active project, run it and see Program.cs for usage

example.

===Download API and example projects===

{| class="wikitable" style="text-align: center;"

|'''Version'''||'''Change list'''
|-
||[http://wiki.mini-box.com/images/3/35/NUCUPSApiTestV1.0.zip '''1.0''']||First version
|-
||[http://wiki.mini-box.com/images/a/af/NUCUPSApiTestV1.1.zip '''1.1''']||Update for Firmware 1.1
|}

File:DCDCNUC sm traysettings.jpg

2020-10-20T13:03:06Z

Admin:

File:DCDCNUC sm menu.jpg

2020-10-20T13:02:51Z

Admin:

File:DCDCNUC sm tray3.jpg

2020-10-20T13:02:30Z

Admin:

File:DCDCNUC sm tray2.jpg

2020-10-20T13:02:19Z

Admin:

File:DCDC-NUC-Settings.JPG

2020-10-20T13:02:04Z

Admin: