en:odroid-ups2 [ODROID Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Introduction ======
The ODROID-UPS2 (Uninterrupted Power Supply) device is designed specifically for the ODROID-U3 and ODROID-C1.\\
It is equipped with a rechargeable Lithium-Polymer Battery, Charger IC and 5Volt Boost DCDC.\\

When the AC power source is removed, the UPS2 keeps supplying the power to the ODROID boards with the battery.\\
There is a digital output pin to send the battery low-level warning to the ODROID to trigger the shutdown process.\\
It will significantly reduce the risk of data loss by sudden power loss.\\
When the AC power source becomes available again, the UPS2 will supply power to the ODROID again automatically.\\

**Note that there are two different models of UPS2. One for ODROID-U3 and the other for ODROID-C1.\\
Do not swap the boards or your ODROID may be damaged.**

====== Specification ======
| **Power Input** ||
| Dc Input Voltage | DC 4.8~ 5.4V |
| DC Input Current | 2A  Min.| 
| **Charger** ||
| Charging Time | 1hour 30min ~ 2 hours |
| Battery Charging Current | 2A Max.|
| **Power Ouput** ||
| DC Output Current | 2A Max. | 
| DC Output Voltage | 5 V |
| ** Battery Pack ** ||
| Type | Lithium-Polymer|
|Capacity | 3000 mAh typical|
|Nominal Voltage | 3.7 V | 
|Battery Life| 400 charge/discharge cycles @ 20℃±5℃|
|Integrated Protection PCB|Overcharge/discharge Protection|
|ODROID-U3 Estimated Running Time with typical load of 300mA @ 5V | about 4 hours when fully charged|

Schematic for U3:
{{:en:ups2:odroid-u3_ups2_rev0.2.pdf|}}

Schematic for C1:
{{:en:ups2:odroid-c1_ups2_rev0.2.pdf|}}

PCB Layout(DWG):{{:en:ups2_board_mech_rev0.2.zip|}}


====== LED Indicators ======
BLUE LED(D1) 
   * Illuminated when power is connected and battery is charged
   * OFF when charger is idle:
        - Battery is fully charged
        - Power is not connected or shutdown
   * Rapidly blinking when power is connected but battery is not connected

====== Power Status Indicator & Control Pins ======
   * AC_OK output pin (pin#1 of JP1) is high when the AC source is available.
   * BAT_OK output pin (pin#3 of JP1) is high when the battery voltage is higher than 3.7V.
   * POWER_LATCH input pin (pin#5 of JP1) must be high to supply 5V to the load.
   * Pin#7 of JP1 is ground.
   * Pin#8 of JP1 is 5V power output.

====== Switch ======
Slide switch to control the 5V supply to the ODROID.\\
Slide the switch to the left (in the direction of the battery connector) to enable the 5V output.\\
Slide the switch to the right to disable the 5V output.
<WRAP left round important 70%>
{{:en:slide_sw.png?300|}}

Ensure that slide switch SW1 is to the left to enable power output.\\
Even when SW1 is off, the charging function keeps working.
</WRAP>

====== How to assemble =======

===== ODROID-U3 =====
  - Assemble the PCB spacers. The metal spacers must be placed between the ODROID-U3 and UPS2 PCB for proper grounding.
  - Align the 8 pin header and plug it into the 8 pin socket of ODROID-U3.
  - Connect DC-Plug of power supply into the DC-Jack on the ODROID-UPS2 board.

|1.|{{:en:ups2:odroid-u3_ups2_.jpg?300|}}|
|2.|{{:en:ups2:odroid-u3_ups2-1.jpg?300|}}|
|3.|{{:en:ups2:odroid-u3_ups2-2.jpg?300|}}|
|4.|{{:en:ups2:odroid-u3_ups2-3.jpg?300|}}|
|5.|{{:en:ups2:odroid-u3_ups2-4.jpg?300|}}|
|6.|{{:en:ups2:odroid-u3_ups2-5.jpg?300|}}|
|7.|{{:en:ups2:odroid-u3_ups2-6.jpg?300|}}|

===== ODROID-C1 =====
  - Assemble in the order shown below.
  - It is recommended to keep the horizontal 3 x 10mm PCB spacers in order to mount battery as shown in Figure 5-A,B.

|**Order**|**A type**||**Order**|**B type**|
|1_AB|{{:en:ups2:odroid-c1_ups2.jpg?300|}}||2_AB|{{:en:ups2:odroid-c1_ups2-1.jpg?300|}}|
|3_A|{{:en:ups2:odroid-c1_a_type_ups2-2.jpg?300|}}||3_B|{{:en:ups2:odroid-c1_b_type_ups2-3.jpg?300|}}|
|4_A|{{:en:ups2:odroid-c1_a_type_ups2-3.jpg?300|}}||4_B|{{:en:ups2:odroid-c1_b_type_ups2-4.jpg?300|}}|
|5_A|{{:en:ups2:odroid-c1_a_type_ups2-4.jpg?300|}}||5_B|{{:en:ups2:odroid-c1_b_type_ups2-5.jpg?300|}}|
|6_A|{{:en:ups2:odroid-c1_a_type_ups2-5.jpg?300|}}||6_B|{{:en:ups2:odroid-c1_b_type_ups2-6.jpg?300|}}|
|7_A|{{:en:ups2:odroid-c1_a_type_ups2-6.jpg?300|}}||7_B|{{:en:ups2:odroid-c1_b_type_ups2-7.jpg?300|}}|
|8_A|{{:en:ups2:odroid-c1_a_type_ups2-7.jpg?300|}}||8_B|{{:en:ups2:odroid-c1_b_type_ups2-8.jpg?300|}}|
|9_A|{{:en:ups2:odroid-c1_a_type_ups2-8.jpg?300|}}||9_B|{{:en:ups2:odroid-c1_b_type_ups2-9.jpg?300|}}|
|10_A|{{:en:ups2:odroid-c1_a_type_ups2-9.jpg?300|}}||10_B|{{:en:ups2:odroid-c1_b_type_ups2-10.jpg?300|}}|
|11_A|{{:en:ups2:odroid-c1_a_type_ups2-10.jpg?300|}}||11_B|{{:en:ups2:odroid-c1_b_type_ups2-11.jpg?300|}}|
  - Detailed connection picture between JP1 of UPS2 and the 40pin header(**J2**) of ODROID-C1.
|　C1|{{:en:ups2:odroid-c1_a_type_ups2-6_1..jpg?300|}}||UPS2|{{:en:ups2:odroid-c1_a_type_ups2-6_2.jpg?300|}}|
 

Due to hardware limitations, in order to use the UPS2 on ODROID-C2\\
  - Extract the blue cable of the 3-pin socket,\\
  - Connect the 3-pin socket as shown in the figure above the 40 pin Header.\\
The extracted lines connect the pin #26 of the 40 pin header as shown below.\\
{{:en:connection_ups2_for_odroidc2.png?400|}}



====== ODROID safe shutdown in the event of a power outage =====

===== Linux =====
==== ODROID-U3 ====
The AC_OK signal is connected to GPIO #200 in the 8pin header socket of ODROID-U3.\\
The BAT_OK signal is connected to GPIO #199.\\
     
==== ODROID-C1/C2 ====
The AC_OK signal is connected to PIN#11(GPIO #88) in the 40pin header(**J2**) of ODROID-C1/C2.\\
The BAT_OK signal is connected to PIN#13(GPIO #116).\\
The POWER_LATCH signal is connected to PIN#15(GPIO #115) of ODROID-C1.\\
The POWER_LATCH signal is connected to PIN#26(GPIO #225) of ODROID-C2.\\

**The BAT_OK pin is high when the battery voltage is higher than 3.7V.\\
The AC_OK pin is high when the AC source is available.\\
**

The BAT_OK and AC_OK signals are used in the below simple shell script which runs in the background via crontab.

<WRAP left round important 70%>
Before using UPS2 on ODROID-C2, please check u-boot version. \\
If the version of yours is the one before Mar 18 2016, update boot loader as following. \\
On Ubuntu release version "ver1.2" or higher, the control routine for ups2 port will be applied.

Click the following site to download boot loader 
  * [[http://dn.odroid.com/S905/BootLoader/ODROID-C2/c2_bootloader.tar.gz|Download]]
<code>
$ tar zxvf c2_bootloader.tar.gz
$ cd c2_bootloader
$ ./sd_fusing.sh <device/path/of/your/card>
</code>
</WRAP>

==== Auto shutdown Script ====
This script checks the status of power and battery.\\
Save the following code as ups2.sh in home directory.\\ 
Note that this script can be used with U3 as well as C1/C2 without modification.\\
<code>
#!/bin/sh
MODEL=$(cat /proc/cpuinfo | grep ^Hardware | awk -F " " '{print $3}')
SYSFS_GPIO_DIR="/sys/class/gpio"

retval=""

gpio_export()
{
        [ -e "$SYSFS_GPIO_DIR/gpio$1" ] && return 0
        echo $1 > "$SYSFS_GPIO_DIR/export"
}

gpio_getvalue()
{
	echo in > "$SYSFS_GPIO_DIR/gpio$1/direction"
        val=`cat "$SYSFS_GPIO_DIR/gpio$1/value"`
        retval=$val
}

gpio_setvalue()
{
	echo out > "$SYSFS_GPIO_DIR/gpio$1/direction"
        echo $2 > "$SYSFS_GPIO_DIR/gpio$1/value"
}

if test $MODEL = "ODROIDC"
then
        AC_OK_GPIO=88
        BAT_OK_GPIO=116
	LATCH_GPIO=115
	gpio_export $LATCH_GPIO 
	gpio_setvalue $LATCH_GPIO 1
elif test $MODEL = "ODROID-C2"
then
        AC_OK_GPIO=247
        BAT_OK_GPIO=239
	LATCH_GPIO=225
	gpio_export $LATCH_GPIO 
	gpio_setvalue $LATCH_GPIO 1
else 
        AC_OK_GPIO=199
        BAT_OK_GPIO=200
fi

gpio_export $AC_OK_GPIO
gpio_export $BAT_OK_GPIO
gpio_getvalue $AC_OK_GPIO
if [ $retval -eq  1 ]
then
        echo "DC Input Okay"
else
        echo "Power is shutdown or AC Adaptor is disconnected"
        gpio_getvalue $BAT_OK_GPIO
        echo $retval
        if [ $retval -eq 0 ]
        then
                echo "battery is low than 3.7V"
                if test $MODEL = "ODROID-C2"
                then
                        /sbin/poweroff
                else
                        /sbin/shutdown -P 1
                fi

        else
                echo "battery is good"
        fi
fi
</code>

Give execute permission to everybody with following command.
<code>
sudo chmod a+x ups2.sh
</code>
==== Cron setup ====
 
This can be set up by running: <wrap hi>**$ sudo crontab -e**
</wrap>
<code>
# m h  dom mon dow   command
*/2 * * * * /home/odroid/ups2.sh
</code>

The script will run every 2 minutes.

To test the hardware/software setup, unplug the power source from the UPS2.
After 2 minutes and 1 second, the ODROID will start the shutdown process automatically.

<WRAP left round important 70%>
Depending on the particular Battery State of Charge (SOC), this script can issue a reboot a few times based on the specific load.\\
This means that the battery voltage can go over the threshhold level very quickly when the load is off.\\
However, it will turn off the board after cycling the power a few times.
</WRAP>

===== Android =====
==== ODROID-U3 ====
Check to existence of /dev/class/gpio/ directory.

If you can not find node, Upgrade the OS 4412_v4.9 version or higher.


/system/bin/ups2.sh
-------------------------------------------------------------------------------------------------------------------
<file>
#!/bin/sh
SYSFS_GPIO_DIR="/sys/class/gpio"

retval=""

gpio_export()
{
       [ -e "$SYSFS_GPIO_DIR/gpio$1" ] && return 0
       echo $1 > "$SYSFS_GPIO_DIR/export"
       echo $1
}

gpio_getvalue()
{
       echo in > "$SYSFS_GPIO_DIR/gpio$1/direction"
       val=`cat "$SYSFS_GPIO_DIR/gpio$1/value"`
       retval=$val
}

gpio_setvalue()
{
       echo out > "$SYSFS_GPIO_DIR/gpio$1/direction"
       echo $2 > "$SYSFS_GPIO_DIR/gpio$1/value"
}

AC_OK_GPIO=199
BAT_OK_GPIO=200
LATCH_GPIO=204
gpio_export $LATCH_GPIO 
gpio_setvalue $LATCH_GPIO 1

check()
{
        gpio_export $AC_OK_GPIO
        gpio_export $BAT_OK_GPIO
        gpio_getvalue $AC_OK_GPIO

        if [ $retval -eq  1 ]
        then
               echo "DC Input Okay"
        else
               echo "Power is shutdown or AC Adaptor is disconnected"
               gpio_getvalue $BAT_OK_GPIO
               echo $retval
               if [ $retval -eq 0 ]
               then
                      echo "battery is low than 3.7V"
                      poweroff -d 5
               else
                      echo "battery is good"
               fi
        fi
}

while true
do check
sleep 2
done
</file>

Enable UPS service in /init.odroidu[x2].rc
<code>
shell@odroidu:/ $ su                                                           
1|root@odroidu:/ # mount -o rw,remount /                                       
[  298.823337] EXT4-fs (mmcblk0p2): re-mounted. Opts: (null)
root@odroidu:/ # vi /init.odroidu.rc
</code>

<code>
service ups /system/bin/ups2.sh                       
    class core                           
    user root                                                                
    group root                                                      
#    disabled                                                                
    oneshot 
</code>

<code>                                                           
Power is shutdown or AC Adaptor is disconnected                              
1                                                                            
battery is good                                                              
Power is shutdown or AC Adaptor is disconnected                              
1                                                                            
battery is good                                                              
Power is shutdown or AC Adaptor is disconnected                              
1                                                                            
battery is good                                                              
Power is shutdown or AC Adaptor is disconnected                              
0                                                                            
battery is low than 3.7V                                                      
[   88.089377] SysRq : Emergency Remount R/O                                  
[   88.093736] EXT4-fs (mmcblk0p2): re-mounted. Opts: (null)                  
[   88.099412] EXT4-fs (mmcblk0p3): re-mounted. Opts: (null)                  
[   88.105858] EXT4-fs (mmcblk0p4): re-mounted. Opts: (null)                  
[   88.112916] Emergency Remount complete                                    
[   88.191188] exynos4_notifier_call : System Rrestart notifier call!        
[   88.191714] exynos4_notifier_call : Done!                                  
[   88.195726] REBOOT Notifier for CPUFREQ                                    
[   88.200303] Disabling non-boot CPUs ...                                    
[   88.204077] CPU1: shutdown                                                
[   88.206946] CPU2: shutdown                                                
[   88.209279] CPU3: shutdown                                                
[   88.211703] Restarting system.
</code>

===== Tip for servo or motor driving application =====
**Reported by Ameridroid**

While developing a walking robot that uses the UPS2-C1, we found the UPS2 would shut off while moving servos after only a few minutes. We were led to this modification that WILL void your UPS2 warranty, but will likely solve your issues.

Without this modification, **we would get less than a few minutes of runtime out of our walking robot. After the modification, we could get over an hour.**

[[http://forum.odroid.com/viewtopic.php?f=115&t=17095#p111720|ODROID FORUM]]

You can find a nice video in the above link that explains how to mod the UPS2 board.