MicroDowell SpA / via dei Boschi, Pradamano (UD) Italy Rev. 3.3.1 22/09/2000 Elio Corbolante English translation from original document (Italian)
MicroUPS RS232 protocol specification
1. Protocol description + Interface specification
This protocol enables the communication between a master (PC) and a slave (UPS). The hardware communication protocol is: RS232 + no handshaking protocol Half Duplex baud rate: 1200 bps; char length: 8 bit; stop bit: 2 (do not use 1 stop bit); NO parity. You cant change the speed or bit parameters.
2. UPS models and firmware versions
There are some differences between the various models and firmware versions: here follows a table with the most important changes: Model B-Box Interactive B-Box Interactive B-Box Sharing (H) B-Box Sharing (H) B-Box Sharing (H) Firmware version 0 n 2.1 n > 2.n < 3.0 3.0 n 3.3 n 4.0 Note - BEND command not available - temperature field void - ratio of turn-off delay: 1:1 - temperature field void - ratio of turn-off delay: 1:2 - extended protocol (Iout + Vout) - BEND command not available - temperature field valid - extended protocol (Iout + Vout) - temperature field valid - standard protocol - Iout temperature / NO Vout - ratio of turn-off delay: 1:4 (n 3.0)

MICRODOWELL

Pag. 1
3. Protocol specification
The protocol is binary (characters from 0x00 to 0xff) where the Master (PC) always starts the communication with the slave (UPS). There is no checksum on the data packet sent and received.
3.1 Format of the commands sent to the UPS
The commands have variable length and have the following structure: Byte Name CMD PARM Value Note Command sent to the UPS [optional] Parameters: the length can be from 0 to 5 byte
The byte sent after CMD is variable and can range from 0 to 5. The UPS identifies the following commands (CMD): CMD POLL TIMER SCHED STDBY B_END B_TEST BUZZ MODEL Value 0x30 / 0 0x31 / 1 0x32 / 2 0x33 / 3 0x34 / 4 0x35 / 5 0x36 / 6 0x3A / : Description asks to the UPS the working parameters (voltage, temp, freq., ) TIMER CALIBRATION: sets the internal clock of the UPS SCHEDULING: sets the turning ON/OFF parameters of the UPS STAND-BY: switch the UPS in Standby mode 1 BATTERY END: sets the UPS in Battery End mode BATTERY TEST: switch the UPS in battery mode (5 sec.) BUZZER SILENCING: silence the buzzer UPS MODEL: identifies the UPS model

POLLING:

This following models do not support this command: B-Box Interactive: firmware release 2.1 B-Box Sharing: firmware release 3.0

Pag. 2

3.1.1 Polling command
Byte 0 Nome POLL Valore 0x30 / 0
Note asks to the UPS the working parameters (state, voltages, )
This command asks to the UPS the working parameters. Each kind of UPS will send a different data record (grayed out rows mean differences between the various UPSs):
B-Box Interactive firmware versions 2.1
Byte 2 Name STRT_F FRID STAT Value 0x5B / [ 0x01 / ^A Note Frame start character Frame ID always 0x01 UPS status:
bit 0: bit 1: bit 2: bit 3: bit 4: bit 5: bit 6: bit 7: battery mode: battery low battery discharged Stand-By mode high temperature temperature warning mains absence output frequency: 0=OFF / 1=ON 0=OFF / 1=ON 0=OFF / 1=ON 0=OFF / 1=ON 0=OFF / 1=ON 0=OFF / 1=ON 0=mains ON / 1=mains OFF 0 = 60Hz / 1 = 50Hz

VINP VBAT

Vinp Vbatt
Mains mean input voltage: VINP (V) = Vinp * 1.692 Battery voltage: VBAT (V) = Vbatt * n where:

TEMP HOUR_WK

Temp Hour_Wk
MIN SEC HOUR_ON MIN_ON HOUR_OFF DSHTDN RTL RTH END_F

DShtdn RtL RtH 0x5d / ]

n = 1 for 300/500 VA UPSs or n = 2 800/1000 VA UPSs Temperature: TEMP (C) = (Temp 51) * 3.005 UPS internal clock: made by Hour and Day of the week: Hour = Hour_Wk MOD 24 Day = INT(Hour_Wk / 24) Where Day: 0=Monday / 2=Tuesday / / 6 = Sunday UPS internal clock: Minutes UPS internal clock: Seconds UPS Turn ON: Hour UPS Turn ON: Minutes UPS Turn OFF: Hour Shutdown delay (seconds): DSHTDN = DShtdn Mains frequency (Hz): the formula is:
Fin = 212 * 15 (255 RtH ) * 256 +(256 RtL)

