diff --git a/.gitbook/assets/assets-2f-lifiulge6_ztmmvcuea-2f-lkmxk1kqvbgjpw04i3u-2f-liqbk7blltxqntvqzh_-2fpysense_lopy4.png b/.gitbook/assets/assets-2f-lifiulge6_ztmmvcuea-2f-lkmxk1kqvbgjpw04i3u-2f-liqbk7blltxqntvqzh_-2fpysense_lopy4.png new file mode 100644 index 0000000..45c5c57 Binary files /dev/null and b/.gitbook/assets/assets-2f-lifiulge6_ztmmvcuea-2f-lkmxk1kqvbgjpw04i3u-2f-liqbk7blltxqntvqzh_-2fpysense_lopy4.png differ diff --git a/.gitbook/assets/assets-2f-lifiulge6_ztmmvcuea-2f-lkmxk1kqvbgjpw04i3u-2f-liqbluw130dl1amaklt-2fpytrack_lopy4.png b/.gitbook/assets/assets-2f-lifiulge6_ztmmvcuea-2f-lkmxk1kqvbgjpw04i3u-2f-liqbluw130dl1amaklt-2fpytrack_lopy4.png new file mode 100644 index 0000000..6794c20 Binary files /dev/null and b/.gitbook/assets/assets-2f-lifiulge6_ztmmvcuea-2f-lkmxk1kqvbgjpw04i3u-2f-liqbluw130dl1amaklt-2fpytrack_lopy4.png differ diff --git a/SUMMARY.md b/SUMMARY.md index 57b8886..bb1a904 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -151,7 +151,7 @@ * [Builtin](firmwareapi/micropython/builtin.md) * [Notes](firmwareapi/notes.md) -## Product Info +## Product Info, Datasheets * [Introduction](datasheets/introduction.md) * [Development Modules](datasheets/development/README.md) diff --git a/firmwareapi/pycom/network/wlan.md b/firmwareapi/pycom/network/wlan.md index 0b4f25e..b5b4ad3 100644 --- a/firmwareapi/pycom/network/wlan.md +++ b/firmwareapi/pycom/network/wlan.md @@ -121,15 +121,13 @@ Note: For Fast scan mode ssid/bssid and channel should be For active scans, dwell times for each channel are listed below. scantime is given as a tuple for min and max times \(min,max\) +min=0, max=0: scan dwells on each channel for 120 ms. +min>0, max=0: scan dwells on each channel for 120 ms. - min=0, max=0: scan dwells on each channel for 120 ms. +min=0, max>0: scan dwells on each channel for max ms. - min>0, max=0: scan dwells on each channel for 120 ms. - - min=0, max>0: scan dwells on each channel for max ms. - - min>0, max>0: The minimum time the scan dwells on each channel is min ms. If no AP is found during this time frame, the scan switches to the next channel. Otherwise, the scan dwells on the channel for max ms.If you want to improve the performance of the the scan, you can try to modify these two parameters. +min>0, max>0: The minimum time the scan dwells on each channel is min ms. If no AP is found during this time frame, the scan switches to the next channel. Otherwise, the scan dwells on the channel for max ms.If you want to improve the performance of the the scan, you can try to modify these two parameters. ### wlan.disconnect\(\) @@ -272,38 +270,33 @@ Send raw data through the Wifi Interface. `use_sys_seq`: `True` to use the systems next sequance number for sending the data, `False` for keeping the sequance number in the given raw data buffer unchanged. -### wlan.callback(trigger, handler=Null, arg=Null) +### wlan.callback\(trigger, handler=Null, arg=Null\) -Register a user callback function ``handler`` to be called once any of the ``trigger`` events occures optionally with a passed ``arg``. -by default the wlan obj is passed as arg to the handler. -To unregister the callback you can call the ``wlan.callback`` function with empty `handler` and `arg` parameters. +Register a user callback function `handler` to be called once any of the `trigger` events occures optionally with a passed `arg`. by default the wlan obj is passed as arg to the handler. To unregister the callback you can call the `wlan.callback` function with empty `handler` and `arg` parameters. For trigger events see `Constants` section. -### wlan.promiscuous([bool]) +### wlan.promiscuous\(\[bool\]\) -- To enable Promiscuous mode `WLAN.promiscuous(True)` should be called, and `WLAN.promiscuous(False)` for disabling +* To enable Promiscuous mode `WLAN.promiscuous(True)` should be called, and `WLAN.promiscuous(False)` for disabling +* To get current mode setting call function with empty args -- To get current mode setting call function with empty args +Note: -Note: +* Promiscuous mode should be enabled for Wifi packets types Events to be triggered +* for changing wifi channel via `wlan.channel()` promiscuous mode should be enabled. -- Promiscuous mode should be enabled for Wifi packets types Events to be triggered - -- for changing wifi channel via `wlan.channel()` promiscuous mode should be enabled. - -### wlan.events() +### wlan.events\(\) This function will return an integer object as mask for triggered events. -### wlan.wifi\_packet() +### wlan.wifi\_packet\(\) This function will return a tuble with Wifi packet info captured in promiscuous mode. -### wlan.ctrl\_pkt\_filter([int]) +### wlan.ctrl\_pkt\_filter\(\[int\]\) -This function is used to set the filter mask for Wifi control packets in promiscuous mode. -for Filter masks, see `Constants` section. +This function is used to set the filter mask for Wifi control packets in promiscuous mode. for Filter masks, see `Constants` section. To get the current Filter mask, call the function with empty args. @@ -320,35 +313,36 @@ To get the current Filter mask, call the function with empty args. * Wlan callback triggers: `WLAN.EVENT_PKT_MGMT`: Managment packet recieved in promiscuous mode. - + `WLAN.EVENT_PKT_CTRL`: Control Packet recieved in promiscuous mode - + `WLAN.EVENT_PKT_DATA`: Data packet recieved in promiscuous mode - + `WLAN.EVENT_PKT_DATA_MPDU`: MPDU data packet recieved in promiscuous mode - + `WLAN.EVENT_PKT_DATA_AMPDU`: AMPDU data packet recieved in promiscuous mode - + `WLAN.EVENT_PKT_MISC`: misc paket recieved in promiscuous mode. - + `WLAN.EVENT_PKT_ANY`: Any packet recieved in promiscuous mode. - + * Control packet filters in promiscuous mode: `WLAN.FILTER_CTRL_PKT_ALL`: Filter all Control packets - + `WLAN.FILTER_CTRL_PKT_WRAPPER`: Filter control wrapper packets - + `WLAN.FILTER_CTRL_PKT_BAR`: Filter Control BAR packets - + `WLAN.FILTER_CTRL_PKT_BA`: Filter Control BA packets - + `WLAN.FILTER_CTRL_PKT_PSPOLL`: Filter Control PSPOLL Packets - + `WLAN.FILTER_CTRL_PKT_CTS`: Filter Control CTS packets - + `WLAN.FILTER_CTRL_PKT_ACK`: Filter Control ACK packets - + `WLAN.FILTER_CTRL_PKT_CFEND`: Filter Control CFEND Packets - - `WLAN.FILTER_CTRL_PKT_CFENDACK`: Filter Control CFENDACK Packets + + `WLAN.FILTER_CTRL_PKT_CFENDACK`: Filter Control CFENDACK Packets + diff --git a/pybytes/integrations/amazon-iot.md b/pybytes/integrations/amazon-iot.md index 693d8f4..34b2d71 100644 --- a/pybytes/integrations/amazon-iot.md +++ b/pybytes/integrations/amazon-iot.md @@ -8,30 +8,29 @@ Whenever one of your integrated devices sends a message to our broker, we republ ![](../../.gitbook/assets/01_aws_integration.png) -2. Fill in the form choosing an [AWS region](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html) and your AWS credentials. You can optionally choose to save them inside the local storage for future use. Once you're done, click _Login_ +1. Fill in the form choosing an [AWS region](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html) and your AWS credentials. You can optionally choose to save them inside the local storage for future use. Once you're done, click _Login_ ![](../../.gitbook/assets/02_aws_integration.png) -3. In this step, you have to specify the [AWS group](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html) name \(just alphanumeric letter, dashes and underscore are allowed\), the custom topic and the devices you want to bind to AWS. When you're ready, click _Create_ +1. In this step, you have to specify the [AWS group](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html) name \(just alphanumeric letter, dashes and underscore are allowed\), the custom topic and the devices you want to bind to AWS. When you're ready, click _Create_ ![](../../.gitbook/assets/03_aws_integration.png) -4. If everything's worked as expected, you should be able to see a summary of your integration like the following: +1. If everything's worked as expected, you should be able to see a summary of your integration like the following: ![](../../.gitbook/assets/04_aws_integration.png) -5. The corresponding AWS Thing and AWS Group has been created as well, you just have to [log in to the console](https://console.aws.amazon.com/console/home?nc2=h_ct&src=header-signin) and choose the same region of your devices from the topbar. You'll be able to explore groups and things' details. +1. The corresponding AWS Thing and AWS Group has been created as well, you just have to [log in to the console](https://console.aws.amazon.com/console/home?nc2=h_ct&src=header-signin) and choose the same region of your devices from the topbar. You'll be able to explore groups and things' details. ![](../../.gitbook/assets/05_aws_integration.png) -6. The device's name is specified as an attribute of the thing. +1. The device's name is specified as an attribute of the thing. ![](../../.gitbook/assets/06_aws_integration.png) - ## Final considerations -In order to save the data received by AWS, [you must set up a rule](https://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html). You can also test that everything's working with the [AWS IoT MQTT client](https://docs.aws.amazon.com/iot/latest/developerguide/view-mqtt-messages.html). -Please notice that it's not possible to download the private key from AWS once it has been generated, by the way we securely store it inside our database. We may consider to allow its download in the future, so that you could also directly send your device to AWS, by passing Pybytes. +In order to save the data received by AWS, [you must set up a rule](https://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html). You can also test that everything's working with the [AWS IoT MQTT client](https://docs.aws.amazon.com/iot/latest/developerguide/view-mqtt-messages.html). Please notice that it's not possible to download the private key from AWS once it has been generated, by the way we securely store it inside our database. We may consider to allow its download in the future, so that you could also directly send your device to AWS, by passing Pybytes. **Warning**: do not delete AWS things or groups directly from AWS user interface, otherwise the integration with Pybytes will stop working. Always use Pybytes interface to delete AWS things or groups. +