blob: df81262a378337a68b5a714441a88fc337c82e8f [file] [log] [blame]
{"config":{"lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Apache Mynewt is a real-time, modular operating system for connected IoT devices that need to operate for long periods of time under power, memory, and storage constraints. The first connectivity stack offered is BLE 4.2.","title":"Home"},{"location":"about/","text":"Roadmap Some upcoming features: Full IP support Low power support with ability for drivers to turn on/off low power settings automatically Sensor API, see discussion thread Support for MIPS architecture Support for additional boards The detailed roadmap is tracked on JIRA for Mynewt . Feature Request The WISHLIST at the top of the roadmap on JIRA for Mynewt features all the new ideas awaiting discussion and review. Once the community decides to go ahead with a request, it is scheduled into a release. Generally, effort is made to schedule a requested feature into a particular version no later than 6 weeks prior to the planned release date. If you have suggestions for a new feature, use case, or implementation improvements, file a JIRA ticket with Issue Type set to \"Wish\". Introduce it in the dev@ mailing list with a link to the JIRA ticket. This assumes you have signed up for an account on JIRA and submitted a request to the dev@ mailing list for your JIRA username to be added to the Apache Mynewt (MYNEWT) project. FAQ Questions? Click here","title":"About"},{"location":"about/#roadmap","text":"Some upcoming features: Full IP support Low power support with ability for drivers to turn on/off low power settings automatically Sensor API, see discussion thread Support for MIPS architecture Support for additional boards The detailed roadmap is tracked on JIRA for Mynewt .","title":"Roadmap"},{"location":"about/#feature-request","text":"The WISHLIST at the top of the roadmap on JIRA for Mynewt features all the new ideas awaiting discussion and review. Once the community decides to go ahead with a request, it is scheduled into a release. Generally, effort is made to schedule a requested feature into a particular version no later than 6 weeks prior to the planned release date. If you have suggestions for a new feature, use case, or implementation improvements, file a JIRA ticket with Issue Type set to \"Wish\". Introduce it in the dev@ mailing list with a link to the JIRA ticket. This assumes you have signed up for an account on JIRA and submitted a request to the dev@ mailing list for your JIRA username to be added to the Apache Mynewt (MYNEWT) project.","title":"Feature Request"},{"location":"about/#faq","text":"Questions? Click here","title":"FAQ"},{"location":"community/","text":"Mailing Lists We welcome you to join our mailing lists and get in touch with us! To complete your subscription you have to confirm it by replying to the response sent to you when you email your subscription request!","title":"Community"},{"location":"community/#mailing-lists","text":"We welcome you to join our mailing lists and get in touch with us! To complete your subscription you have to confirm it by replying to the response sent to you when you email your subscription request!","title":"Mailing Lists"},{"location":"documentation/","text":"Apache Mynewt Documentation Latest version: latest Earlier versions: 1.11.0 1.10.0 1.9.0 1.8.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0 0.9.0 Documentation Source Apache Mynewt documentation is undergoing a reorganization. Please check with project committers for the best location to make changes in order to avoid duplication of effort. The most recent project documentation can be found in the apache/mynewt-documentation repo. https://github.com/apache/mynewt-documentation This holds content like tutorials, FAQs, etc. i.e. content that may change as software changes and can therefore be pinned to a particular release version. Specific code documentation is found in each of the apache/mynewt-* code repos under /docs. e.g. https://github.com/apache/mynewt-core/tree/master/docs 1.3.0 and earlier documentation is maintained in the apache/mynewt-site repo. https://github.com/apache/mynewt-site This will eventually be used only for site pages. i.e. content relating to the project that is not dependent on a software release like the home page, community, events and quick start. It will also contain earlier versions of the full documentation set until such time as they become obsolete.","title":"Documentation"},{"location":"documentation/#apache-mynewt-documentation","text":"Latest version: latest Earlier versions: 1.11.0 1.10.0 1.9.0 1.8.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0 0.9.0","title":"Apache Mynewt Documentation"},{"location":"documentation/#documentation-source","text":"Apache Mynewt documentation is undergoing a reorganization. Please check with project committers for the best location to make changes in order to avoid duplication of effort. The most recent project documentation can be found in the apache/mynewt-documentation repo. https://github.com/apache/mynewt-documentation This holds content like tutorials, FAQs, etc. i.e. content that may change as software changes and can therefore be pinned to a particular release version. Specific code documentation is found in each of the apache/mynewt-* code repos under /docs. e.g. https://github.com/apache/mynewt-core/tree/master/docs 1.3.0 and earlier documentation is maintained in the apache/mynewt-site repo. https://github.com/apache/mynewt-site This will eventually be used only for site pages. i.e. content relating to the project that is not dependent on a software release like the home page, community, events and quick start. It will also contain earlier versions of the full documentation set until such time as they become obsolete.","title":"Documentation Source"},{"location":"download/","text":"Latest Apache Mynewt OS Release You can verify your download by following these procedures and using these KEYS . Latest Apache Mynewt Core OS Release Release Version: Apache Mynewt 1.11.0 Release Date: September 7, 2023 Release Notes Source downloads: Mynewt Core OS: apache-mynewt-core-1.11.0.tgz [PGP] [SHA512] Mynewt Blinky template application: apache-mynewt-blinky-1.11.0.tgz [PGP] [SHA512] Mynewt build and package management tool (newt): apache-mynewt-newt-1.11.0.tgz [PGP] [SHA512] Mynewt Manager tool (newtmgr): apache-mynewt-newtmgr-1.11.0.tgz [PGP] [SHA512] [Note typo in tarball filename!] Binary downloads: Mynewt build and package management tool (newt): Linux 64bit: apache-mynewt-newt-bin-linux-1.11.0.tgz [PGP] [SHA512] MacOS 64bit: apache-mynewt-newt-bin-osx-1.11.0.tgz [PGP] [SHA512] Windows 64bit: apache-mynewt-newt-bin-windows-1.11.0.tgz [PGP] [SHA512] Mynewt Manager tool (newtmgr): Linux 64bit: apache-mynewt-newtmgr-bin-linux-1.11.0.tgz [PGP] [SHA512] MacOS 64bit: apache-mynewt-newtmgr-bin-osx-1.11.0.tgz [PGP] [SHA512] Windows 64bit: apache-mynewt-newtmgr-bin-windows-1.11.0.tgz [PGP] [SHA512] Latest Apache Mynewt NimBLE (Bluetooth Stack) Release Mynewt's Bluetooth stack is now a separate release with a porting layer that allows it to be easily ported to another OS! Release Version: Apache NimBLE 1.6.0 Release Date: September 7, 2023 Release Notes Source downloads: apache-mynewt-nimble-1.6.0.tgz [PGP] [SHA512] Fresh install If you are brand new to Mynewt, go to Quick Start . The Newt tool will automatically download the latest release. If you have already installed the Newt tool but not started any project yet, go to Create Your First Project . The Newt tool will automatically download the latest release. Upgrade If you have already installed the Newt tool and started a project that installed a previous version of Apache Mynewt, upgrade using Newt tool: $ newt upgrade Prior Releases Apache Mynewt Core Apache Mynewt 0.8.0-b2-incubating, Release Notes , Release Archive Apache Mynewt 0.8.0-incubating, Release Notes , Release Archive Apache Mynewt 0.9.0-incubating, Release Notes , Release Archive Apache Mynewt 1.0.0-b1-incubating, Release Notes , Release Archive Apache Mynewt 1.0.0-b2-incubating, Release Notes , Release Archive Apache Mynewt 1.0.0-incubating, Release Notes , Release Archive Apache Mynewt 1.1.0, Release Notes , Release Archive Apache Mynewt 1.2.0, Release Notes , Release Archive Apache Mynewt 1.3.0 Release Notes , Release Archive Apache Mynewt 1.4.0 Release Notes , Release Archive Apache Mynewt 1.4.1 Release Notes , Release Archive Apache Mynewt 1.5.0 Release Notes , Release Archive Apache Mynewt 1.6.0 Release Notes , Release Archive Apache Mynewt 1.7.0 Release Notes , Release Archive Apache Mynewt 1.8.0 Release Notes , Release Archive Apache Mynewt 1.9.0 Release Notes , Release Archive Apache Mynewt 1.10.0 Release Notes , Release Archive Apache Mynewt NimBLE (Bluetooth Stack) Apache NimBLE 1.0.0 Release Notes , Release Archive Apache NimBLE 1.1.0 Release Notes , Release Archive Apache NimBLE 1.2.0 Release Notes , Release Archive Apache NimBLE 1.3.0 Release Notes , Release Archive Apache NimBLE 1.4.0 Release Notes , Release Archive Apache NimBLE 1.5.0 Release Notes , Release Archive","title":"Download"},{"location":"download/#latest-apache-mynewt-os-release","text":"You can verify your download by following these procedures and using these KEYS .","title":"Latest Apache Mynewt OS Release"},{"location":"download/#latest-apache-mynewt-core-os-release","text":"Release Version: Apache Mynewt 1.11.0 Release Date: September 7, 2023 Release Notes Source downloads: Mynewt Core OS: apache-mynewt-core-1.11.0.tgz [PGP] [SHA512] Mynewt Blinky template application: apache-mynewt-blinky-1.11.0.tgz [PGP] [SHA512] Mynewt build and package management tool (newt): apache-mynewt-newt-1.11.0.tgz [PGP] [SHA512] Mynewt Manager tool (newtmgr): apache-mynewt-newtmgr-1.11.0.tgz [PGP] [SHA512] [Note typo in tarball filename!] Binary downloads: Mynewt build and package management tool (newt): Linux 64bit: apache-mynewt-newt-bin-linux-1.11.0.tgz [PGP] [SHA512] MacOS 64bit: apache-mynewt-newt-bin-osx-1.11.0.tgz [PGP] [SHA512] Windows 64bit: apache-mynewt-newt-bin-windows-1.11.0.tgz [PGP] [SHA512] Mynewt Manager tool (newtmgr): Linux 64bit: apache-mynewt-newtmgr-bin-linux-1.11.0.tgz [PGP] [SHA512] MacOS 64bit: apache-mynewt-newtmgr-bin-osx-1.11.0.tgz [PGP] [SHA512] Windows 64bit: apache-mynewt-newtmgr-bin-windows-1.11.0.tgz [PGP] [SHA512]","title":"Latest Apache Mynewt Core OS Release"},{"location":"download/#latest-apache-mynewt-nimble-bluetooth-stack-release","text":"Mynewt's Bluetooth stack is now a separate release with a porting layer that allows it to be easily ported to another OS! Release Version: Apache NimBLE 1.6.0 Release Date: September 7, 2023 Release Notes Source downloads: apache-mynewt-nimble-1.6.0.tgz [PGP] [SHA512]","title":"Latest Apache Mynewt NimBLE (Bluetooth Stack) Release"},{"location":"download/#fresh-install","text":"If you are brand new to Mynewt, go to Quick Start . The Newt tool will automatically download the latest release. If you have already installed the Newt tool but not started any project yet, go to Create Your First Project . The Newt tool will automatically download the latest release.","title":"Fresh install"},{"location":"download/#upgrade","text":"If you have already installed the Newt tool and started a project that installed a previous version of Apache Mynewt, upgrade using Newt tool: $ newt upgrade","title":"Upgrade"},{"location":"download/#prior-releases","text":"","title":"Prior Releases"},{"location":"download/#apache-mynewt-core","text":"Apache Mynewt 0.8.0-b2-incubating, Release Notes , Release Archive Apache Mynewt 0.8.0-incubating, Release Notes , Release Archive Apache Mynewt 0.9.0-incubating, Release Notes , Release Archive Apache Mynewt 1.0.0-b1-incubating, Release Notes , Release Archive Apache Mynewt 1.0.0-b2-incubating, Release Notes , Release Archive Apache Mynewt 1.0.0-incubating, Release Notes , Release Archive Apache Mynewt 1.1.0, Release Notes , Release Archive Apache Mynewt 1.2.0, Release Notes , Release Archive Apache Mynewt 1.3.0 Release Notes , Release Archive Apache Mynewt 1.4.0 Release Notes , Release Archive Apache Mynewt 1.4.1 Release Notes , Release Archive Apache Mynewt 1.5.0 Release Notes , Release Archive Apache Mynewt 1.6.0 Release Notes , Release Archive Apache Mynewt 1.7.0 Release Notes , Release Archive Apache Mynewt 1.8.0 Release Notes , Release Archive Apache Mynewt 1.9.0 Release Notes , Release Archive Apache Mynewt 1.10.0 Release Notes , Release Archive","title":"Apache Mynewt Core"},{"location":"download/#apache-mynewt-nimble-bluetooth-stack","text":"Apache NimBLE 1.0.0 Release Notes , Release Archive Apache NimBLE 1.1.0 Release Notes , Release Archive Apache NimBLE 1.2.0 Release Notes , Release Archive Apache NimBLE 1.3.0 Release Notes , Release Archive Apache NimBLE 1.4.0 Release Notes , Release Archive Apache NimBLE 1.5.0 Release Notes , Release Archive","title":"Apache Mynewt NimBLE (Bluetooth Stack)"},{"location":"events/","text":"Events Please take a look at our upcoming events! We hope to see you there.","title":"Events"},{"location":"events/#events","text":"Please take a look at our upcoming events! We hope to see you there.","title":"Events"},{"location":"known_issues/","text":"Known Issues Here is a list of known issues and workarounds: newt install returns the following error: ReadDesc: No matching branch for apache-mynewt-core repo No matching branch for apache-mynewt-core repo The apache-mynewt-core Git repository location has changed due to Mynewt's graduation from an incubator project to an Apache top level project. The HTTP redirect to the new location may fail for some users. Workaround: Edit the project.yml file and change the line repo: incubator-mynewt-core as shown in the following example to repo: mynewt-core : repository.apache-mynewt-core: type: github vers: 1-latest user: apache repo: incubator-mynewt-core","title":"Known issues"},{"location":"known_issues/#known-issues","text":"Here is a list of known issues and workarounds: newt install returns the following error: ReadDesc: No matching branch for apache-mynewt-core repo No matching branch for apache-mynewt-core repo The apache-mynewt-core Git repository location has changed due to Mynewt's graduation from an incubator project to an Apache top level project. The HTTP redirect to the new location may fail for some users. Workaround: Edit the project.yml file and change the line repo: incubator-mynewt-core as shown in the following example to repo: mynewt-core : repository.apache-mynewt-core: type: github vers: 1-latest user: apache repo: incubator-mynewt-core","title":"Known Issues"},{"location":"quick-start/","text":"Get set Apache Mynewt currently offers two ways to quickly get set up, each appealing to different personal preferences and levels of familiarity with embedded systems. Option 1: Step-by-step instructions to install the Newt tool, developer toolchains and libraries natively on your computer. This is the recommended option. For this option, go to Native Setup Option 2: All-in-one docker container that bundles Newt tool, developer toolchains and libraries. This option is only for a quick look at the project. For this option, go to Docker instructions Go! Start a new project as explained under Create Your First Project . The core Mynewt OS is automatically downloaded as part of the project installation. When you Create Your First Project you define a simulated target and run Project Blinky, the Hello World equivalent in the embedded world. If you have one of the supported boards , you can make real LEDs blink in Project Blinky . Simply choose the appropriate tutorial for the board and proceed. And More... Explore the Tutorials section for other interesting projects or simply to learn more about Mynewt's capabilities and get familiar with its use.","title":"Quick Start"},{"location":"quick-start/#get-set","text":"Apache Mynewt currently offers two ways to quickly get set up, each appealing to different personal preferences and levels of familiarity with embedded systems. Option 1: Step-by-step instructions to install the Newt tool, developer toolchains and libraries natively on your computer. This is the recommended option. For this option, go to Native Setup Option 2: All-in-one docker container that bundles Newt tool, developer toolchains and libraries. This option is only for a quick look at the project. For this option, go to Docker instructions","title":"Get set"},{"location":"quick-start/#go","text":"Start a new project as explained under Create Your First Project . The core Mynewt OS is automatically downloaded as part of the project installation. When you Create Your First Project you define a simulated target and run Project Blinky, the Hello World equivalent in the embedded world. If you have one of the supported boards , you can make real LEDs blink in Project Blinky . Simply choose the appropriate tutorial for the board and proceed.","title":"Go!"},{"location":"quick-start/#and-more","text":"Explore the Tutorials section for other interesting projects or simply to learn more about Mynewt's capabilities and get familiar with its use.","title":"And More..."},{"location":"talks/","text":"","title":"Talks"},{"location":"news/article1/","text":"","title":"Article1"},{"location":"pages/ble/","text":"","title":"Bluetooth Low Energy"},{"location":"pages/configurability/","text":"","title":"Configurability"},{"location":"pages/securitybullets/","text":"","title":"Security Lifecycle"}]}