Frame closing character

Pag. 3
B-Box Interactive firmware versions > 2.1

Mains mean input voltage: VINP (V) = Vinp * 1.84 Battery voltage: VBAT (V) = Vbatt * n where:

HOUR_WK

Hour_Wk
n = 1 for 300/500 VA UPSs or n = 2 800/1000 VA UPSs Reserved UPS internal clock: made by Hour and Day of the week: Hour = Hour_Wk MOD 24 Day = INT(Hour_Wk / 24) where Day: 0=Monday / 2=Tuesday / / 6 = Sunday UPS internal clock: Minutes UPS internal clock: Seconds UPS Turn ON: Hour UPS Turn ON: Minutes UPS Turn OFF: Hour Shutdown delay (seconds): DSHTDN = DShtdn * 2 Mains frequency (Hz): the formula is:

Pag. 4

B-Box Sharing (H) firmware versions 3.3 (extended protocol)
Byte 2 Name STRT_F FRID STAT Valore 0x5B / [ 0x01 / ^A Note Frame start character Frame ID always 0x01 UPS status:

Temp Ora_Wk

MIN SEC HOUR_ON MIN_ON HOUR_OFF DSHTDN RTL RTH IOUT

DShtdn RtL RtH Iout

n = 1 for 300/500 VA UPSs or n = 2 800/1000 VA UPSs Temperature: TEMP (C) = (Temp 51) * 3.005 UPS internal clock: made by Hour and Day of the week: Hour = Hour_Wk MOD 24 Day = INT(Hour_Wk / 24) where Day: 0=Monday / 2=Tuesday / / 6 = Sunday UPS internal clock: Minutes UPS internal clock: Seconds UPS Turn ON: Hour UPS Turn ON: Minutes UPS Turn OFF: Hour Shutdown delay in seconds: IF firmware release 3.0: DSHTDN= DShtdn * 2 IF firmware release > 3.0: DSHTDN= DShtdn * 4 Mains frequency (Hz): the formula is:
Output current (%): this value is relative to the UPS capacity (W or V/A). It is calculated using the following table: Iout Load % 0 Iout 3 < Iout 10 < Iout 22 < Iout 37 < Iout Iout > IF 47 < Iout 155 for more than 1.5 s, or Iout > 155 for more than 480 ms, the UPS will disconnect the load because the UPS is in overload mode. Output voltage: VOUT = Vout * 1.692 (with a 15% error) Frame closing character

Vout 0x5d / ]

