circuitpython/shared-bindings/_bleio/ScanResults.c

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

71 lines
2.7 KiB
C
Raw Normal View History

/*
* This file is part of the MicroPython project, http://micropython.org/
*
* The MIT License (MIT)
*
* Copyright (c) 2019 Dan Halbert for Adafruit Industries
* Copyright (c) 2018 Artur Pacholec
* Copyright (c) 2017 Glenn Ruben Bakke
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
#include <string.h>
#include "py/objproperty.h"
#include "py/runtime.h"
#include "shared-bindings/_bleio/ScanResults.h"
2020-05-01 18:23:27 -04:00
//| class ScanResults:
//| """Iterates over advertising data received while scanning. This object is always created
2020-05-01 18:23:27 -04:00
//| by a `_bleio.Adapter`: it has no user-visible constructor."""
//|
STATIC mp_obj_t scanresults_iternext(mp_obj_t self_in) {
mp_check_self(mp_obj_is_type(self_in, &bleio_scanresults_type));
bleio_scanresults_obj_t *self = MP_OBJ_TO_PTR(self_in);
mp_obj_t scan_entry = common_hal_bleio_scanresults_next(self);
if (scan_entry != mp_const_none) {
return scan_entry;
}
return MP_OBJ_STOP_ITERATION;
}
2020-07-03 14:23:34 -04:00
//| def __init__(self) -> None:
2020-05-01 18:23:27 -04:00
//| """Cannot be instantiated directly. Use `_bleio.Adapter.start_scan`."""
//| ...
2020-07-03 13:49:00 -04:00
//| def __iter__(self) -> Iterator[ScanEntry]:
2020-05-01 18:23:27 -04:00
//| """Returns itself since it is the iterator."""
//| ...
2020-07-03 13:49:00 -04:00
//| def __next__(self) -> ScanEntry:
2020-05-01 18:23:27 -04:00
//| """Returns the next `_bleio.ScanEntry`. Blocks if none have been received and scanning is still
2023-02-01 03:08:41 -05:00
//| active. Raises `StopIteration` if scanning is finished and no other results are available.
//| """
2020-05-01 18:23:27 -04:00
//| ...
//|
const mp_obj_type_t bleio_scanresults_type = {
{ &mp_type_type },
.flags = MP_TYPE_FLAG_EXTENDED,
.name = MP_QSTR_ScanResults,
MP_TYPE_EXTENDED_FIELDS(
.getiter = mp_identity_getiter,
.iternext = scanresults_iternext,
),
};