djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

embellish rtd comments. channel _should_ default to 1 behind the scenes since 0 is out of range, but just to be sure, default channel to 1

This commit is contained in:
anecdata 2021-04-25 14:30:45 -05:00
parent c510c4d501
commit 6f6c0cff81
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
shared-bindings/wifi/Radio.c
View File

@ -192,8 +192,13 @@ MP_DEFINE_CONST_FUN_OBJ_1(wifi_radio_stop_station_obj, wifi_radio_stop_station);
//| def start_ap(self,
//| ssid: ReadableBuffer,
//| password: ReadableBuffer = b"") -> None:
//| """Starts an Access Point with the specified ssid and password."""
//| password: ReadableBuffer = b"",
//| *,
//| channel: Optional[int] = 1) -> None:
//| """Starts an Access Point with the specified ssid and password.
//|
//| If ``channel`` is given, the access point will use that channel unless
//| wifi is already operating on a different channel due to an active station."""
//| ...
//|
STATIC mp_obj_t wifi_radio_start_ap(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
@ -201,7 +206,7 @@ STATIC mp_obj_t wifi_radio_start_ap(size_t n_args, const mp_obj_t *pos_args, mp_
static const mp_arg_t allowed_args[] = {
{ MP_QSTR_ssid, MP_ARG_REQUIRED | MP_ARG_OBJ },
{ MP_QSTR_password, MP_ARG_OBJ, {.u_obj = MP_OBJ_NULL} },
{ MP_QSTR_channel, MP_ARG_KW_ONLY | MP_ARG_INT, {.u_int = 0} },
{ MP_QSTR_channel, MP_ARG_KW_ONLY | MP_ARG_INT, {.u_int = 1} },
};
wifi_radio_obj_t *self = MP_OBJ_TO_PTR(pos_args[0]);