ALFATRON IPK1HE,IPK1HD AV Over IP Encoder and Decoder User Guide
- August 29, 2024
- ALFATRON
Table of Contents
- Overview
- Settings for both TX (Encoder) and RX (Decoder)
- Settings only for TX (Encoder)
- Settings only for RX (Decoder)
- Source selection
- RS232 Source selection
- Video stream settings
- Video wall settings
- Output resolutions settings
- CEC control
- Audio mute control
- Audio delay control
- OSD control
- Sink’s EDID information
- Stream Rotate
- Eliminate display border
- Audio volume control
- PNG settings
- ‘NO SOURCE’ image settings
- osd show
- Only for TX
- Only for RX
- Read User Manual Online (PDF format)
- Download This Manual (PDF format)
**ALFATRON IPK1HE,IPK1HD AV Over IP Encoder and Decoder User Guide
**
Overview
Some API commands are based on Telnet and Http, others are based on multicast or unicast over UDP. This guide only describes the former, most of them are just setting or getting commands.
Telnet Port Number;
Connection Type | Telnet |
---|---|
Port No. | 24 |
User Name | root |
Password |
Settings for both TX (Encoder) and RX (Decoder)
IP Address Settings
Commands:
gbparam s ip_mode IPMODE
gbparam s ipaddr IPADDR
gbparam s netmask NETMASK
Description:
IPMODE| The IP mode. Value is “autoip”, “static”, or “dhcp”.
Default value is “autoip”.
---|---
IPADDR| The IP address, like 169.254.9.9.
NETMASK| The subnet mask, like 255.255.0.0
Note
Reboot the device for the settings above to take effect. You can do this by using the busybox reboot command.
Parameter update
Command
gbparam s PARAM VALUE
Description:
PARAM | The parameter’s name |
---|---|
VALUE | The parameter’s value |
Note: The parameter’s name and value can only contain characters “0-9”, “A-Z”, “a-z” and underscore (_).
Serial control
a) Serial parameter setting
Command
soip2 -S -b RS232-PARAM
Description
-S | Just means set the parameter |
---|---|
RS232-PARAM | Format: b-dps |
b baud rate
d | data bits | |
---|---|---|
p | parity | |
s | stop bit |
b) Obtain the serial parameter setting.
Command:
soip2 -G
Response:
- baud rate: BAUD-RATE
- data bits: DATA-BITS
- parity type: PARITY
- stop bits: STOP_BITS
- HEX mode: HEX
Description:
-G | Just means get the serial parameter |
---|---|
BAUD-RATE | Baud rate |
DATA-BITS | Data bits |
PARITY | Parity |
STOP-BITS | Stop bits |
HEX | Hex mode, “true” or “false” |
c) Send serial content
Command:
soip2 -f /dev/ttyS0 -b RS232-PARAM [-r] [-n] -s “CONTENT”
Description:
RS232-PARAM| Format:
b
| b-dps
baud rate
---|---|---
d| data bits
p| parity
s| stop bit
[-r]| Attach a
[-n]| Attach a
“CONTENT”
CONTENT| The RS232 content you want to send
Reset to factory default
Command: reset_to_default.sh
Linux busybox command
Use the common busybox commands.
Obtain the parameter value of the gbparam command
Command: gbparam g PARAM
Response: VALUE
Description:
PARAM | The parameter’s name |
---|---|
VALUE | The parameter’s value. If the “PARAM” is not given, |
“VALUE” is “‘PARAM’ not defined”
Obtain the parameter value of the gbconfig command
Command: gbconfig –show PARAM
Response: VALUE
Description:
PARAM | The parameter’s name |
---|---|
VALUE | The parameter’s value |
Obtain the parameter value of the gbset command
Command: gbget PARAM
Response: VALUE
Description:
PARAM | The parameter’s name |
---|---|
VALUE | The parameter’s value |
IGMP autonomous report settings
Command: gbparam s igmp_interval INTERVAL
Description:
INTERVAL | Report interval, the range is [0, 600] seconds. 0 means never. |
---|
Note:
Reboot the device for the settings above to take effect. You can do this by using the busybox reboot command.
RS232_Mode
Command: gbparam s rs232_mode RS232MODE
Description:
RS232MODE | passthrough && feedback |
---|
Note: Reboot the device for the settings above to take effect. You can do this by using the busybox reboot command.
Settings only for TX (Encoder)
Video stream settings
a) H.264 stream settings
Commands:
gbconfig –enc-rc-mode= RCMODE
gbconfig –cbr-avg-bitrate= BITRATE
gbconfig –vbr-max-bitrate= BITRATE
gbconfig –vbr-min-qp= QP
gbconfig –vbr-max-qp= QP
gbconfig –fixqp-iqp= QP
gbconfig –fixqp-pqp= QP
gbconfig –enc-gop= GOP
gbconfig –enc-fps= FPS
gbparam s venc_big_stream_enable= ENABLE gbparam s pure_audio_stream_enable= ENABLE gbconfig –max-enc-res= RESOLUTION
gbparam s enc_mode H264
Note: To make all video stream settings take effect, use the e e_ reselect command.
Description:
RCMODE| H.264 rate control mode. Value is “vbr “ ,
“cbr “ , or “fixqp “.
---|---
BITRATE| H.264 stream bitrate. Value ranges from
| 128 to 30000. Its unit is “kbps”.
---|---
QP| H.264 QP value. Value ranges from 0 to 51
GOP| H.264 GOP. Value ranges from 1 to 65535.
DO not set a very big value for GOP.
FPS| H.264 frame rate. Value ranges from 1 to
ENABLE| Enable or disable the stream. “y”, enable.
“n”, disable.
RESOLUTION| Max encoding resolution. Values:
1920×1080 1280×720
H264| set the TX encoding h264 stream.
b) MJPEG stream HTTPURI and its settings
Commands:
HTTP
Meth od
| GET
---|---
URI| http://IP:PORT/stream?resolution= R E SOL U T I O N &fp
s= FPS &bitrate= BITRATE
Description:
RESLUTION| MJPEG resolution.
Value is “cif” (default) or “480P”.
---|---
FPS| MJPEG frame rate. Value ranges from 1 to 30
(default).
BITRATE| MJPEG stream bitrate. Value ranges from 128
to 2000. Its unit is “kbps”. Default value is
512. | |
---|---|
IP | The IP address of the device. |
--- | --- |
PORT | It is 80. |
Note: The query string of HTTP after quotation mark “?” is optional. If set, this configuration will affect all MJPEG streams.
Audio mute control
Command: gbconfig –line-out –mute=MUTE
Description:
MUTE| Mute or unmute the line-out audio. “y”, mute
“n”, unmute
---|---
Audio delay control
Commands:
- gbconfig –lipsync-audio-delay=LIPSYNC_DELAY
- gbconfig –audio-delay=DELAY
Description:
_LIPSYNCDELAY | Set delay for audio in [100, 500] ms, default |
---|---|
value is 100, this is used for system lip sync. | |
--- | --- |
DELAY | Set delay for audio in [0, 500] ms, default |
value is 0, this is used for intended purpose.
Note: The final audio latency is equal the sum of TX’s LIPSYNC_DELAY, TX’s DELAY, RX’s LIPSYNC_DELAY and RX’s DELAY.
EDID import
Command: setEDID -s “hex string”
Note:
setEDID -i filename. You can select the bin file
UNICAST&&MULTICAST
gbconfig –work-pattern=unicast/multicast
Audio lpcm&&aac
gbconfig –audio-enc-type=lpcm/aac
aac enc bitrate
gbconfig –audio-enc-bitrate=value[128/192/240 …]
Settings only for RX (Decoder)
Source selection
Commands:
gbset vi SOURCE
gbconfig –source-select= SOURCE
gbconfig –vsource-select= SOURCE
gbconfig –asource-select= SOURCE
e e_reconnect
Description:
- ‘gbconfig –vsource-select’ is same as ‘gbset vi’,
- ‘gbconfig –asource-select’ set the audio source selection, if dose not set
- ‘gbconfig –asource-select’, the audio selection will follow the video selection.
- ‘gbconfig –source-select’ set the video source and audio source at the same time.
SOURCE| TX MAC address. It does not include colons (:) such
as “341B22000001”.
---|---
Note:
The e e_reconnect command will connect a single RX to a new TX. If multiple RX
are required to be switched to several TX simultaneously, do not use this
command.
RS232 Source selection
Command:
gbconfig –ssource-select=SOURCE
Description:
‘gbconfig –ssource-select’set the RS232 source.
SOURCE| TX MAC address. It does not include colons (:) such as
“341B22000001”.
---|---
Video stream settings
Command:
gbconfig –low-delay=VALUE
Description:
VALUE| Set “y” to enable the low delay mode.
Set “n” to disable the low delay mode. (Default)
---|---
Video wall settings
Command:
e e_vw_enable_M_N_x_y
Description:
M | The VW has “M+1” rows. |
---|---|
N | The VW has “N+1” columns. |
x | The RX is in the row “x+1” of the VW. |
y | The RX is in the column “y+1” of the VW. |
--- | --- |
Output resolutions settings
Commands:
gbset fvo RESOLUTION
gbconfig –hdcp-method= HDCPMETHOD
gbparam s fource_output_color_space COLORSPACE
e e_reoutput
Description:
RESOLUTION| The output resolution.
Value must be set to the following. AUTO
1080P_60
1080P_50
1080P_30
1080P_25
1080P_24
720P_60
720P_50
576P_50
480P_60
640X480_60
800X600_60
1024X768_60
1280X720_60
1280X800_60
1280X1024_60
---|---
| 1366X768_60
1440X900_60
1600X1200_60
1920X1080_60
1920X540_60
---|---
HDCPMETHOD| HDCP policy method. Value is “follow” (default), “enable “ ,
or “disable “.
- follow: means that HDCP in output follows HDCP policy in input.
- enable: means that HDCP-encrypted content is always output.
- disable: means that non-HDCP encrypted content is always output.
COLORSPACE| The output color space. Value is “auto” (default), “yuv”, or “rgb”.
Note: After the “fource_output_color_space” parameter is set, the command e e_reoutput must be implemented to make the settings take effect.
CEC control
Commands:
- e e_cec_system_standby
- e e_cec_one_touch_play
- cec -s“ADDROPCODE; ADDROPCODE; …”
Description:
e e_cec_system_standby | Set the CEC display into standby mode. |
---|---|
e e_cec_one_touch_play | Turn on the CEC display immediately. |
ADDR OPCODE | “Addr” means source+dest address. |
“OPCODE” means CEC operation code.
Example:
cec -s “40 04”|
- “40”: “4” means source address, “0” means dest address.
- “04” means the image view on operation code.
---|---
cec -s “ff 36”|
- “ff” means the broadcast.
- “36” means the standby operation code.
Audio mute control
Commands:
- gbconfig –hdmi-out-audio –mute=MUTE
- gbconfig –line-out –mute=MUTE
Description:
MUTE | Mute or unmute the line-out audio. |
---|---|
y, mute |
n, unmute
---|---
Audio delay control
Commands
- gbconfig –lipsync-audio-delay=LIPSYNC_DELAY
- gbconfig –audio-delay=DELAY
Description:
_LIPSYNCDELAY| Set delay for audio in [100, 500] ms, default
value is 200, this is used for system lip sync.
---|---
DELAY| Set delay for audio in [0, 500] ms, default
value is 0, this is used for intended purpose.
Note: The final audio latency is equal the sum of TX’s LIPSYNC_DELAY, TX’s DELAY, RX’s LIPSYNC_DELAY and RX’s DELAY.
OSD control
Commands:
- gbparam s osd_disp_mode OSD_MODE
- osd_on.sh
- osd_off.sh
Description:
_OSDMODE| “follow” means when the video lost, OSD will follow the no source image, “independence” means OSD only display when command
osd_on.sh called.
---|---
osd_on.sh| Turn on the IP/Mac OSD information.
osd_off.sh| Turn off the IP/Mac OSD information in ‘independence’ mode or
when video is
displaying in ‘follow’ mode.
Note: After the “osd_disp_mode” parameter is set, the command e e_reconnect must be implemented to make the settings take effect
Sink’s EDID information
Command: cat /var/tmpfs/monitor_info
Stream Rotate
Command:
e e_vw_rotate_N
Note: N = 90 or 180 or 270
Note: After the “e e_vw_rotate_N” parameter is set, the command e e_reconnect must be implemented to make the settings take effect.
Eliminate display border
Command: e e_vw_moninfo_vw_ow_vh_oh
Note: After the “e e_vw_moninfo_vw_ow_vh_ohf” parameter is set, the command e e_reconnect must be implemented to make the settings take effect.
Audio volume control
Commands:
- gbconfig –hdmi-out-audio –level-up
- gbconfig –hdmi-out-audio –level-down
- gbconfig –hdmi-out-audio –level-control=LEVEL
- gbconfig –line-out –level-up
- gbconfig –line-out –level-down
- gbconfig –line-out –level-control=LEVEL
Description:
LEVEL | Range from -100 to 12 dB. |
---|
PNG settings
a) PNGuploadURI
Commands:
HTTP Method | POST |
---|---|
URI | http://IP:PORT/upload_png |
Description:
IP | The IP address of the device. |
---|---|
PORT | It is 80. |
b) PNG display control
Commands:
- gbconfig –png-overlay-pos-h=POSH
- gbconfig –png-overlay-pos-v=POSV
- gbconfig –png-overlay-enable=ENABLE
Note:
After change the PNG position, please send ‘gbconfig –png-overlay-enable=y’ to make the settingstake effect.
Description:
POSH | PNG image horizontal coordinates . [0, 1919] |
---|---|
POSV | PNG image vertical coordinates. [0, 1079] |
ENABLE | Enable or disable the stream. “y”, enable. |
“n”, disable.
‘NO SOURCE’ image settings
a) upload URI
Commands:
HTTP Method | POST |
---|---|
URI | http://IP:PORT/upload_bg |
Description:
IP | The IP address of the device. |
---|---|
PORT | It is 80. |
osd show
osd_show -o {INDEX} -s {CONTENT} -f {FONT} -p {POSITION} -c {INDEX}
For example: osd_show -o 1 -s “1234”
- o {INDEX}:open OSD show,INDEX is the corresponding serial number [1-7]
- s {CONTENT}: Displaysthe contents of the string
- f {FONT}:fontsize
- p {POSITION}: Displayed position
- c {INDEX}: close OSD show
Only for TX
HDCP setting
TX support HDCP in default, if need off the HDCP support。
command:gbconfig –hdcp-enable VALUE
Note:VALUE is y or n。
Example:
/ # gbconfig –hdcp-enable y
/ # gbconfig –show –hdcp-enable
y
/ #
Mute/Unmute analog audio command:
gbconfig –line-out –mute=MUTE
gbconfig –show –line-out –mute
Explaination: MUTE is y or n。
/ # gbconfig –line-out –mute=y
/ # gbconfig –show –line-out –mute
y
/ #
audio delay control
Command 1:
gbconfig –lipsync-audio-delay=LIPSYNC_DELAY
gbconfig –show –lipsync-audio-delay
Command 2:
gbconfig –audio-delay=DELAY
gbconfig –show –audio-delay
Explaination:
LIPSYNC_DELAY: value is [100,500], default is 200。unit:ms。
DELAY:value [0,500],default is 0。unit:ms。
Only for IP output audio stream,not for line out,the delay will be amount of
above two。
Example:
/ # gbconfig –lipsync-audio-delay=100
/ # gbconfig –show –lipsync-audio-delay
100
/ #gbconfig –audio-delay=100
/ #gbconfig –show –audio-delay
100
/ #
Only for RX
Mute/Unmute analog audio Command:
gbconfig –line-out –mute=MUTE
gbconfig –show –line-out –mute
Explaination: MUTE is y or n。
Exmple:
/ # gbconfig –line-out –mute=y
/ # gbconfig –show –line-out –mute
y
/ #
Analog audio level control Command:
gbconfig –line-out –level-up
gbconfig –line-out –level-down
gbconfig –line-out –level-control=LEVEL
gbconfig –show –line-out –level
Explaination:LEVEL range between -100 and 12dB。 。
Example:
/ # gbconfig –line-out –level-control=0
/ # gbconfig –line-out –level-up
/ # gbconfig –show –line-out –level
1
/ # gbconfig –line-out –level-down
/ # gbconfig –show –line-out –level
0
Mute/Unmute HDMI audio output Command:
gbconfig –hdmi-out-audio –mute=MUTE
gbconfig –show –hdmi-out-audio –mute
Explaination:MUTE is y or n。
Note:IPM4000 does not support。For IPD915V2,it will affect analog audio output at the same time。
Example:
/ # gbconfig –hdmi-out-audio –mute=y
/ # gbconfig –show –hdmi-out-audio
y
/ #
HDMI out audio level control Command:
gbconfig –hdmi-out-audio –level-up
gbconfig –hdmi-out-audio –level-down
gbconfig –hdmi-out-audio –level-control=LEVEL
gbconfig –show –hdmi-out-audio –level
Explaination: LEVEL range between -100 and 12dB。 Example:
/ # gbconfig –hdmi-out-audio –level-control=0
/ # gbconfig –show –hdmi-out-audio –level
0
/ # gbconfig –hdmi-out-audio –level-up
/# gbconfig –show –hdmi-out-audio –level
1
/ # gbconfig –hdmi-out-audio –level-down
/ # gbconfig –show –hdmi-out-audio –level
0
Audio delay control Command:
Command 1:
gbconfig –lipsync-audio-delay=LIPSYNC_DELAY
gbconfig –show –lipsync-audio-delay
command 2:
gbconfig –audio-delay=DELAY
gbconfig –show –audio-delay
Explanation:
LIPSYNC_DELAY:value is [100,500],default 200。unit:ms。
DELAY:value is [0,500],default 0。unit:ms。
These commands,for both HDMI out audio and line out,the delay will be amount
of two commands。
Command 1 adjust device driver buffer,command 2 adjust application buffer,so
command 2 is priority for use in setup。
Example:
/ # gbconfig –lipsync-audio-delay=100
/ # gbconfig –show –lipsync-audio-delay
100
/ #gbconfig –audio-delay=100
/ #gbconfig –show –audio-delay
100
/ #
http://www.alfatronelectronics.com/
Read User Manual Online (PDF format)
Read User Manual Online (PDF format) >>