Skip to content

Commit ebe8658

Browse files
authored
Merge pull request #136 from OpenIPC/docs/camera-report
docs: Camera report issue template
2 parents 63514a8 + b6d8c21 commit ebe8658

4 files changed

Lines changed: 187 additions & 3 deletions

File tree

Lines changed: 184 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,184 @@
1+
name: Camera report
2+
description: Report how OpenIPC Decoder plays a camera (IP camera, NVR channel, encoder, RTSP server)
3+
title: "[Camera]: "
4+
labels: ["camera-report"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for testing! Camera reports help other users and show which streams need work.
10+
**Remove the password from the URL** (write `user:***`) and do not post public IP addresses.
11+
The app version and build hash are shown in the menu next to **Exit**, for example `v1.28, 1dda076`.
12+
13+
- type: input
14+
id: manufacturer
15+
attributes:
16+
label: Manufacturer
17+
placeholder: "Hikvision, Dahua, XM (Xiongmai), OpenIPC board, ..."
18+
validations:
19+
required: true
20+
21+
- type: input
22+
id: model
23+
attributes:
24+
label: Model
25+
description: Model as printed on the label or shown in the camera's web interface
26+
placeholder: "DS-2CD1023G0-I, IPC-HFW1230S, SSC335 board, ..."
27+
validations:
28+
required: true
29+
30+
- type: dropdown
31+
id: firmware_kind
32+
attributes:
33+
label: Firmware
34+
options:
35+
- OpenIPC (Majestic)
36+
- OpenIPC (other streamer)
37+
- Stock / vendor firmware
38+
- Other
39+
validations:
40+
required: true
41+
42+
- type: input
43+
id: firmware_version
44+
attributes:
45+
label: Firmware version (optional)
46+
description: "OpenIPC: `cat /etc/os-release` or the web interface; vendor firmware: version and date"
47+
placeholder: "OpenIPC 2.6.10.12 lite / V5.5.0 build 180206"
48+
49+
- type: input
50+
id: soc
51+
attributes:
52+
label: Processor / SoC (optional)
53+
placeholder: "SigmaStar SSC335, HiSilicon Hi3516EV300, Goke GK7205V300, Ingenic T31, ..."
54+
55+
- type: input
56+
id: sensor
57+
attributes:
58+
label: Image sensor (optional)
59+
placeholder: "SC2336, IMX307, GC2053, ..."
60+
61+
- type: input
62+
id: url
63+
attributes:
64+
label: RTSP URL
65+
description: The URL that works in the app, with the password replaced by `***`. The path matters most (`/stream=0`, `/Streaming/Channels/101`, `/cam/realmonitor?channel=1&subtype=0`, ...)
66+
placeholder: "rtsp://admin:***@192.168.1.10:554/stream=0"
67+
validations:
68+
required: true
69+
70+
- type: textarea
71+
id: other_urls
72+
attributes:
73+
label: Other streams (optional)
74+
description: Substream, MJPEG or other paths of the same camera, one per line
75+
placeholder: |
76+
rtsp://admin:***@192.168.1.10:554/stream=1 — substream 704x576
77+
rtsp://admin:***@192.168.1.10:554/stream=2 — MJPEG
78+
79+
- type: dropdown
80+
id: video_codec
81+
attributes:
82+
label: Video codec
83+
multiple: true
84+
options:
85+
- H.264
86+
- H.265
87+
- MJPEG
88+
- Other
89+
validations:
90+
required: true
91+
92+
- type: input
93+
id: video_format
94+
attributes:
95+
label: Resolution, frame rate, bitrate (optional)
96+
placeholder: "1920x1080, 25 fps, 4 Mbit/s, key frame every 1 s"
97+
98+
- type: dropdown
99+
id: audio_codec
100+
attributes:
101+
label: Audio codec
102+
options:
103+
- No audio
104+
- AAC
105+
- Opus
106+
- G.711 (PCMU / PCMA)
107+
- L16 / PCM
108+
- G.726
109+
- Other / unknown
110+
111+
- type: checkboxes
112+
id: transports
113+
attributes:
114+
label: Transports that work
115+
description: Menu → slot URL dialog (single view) → TCP / UDP / Auto / Multicast; "UDP push" = the camera sends RTP to a `udp://` slot or the U cell
116+
options:
117+
- label: TCP
118+
- label: UDP
119+
- label: Auto
120+
- label: Multicast
121+
- label: UDP push (udp:// slot / U cell)
122+
123+
- type: dropdown
124+
id: auth
125+
attributes:
126+
label: Authentication
127+
options:
128+
- None
129+
- Basic
130+
- Digest
131+
- Credentials in the URL path (e.g. user=…_password=…)
132+
- Unknown
133+
134+
- type: checkboxes
135+
id: limits
136+
attributes:
137+
label: Camera limits
138+
options:
139+
- label: Accepts only one RTSP client at a time
140+
- label: Needs a reconnect after the camera reboots (the app does not recover by itself)
141+
142+
- type: input
143+
id: app_device
144+
attributes:
145+
label: App version and device
146+
description: App version from the menu, and the device it ran on
147+
placeholder: "v1.28, 1dda076 on AG-216 (Android 10)"
148+
validations:
149+
required: true
150+
151+
- type: dropdown
152+
id: result
153+
attributes:
154+
label: Overall result
155+
options:
156+
- Works
157+
- Works with issues
158+
- Does not work
159+
validations:
160+
required: true
161+
162+
- type: checkboxes
163+
id: works
164+
attributes:
165+
label: What works
166+
options:
167+
- label: Picture in single view
168+
- label: Picture in multi-view
169+
- label: Audio
170+
- label: WebUI
171+
- label: Debug page shows the stream (http://<device>:8085/)
172+
173+
- type: textarea
174+
id: comment
175+
attributes:
176+
label: Comment (optional)
177+
description: Anything that did not work or looked wrong, settings you had to change on the camera, delay, picture artefacts, ...
178+
179+
- type: textarea
180+
id: logs
181+
attributes:
182+
label: Log (optional)
183+
description: "With USB/network debugging enabled: `adb logcat -d -s OpenIPCDecoder`, or `http://<device>:8085/log`. Check that no password is in it."
184+
render: text

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ Network, video decoding and audio run on separate threads, so a slow decoder nev
227227

228228
## Device compatibility
229229

230-
Tested the app on your device? Please [**submit a Device report**](https://github.com/OpenIPC/decoder/issues/new?template=device_report.yml). It takes a minute and helps other users.
230+
Tested the app on your device? Please [**submit a Device report**](https://github.com/OpenIPC/decoder/issues/new?template=device_report.yml). It takes a minute and helps other users. Tested a camera? [**Submit a Camera report**](https://github.com/OpenIPC/decoder/issues/new?template=camera_report.yml): manufacturer, model, RTSP URL (without the password), codecs and what works.
231231

232232
### Verified devices
233233

‎README.ru.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ export KEY_PASS=your_key_password
227227

228228
## Совместимость с устройствами
229229

230-
Проверили приложение на своём устройстве? [**Отправьте Device report**](https://github.com/OpenIPC/decoder/issues/new?template=device_report.yml) — это займёт минуту и поможет другим пользователям.
230+
Проверили приложение на своём устройстве? [**Отправьте Device report**](https://github.com/OpenIPC/decoder/issues/new?template=device_report.yml) — это займёт минуту и поможет другим пользователям. Проверили камеру? [**Отправьте Camera report**](https://github.com/OpenIPC/decoder/issues/new?template=camera_report.yml): производитель, модель, адрес RTSP (без пароля), кодеки и что работает.
231231

232232
### Проверенные устройства
233233

‎README.zh-CN.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ export KEY_PASS=your_key_password
227227

228228
## 设备兼容性
229229

230-
在您的设备上测试过本应用?请[**提交 Device report**](https://github.com/OpenIPC/decoder/issues/new?template=device_report.yml),只需一分钟,可以帮助其他用户。
230+
在您的设备上测试过本应用?请[**提交 Device report**](https://github.com/OpenIPC/decoder/issues/new?template=device_report.yml),只需一分钟,可以帮助其他用户。 测试过某款摄像机?请[**提交 Camera report**](https://github.com/OpenIPC/decoder/issues/new?template=camera_report.yml):厂商、型号、RTSP 地址(去掉密码)、编码以及哪些功能正常。
231231

232232
### 已验证设备
233233

0 commit comments

Comments
 (0)