1.\" $OpenBSD: upd.4,v 1.5 2020/05/12 13:03:52 schwarze Exp $ 2.\" 3.\" Copyright (c) 2014 Andre de Oliveira <andre@openbsd.org> 4.\" 5.\" Permission to use, copy, modify, and distribute this software for any 6.\" purpose with or without fee is hereby granted, provided that the above 7.\" copyright notice and this permission notice appear in all copies. 8.\" 9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 16.\" 17.Dd $Mdocdate: May 12 2020 $ 18.Dt UPD 4 19.Os 20.Sh NAME 21.Nm upd 22.Nd USB Power Devices sensor 23.Sh SYNOPSIS 24.Cd "upd* at uhidev?" 25.Sh DESCRIPTION 26The 27.Nm 28driver provides support for monitoring various sensors provided by 29USB Power Devices (such as a UPS). 30Supported sensor values are made available via the 31.Xr sysctl 8 32interface. 33.Pp 34The following sensors are supported by the driver: 35.Pp 36.Bl -item -offset indent -compact 37.It 38BatteryPresent 39.It 40ShutdownImminent 41.It 42ACPresent 43.It 44Overload 45.It 46RelativeStateOfCharge 47.It 48AbsoluteStateOfCharge 49.It 50RemainingCapacity 51.It 52FullChargeCapacity 53.It 54Charging 55.It 56Discharging 57.It 58AtRateTimeToFull 59.It 60AtRateTimeToEmpty 61.It 62RunTimeToEmpty 63.It 64NeedReplacement 65.El 66.Sh SEE ALSO 67.Xr intro 4 , 68.Xr uhidev 4 , 69.Xr sensorsd.conf 5 , 70.Xr sensorsd 8 , 71.Xr sysctl 8 72.Pp 73The USB Power Devices specification can be found at: 74.Lk https://www.usb.org/hid 75.Sh HISTORY 76The 77.Nm 78driver first appeared in 79.Ox 5.6 . 80.Sh AUTHORS 81The 82.Nm 83driver was written by 84.An Andre de Oliveira . 85.Sh BUGS 86The 87.Nm 88driver does not indicate device health via aggregate or 89individual sensor status. 90Users who wish to monitor 91.Nm 92status using 93.Xr sensorsd 8 94must manually establish 95.Dq high 96and 97.Dq low 98limits for sensor values of interest via 99.Xr sensorsd.conf 5 . 100