diff options
author | Jean-François Milants <jf@codingfield.com> | 2021-03-07 08:44:14 +0100 |
---|---|---|
committer | Jean-François Milants <jf@codingfield.com> | 2021-03-07 08:44:14 +0100 |
commit | 9f67e6f6525bd4071609ff9edd6ce132d7ca1464 (patch) | |
tree | 65b2dc22bb257c6dd4fc8be77762173b564c340c /src/libs/mynewt-nimble/apps/README.md | |
parent | 740b3d7b58dd92a6a6f99620a090ae4f05c03299 (diff) | |
parent | ada942535718d48eec37cca4f50d678e7201dc67 (diff) |
Merge branch 'develop' into recovery-firmware
# Conflicts:
# src/CMakeLists.txt
# src/displayapp/DisplayApp.h
# src/systemtask/SystemTask.cpp
# src/systemtask/SystemTask.h
Diffstat (limited to 'src/libs/mynewt-nimble/apps/README.md')
-rw-r--r-- | src/libs/mynewt-nimble/apps/README.md | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/src/libs/mynewt-nimble/apps/README.md b/src/libs/mynewt-nimble/apps/README.md new file mode 100644 index 00000000..f36a836a --- /dev/null +++ b/src/libs/mynewt-nimble/apps/README.md @@ -0,0 +1,54 @@ +<!-- +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +--> + +# Sample applications + +## advertiser + +This is the simplest example of advertising. Application sets NRPA, configures +advertisement parameters: general discoverable and not connectable and fills +advertisement fields. Transmited data contains only flags, tx power level and +device name, which fits in 31B limit of single package. With this data set, +device advertises for 10 seconds, terminates advertisement and repeats process +again infinitely. + +## scanner + +This application shows how to perform simple scan. Device performs discovery +procedure, during which receives advertising reports (if any devices are +advertising nearby). These reports are being parsed and results are printed to +serial port. Applicaton starts new discovery every second. + +## peripheral + +Peripheral application is based on advertiser, but has added capability of +connecting with other devices. As peripheral, device doesn't initiate any +connection by itself; instead, advertises infinitely and accepts any connection +request it receives. Because we cannot use any 16 or 32 bit UUIDs, as these are +reserved by Bluetooth SIG, we are forced to use 128-bit one. Including such +long UUID in advertising data consumes large part of available payload, so this +data is split in advertising data and response data. + +## central + +This application works in pair with peripheral. It's based on scanner +application - the difference is, that if there was detected device with UUID +fitting to the one predefined in central application, connection is initiated.
\ No newline at end of file |