Skip to content

Commit 42c84e1

Browse files
corrected docs error
1 parent a93ba2f commit 42c84e1

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -62,63 +62,63 @@ sets the credentials used to access the camera.
6262

6363
Sets the sensitivities for motion detection and audio detection. Both take values between 0 (off) and 100 (sensitive).
6464

65-
- `async_reboot(self) -> Response`<br>
65+
- `async_reboot() -> Response`<br>
6666
reboots the camera.
6767

68-
- `async_set_system_time(self) -> Response`<br>
68+
- `async_set_system_time() -> Response`<br>
6969
sets the current local time on the camera. This is used for overlays in the snapshots and feeds.
7070

71-
- `async_set_irled(self, status: Status) -> Response`<br>
71+
- `async_set_irled(status: Status) -> Response`<br>
7272
sets the status of the active infrared light on the camera. Valid settings are `Status.ON', `Status.OFF`, and `Status.AUTO`
7373

74-
- `async_set_night_mode(self, status: Status) -> Response`<br>
74+
- `async_set_night_mode(status: Status) -> Response`<br>
7575
sets the status of the passive infrered sensor. Valid settings are `Status.ON', `Status.OFF`, and `Status.AUTO`
7676

77-
- `async_set_ftp_config(self, server, port, user, passwd) -> Response`<br>
77+
- `async_set_ftp_config(server, port, user, passwd) -> Response`<br>
7878
configures the ftp client to allow snapshots and recordings to be stored on a server via FTP.
7979

80-
- `async_set_audio_volumes(self, audio_in=50, audio_out=50) -> Response`<br>
80+
- `async_set_audio_volumes(audio_in=50, audio_out=50) -> Response`<br>
8181
configures audio volumes for the camera:
8282
- audio_in: microphone volume
8383
- audio_out: speaker and alert volume
8484

8585
### Device Queries
86-
- `async_get_model(self) -> str`<br>
86+
- `async_get_model() -> str`<br>
8787
queries and returns the brand's model number as a string
8888

89-
- `async_get_night_mode(self) -> IRmode`<br>
89+
- `async_get_night_mode() -> IRmode`<br>
9090
queries and returns the sensor night mode setting:
9191
- bool result.LED
9292
- bool result.Sensor
9393

94-
- `async_get_alarm_trigger(self) -> Trigger`<br>
94+
- `async_get_alarm_trigger() -> Trigger`<br>
9595
queries and returns the alarm trigger setting:
9696
- bool result.motion
9797
- bool result.audio
9898

99-
- `async_get_alarm_action(self) -> Action`<br>
99+
- `async_get_alarm_action() -> Action`<br>
100100
queries and returns the alarm action setting:
101101
- bool result.audio - sound the siren
102102
- bool result.ftp_snap - store snapshots to FTP server
103103
- bool result.ftp_rec - store recordings to FTP server
104104

105-
- `async_get_alarm_triggered(self) -> bool`<br>
105+
- `async_get_alarm_triggered() -> bool`<br>
106106
queries and returns `True` if an alram was detected.<br>
107107
*Currently not implemented, returns `False`*
108108

109-
- `async_get_ftp_config(self)`<br>
109+
- `async_get_ftp_config()`<br>
110110
queries and returns the current FTP configuration
111111

112112

113113
### Device Actions
114-
- `async_snap_picture(self)`<br>
114+
- `async_snap_picture()`<br>
115115
snaps a picture and returns the byte array
116116

117-
- `async_mjpeg_stream(self, request)`<br>
117+
- `async_mjpeg_stream(request)`<br>
118118
requests and returns a motion JPEG stream
119119

120-
- `async_set_alarm(self, trigger: Trigger, action: Action) -> Response`<br>
120+
- `async_set_alarm(trigger: Trigger, action: Action) -> Response`<br>
121121
Arms or disarms the camera by7 setting the `trigger` and `action` settings
122122

123-
- `async_ptz_preset(self, preset_pos:int)`<br>
123+
- `async_ptz_preset(preset_pos:int)`<br>
124124
moves the camera to the specified preprogrammed position if PTX is available

0 commit comments

Comments
 (0)