Skip to content

Latest commit

 

History

History
75 lines (56 loc) · 2.11 KB

README.md

File metadata and controls

75 lines (56 loc) · 2.11 KB

OpenIPC logo

OSD

An all-in-one daemon that exposes an HTTP frontend to

  • adjust settings ;
  • manage OSD regions ;
  • stream AV content on supported IP cameras

Installation

Example of a quick test setup for SigmaStar processors:

curl -s -L https://github.com/OpenIPC/osd/releases/download/latest/osd-star -O
chmod 755 osd-star

The Buildroot package is ready; the resulting file will be called "osd_server":

make BOARD=ssc338q_lite br-osd-openipc
make BOARD=gk7205v200_lite br-osd-openipc
make BOARD=hi3516ev300_lite br-osd-openipc

Examples

Parameters for each region can be passed in one or many calls:

curl "192.168.1.17:9000/api/osd/0?font=comic&size=32.0&text=Frontdoor"
curl 192.168.1.17:9000/api/osd/0?posy=72

N.B. Ampersands require the address to be enclosed with double quotes under Windows or to be escaped with a backslash under Unix OSes

Supported fonts (sourced from /usr/share/fonts/truetype/) can render Unicode characters:

curl 192.168.1.17:9000/api/osd/0?text=Entrée

Empty strings are used to clear the regions:

curl 192.168.1.17:9000/api/osd/1?text=

Specifiers starting with a dollar sign are used to represent real-time statistics:

curl 192.168.1.17:9000/api/osd/1?text=$B%20C:$C%20M:$M

N.B. Spaces have to be escaped with %20 in curl URL syntaxes

Showing the time and customizing the time format is done this way:

curl 192.168.1.17:9000/api/time?fmt=%25Y/%25m/%25d%20%25H:%25M:%25S
curl 192.168.1.17:9000/api/osd/2?text=$t&posy=120

N.B. Percent signs have to be escaped with %25 in curl URL syntaxes

UTC date and time can be set using Unix timestamps:

curl 192.168.1.17:9000/api/time?ts=1712320920

Bitmap files (.bmp) can be uploaded to a region using this command:

curl -F data=@.\Desktop\myimage.bmp 192.168.1.17:9000/api/osd/3

N.B. curl already implies "-X POST" when passing a file with "-F"

Technical support and donations

Please support our project with donations or orders for development or maintenance. Thank you!