Pag. 5
B-Box Sharing (H) firmware versions > 3.3
Byte 2 Nome STRT_F FRID STAT Valore 0x5B / [ 0x01 / ^A Note Frame start character Frame ID always 0x01 UPS status:
n = 1 for 300/500 VA UPSs or n = 2 800/1000 VA UPSs Output current (%): this value is relative to the UPS capacity (W or V/A). It is calculated using the following table: Iout Load % 0 Iout 3 < Iout 10 < Iout 22 < Iout 37 < Iout Iout > IF 47 < Iout 155 for more than 1.5 s, or Iout > 155 for more than 480 ms, the UPS will disconnect the load because the UPS is in overload mode. UPS internal clock: made by Hour and Day of the week: Hour = Hour_Wk MOD 24 Day = INT(Hour_Wk / 24) where Day: 0=Monday / 2=Tuesday / / 6 = Sunday UPS internal clock: Minutes UPS internal clock: Seconds UPS Turn ON: Hour UPS Turn ON: Minutes UPS Turn OFF: Hour Shutdown delay in seconds = DShtdn * 4 Mains frequency (Hz): the formula is:

Fing = 212 * 15 (255 RtH ) * 256 +(256 RtL)

Pag. 6

3.1.2 Timer Calibration command
Note sets the internal clock of the UPS Hour and Day of the week; the value follows the rule: Hour_Week = Hour + 24 * Day where Day: 0=Monday / 1=Tuesday / / 6 = Sunday 2 MIN Min Minutes 3 SEC Sec Seconds This command sets the internal clock of the UPS. The clock is weekly, so on the rollover between Sunday and Monday it will restart at 0:00 and day 0 (Monday).

TIMER CALIBRATION:

Byte 0 1

Nome TIMER HOUR_WK

Valore 0x31 / 1 Hour_Week

3.1.3 Scheduling

Byte Nome SCHED HOUR_ON Valore 0x32 / 2 Hour_On Note sets the automatic turn ON/OFF of the UPS Hour and Day of the week when the UPS will turn itself ON; the value follows the rule: Hour_On = Hour + 24 * Day where Day: 0=Monday / 1=Tuesday / / 6 = Sunday Minutes (when the UPS will turn itself ON) Hour and Day of the week when the scheduling will end; the value follows the rule: Hour_Off = Hour + 24 * Day where Day: 0=Monday / 1=Tuesday / / 6 = Sunday Delay in seconds after which the UPS will Shutdown (after receiving the Shutdown command (STDBY)) This value depends on the UPS model and its firmware revision: B-Box Interactive 2.1 DSHTDN (sec) = DShtdn B-Box Interactive > 2.1 DSHTDN (sec) = DShtdn * 2 B-Box Sharing 3.0 DSHTDN (sec) = DShtdn B-Box Sharing > 3.0 DSHTDN (sec) = DShtdn * 4 Day_Wk can assume the following values: 0x31 / 1 = Daily Scheduling (UPS dont use weekday) 0x30 / 0 = Weekly Scheduling (UPS use weekday)

SCHEDULING:

MIN_ON HOUR_OFF

Min_On Hour_Off

DSHTDN

DShtdn

DAY_WK

Day_Wk

Daily scheduling
The UPS is set to turn ON EVERY day at the same time. The variables Day, Day_Wk and Hour_Off will be set to: Day = Hour_Off = 0 Day_Wk = 0x31 / 1 Daily schedule

Weekly scheduling

The UPS is set to turn ON for n consecutive days (of the week). The first day is set in the variables Hour_On and Min_On. The UPS vill not turn ON if: Hour_On > Hour_Off. example: Turn ON the UPS at 8:30 in days between Tuesday(1) and Friday(5). Hour_On = 8 + 24 * 1 Min_On = 30 Hour_Off = 10 + 24 * 5 which is > than 9:00 of Friday (8 + 24 * 5) Day_Wk = 0x30 / 0 weekly scheduling At the scheduled turn ON, if mains is good present, the UPS will power the load; otherwise, it will switch in the B_END state, waiting for the mains.

Schedule disabling

To disable the scheduling, send a schedule with the following parameters: Hour_On = Hour_Off = 255 Min_On = 0 Its better to leave the other parameters equal to those read using the POLL command.

Pag. 7

3.1.4 Stand-By mode
Byte 0 Nome STDBY Valore 0x33 / 3

STAND-BY:

Note the UPS will switch in the Stand-By mode
The UPS will wait for a DSHDWN time (SCHED) before switching to Stand-By mode.
3.1.5 B-End (battery end) mode
Byte 0 Nome B_END Valore 0x34 / 4

BATTERY END:

Note the UPS will switch to Battery End mode
The UPS will switch in this state ONLY if it has previously received a Stand-By command. If you want to use this command, you will need to send the two commands: STDBY + B_END. This command is NOT available on UPS with the following firmware versions: B-Box Interactive 2.1 B-Box Sharing 3.0 When the UPS will switch in B-End mode, the LEDs will start to blink altogether, waiting for the return of the mains. Only with the return of the mains the UPS will turn ON the load.

3.1.6 Battery Test

Byte 0 Nome B_TEST Valore 0x35 / 5

BATTERY TEST:

Note the UPS will switch to Battery Test mode (5 sec.)
At the end of test, UPS model with the following versions of firmware: B-Box Interactive 5.0 B-Box Sharing 4.0 Will send a data packet with model and firmware version like using the command MODEL.

3.1.7 Buzzer silencing

Byte 0 Nome BUZZ Valore 0x36 / 6

TACITAZIONE BUZZER:

Note The buzzer will be silenced

3.1.7 UPS model

Byte 0 Nome MODEL Valore 0x3A / :

MODELLO UPS:

Note query of the UPS model
The UPS will answer with an 8 byte packet: Byte 23 Nome STRT_F LF MODEL Valore 0x5B / [ 0x0A / ^J Note Frame start character Frame ID always 0x0A UPS model: 2 characters: B5 = B-Box Interactive firmware 5.0 MD = B-Box Interactive firmware < 5.0 SH = B-Box Sharing Firmware version: with format M.m, where: M = major version m = minor version Frame closing character

0x5d / ]

Pag. 8