Repository: incubator-mynewt-site Updated Branches: refs/heads/asf-site 408994010 -> b3522a138
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b3522a13/mkdocs/search_index.json ---------------------------------------------------------------------- diff --git a/mkdocs/search_index.json b/mkdocs/search_index.json index 1d3a41c..ad542cc 100644 --- a/mkdocs/search_index.json +++ b/mkdocs/search_index.json @@ -151,51 +151,6 @@ "title": "Quick Start" }, { - "location": "/os/get_started/docker/", - "text": "Everything You Need in a Docker Container\n\n\nDocker provides a quick and easy way to get up and running with Mynewt. The\nnewt command line tool and the entire build toolchain is available in a single\ndocker container. The container is all that's needed to run your Mynewt based\napplication in the simulator. Enabling USB2 with your docker installation will\nallow you to load your application on a supported device.\n\n\nDocker is the only supported option if you are working on a Windows machine. If you are using Mac OS X or Linux, you have the choice of installing a Docker container of tools and toolchains or installing them natively. This chapter describes how to set up the Docker image for all three platforms.\n\n\n\n\nInstall Docker\n\n\nInstall docker for your platform. \nMac OS X\n / \nWindows\n / \nLinux\n\n\nMac and Windows\n\n\nMac and Windows require Docker Toolbox to interact with USB devices. Docker\nfor Mac and Docker for Windows do not support U SB. Docker Toolbox uses\nVirtualBox and allows you to map USB devices into docker containers as\ndescribed below.\n\n\nMake sure to double click the Docker Quickstart Terminal application if you're\non Mac or Windows.\n\n\nLinux\n\n\nThe docker daemon listens on a Unix domain socket on Linux. That socket is\nowned by root, which means by default you must be root to start a container.\nMake sure to follow the optional step of adding yourself to the docker group so\nyou can start the newt container as yourself.\n\n\n\n\nUse the newt wrapper script\n\n\nUse the newt wrapper script to invoke newt. Create the following file, name it\n\nnewt\n, make it executable, and put it in your path. This will allow you to run newt as if it was natively installed. You can now follow the normal tutorials using the newt wrapper script.\n\n\n#!/bin/bash\n\n\n\nif\n \n[\n \n$1\n \n=\n \ndebug\n \n]\n \n||\n \n[\n \n$1\n \n=\n \nrun\n \n]\n\n\nthen\n\n \nti=\n-ti\n\n\nfi\n\n\ndocker run -e \nNEWT_US ER=\n$(\nid -u\n)\n -e \nNEWT_GROUP=\n$(\nid -g\n)\n -e \nNEWT_HOST=\n$(\nuname\n)\n \n$ti\n --rm --device\n=\n/dev/bus/usb --privileged -v \n$(pwd)\n:/workspace -w /workspace mynewt/newt:latest /newt \n$@\n\n\n\n\n\n\n\n\nNote 1:\n Remember to point to the correct subdirectory level when invoking \nnewt\n. For example, invoke it using \n../newt\n in the example below.\n\n\nuser@~/dockertest$ ls\nmyproj newt\nuser@~/dockertest$ cd myproj\n\nuser@~/dockertest/myproj$ ../newt version\n\nApache Newt (incubating) version: 0.8.0-b2\n\n\n\n\n\n\n\nNote 2:\n You can upgrade your container by running \ndocker pull mynewt/newt:latest\n when updates are made available.\n\n\n\n\nEnable USB2 Support for Mac or Windows\n\n\nIf you plan on loading your application on an actual device, do the steps below.\n\n\n\n\nInstall VirtualBox extension pack\n\n\nDocker uses a VirtualBox Linux VM to run containers. A free VirtualBox\nextension pack is required to enable USB2 support. Download the \nVirtua lBox\n5.0.16 Oracle VM VirtualBox Extension\nPack\n\nand double click to install\n\n\n\n\nEnable USB2 and select your device\n\n\n\n\n\n\nThe \"default\" VM created by docker-machine must first be stopped before you\n can enable USB2. You have two options:\n\n\n\n\nRun the command \ndocker-machine stop default\n in the terminal window or\n\n\nUse the VirtualBox UI. Right click on \ndefault\n -\n Close -\n Power Off\n\n\n\n\n\n\n\n\nEnable USB2 using the VirtualBox UI. Select the \"default\"\n VM-\nSettings-\nPorts-\nUSB2 to enable USB2. Add your device to the USB Device\n Filters to make the device visible in the docker container. See the image below.\n\n\n\n\n\n\n\n\n\n\nRestart the \"default\" VM. You have two options:\n\n\nRun \ndocker-machine start default\n in the terminal window or \n\n\nUse the VirtualBox UI. Make sure the \"default\" machine is highlighted. Click the green \"Start\" button. Select \"Headless Start\".\n\n\n\n\n\n\n\n\n\n\nNote 3\n: When working with ac tual hardware, remember that each board has an ID. If you swap boards and do not refresh the USB Device Filter on the VirtualBox UI, the ID might be stale and the Docker instance may not be able to see the board correctly. For example, you may see an error message like \nError: unable to find CMSIS-DAP device\n when you try to load or run an image on the board. In that case, you need to click on the USB link in VirtualBox UI, remove the existing USB Device Filter (e.g. \"Atmel Corp. EDBG CMSIS-DAP[0101]\") by clicking on the \"Removes selected USB filter\" button, and add a new filter by clicking on the \"Adds new USB filter\" button.", - "title": "Docker Container Option" - }, - { - "location": "/os/get_started/docker/#everything-you-need-in-a-docker-container", - "text": "Docker provides a quick and easy way to get up and running with Mynewt. The\nnewt command line tool and the entire build toolchain is available in a single\ndocker container. The container is all that's needed to run your Mynewt based\napplication in the simulator. Enabling USB2 with your docker installation will\nallow you to load your application on a supported device. Docker is the only supported option if you are working on a Windows machine. If you are using Mac OS X or Linux, you have the choice of installing a Docker container of tools and toolchains or installing them natively. This chapter describes how to set up the Docker image for all three platforms.", - "title": "Everything You Need in a Docker Container" - }, - { - "location": "/os/get_started/docker/#install-docker", - "text": "Install docker for your platform. Mac OS X / Windows / Linux", - "title": "Install Docker" - }, - { - "location": "/os/get_started/docker/#mac-and-windows", - "text": "Mac and Windows require Docker Toolbox to interact with USB devices. Docker\nfor Mac and Docker for Windows do not support USB. Docker Toolbox uses\nVirtualBox and allows you to map USB devices into docker containers as\ndescribed below. Make sure to double click the Docker Quickstart Terminal application if you're\non Mac or Windows.", - "title": "Mac and Windows" - }, - { - "location": "/os/get_started/docker/#linux", - "text": "The docker daemon listens on a Unix domain socket on Linux. That socket is\nowned by root, which means by default you must be root to start a container.\nMake sure to follow the optional step of adding yourself to the docker group so\nyou can start the newt container as yourself.", - "title": "Linux" - }, - { - "location": "/os/get_started/docker/#use-the-newt-wrapper-script", - "text": "Use the newt wrapper script to invoke newt. Create the following file, name it newt , make it executable, and put it in your path. This will allow you to run newt as if it was natively installed. You can now follow the normal tutorials using the newt wrapper script. #!/bin/bash if [ $1 = debug ] || [ $1 = run ] then \n ti= -ti fi \n\ndocker run -e NEWT_USER= $( id -u ) -e NEWT_GROUP= $( id -g ) -e NEWT_HOST= $( uname ) $ti --rm --device = /dev/bus/usb --privileged -v $(pwd) :/workspace -w /workspace mynewt/newt:latest /newt $@ Note 1: Remember to point to the correct subdirectory level when invoking newt . For example, invoke it using ../newt in the example below. user@~/dockertest$ ls\nmyproj newt\nuser@~/dockertest$ cd myproj user@~/dockertest/myproj$ ../newt version Apache Newt (incubating) version: 0.8.0-b2 Note 2: You can upgrade your container by running docker pull mynewt/newt:latest when updates are made available.", - "title": "Use the newt wrapper script" - }, - { - "location": "/os/get_started/docker/#enable-usb2-support-for-mac-or-windows", - "text": "If you plan on loading your application on an actual device, do the steps below.", - "title": "Enable USB2 Support for Mac or Windows" - }, - { - "location": "/os/get_started/docker/#install-virtualbox-extension-pack", - "text": "Docker uses a VirtualBox Linux VM to run containers. A free VirtualBox\nextension pack is required to enable USB2 support. Download the VirtualBox\n5.0.16 Oracle VM VirtualBox Extension\nPack \nand double click to install", - "title": "Install VirtualBox extension pack" - }, - { - "location": "/os/get_started/docker/#enable-usb2-and-select-your-device", - "text": "The \"default\" VM created by docker-machine must first be stopped before you\n can enable USB2. You have two options: Run the command docker-machine stop default in the terminal window or Use the VirtualBox UI. Right click on default - Close - Power Off Enable USB2 using the VirtualBox UI. Select the \"default\"\n VM- Settings- Ports- USB2 to enable USB2. Add your device to the USB Device\n Filters to make the device visible in the docker container. See the image below. Restart the \"default\" VM. You have two options: Run docker-machine start default in the terminal window or Use the VirtualBox UI. Make sure the \"default\" machine is highlighted. Click the green \"Start\" button. Select \"Headless Start\". Note 3 : When working with actual hardware, remember that each board has an ID. If you swap boards and do not refresh the USB Device Filter on the VirtualBox UI, the ID might be stale and the Docker instance may not be abl e to see the board correctly. For example, you may see an error message like Error: unable to find CMSIS-DAP device when you try to load or run an image on the board. In that case, you need to click on the USB link in VirtualBox UI, remove the existing USB Device Filter (e.g. \"Atmel Corp. EDBG CMSIS-DAP[0101]\") by clicking on the \"Removes selected USB filter\" button, and add a new filter by clicking on the \"Adds new USB filter\" button.", - "title": "Enable USB2 and select your device" - }, - { "location": "/os/get_started/native_tools/", "text": "Installing Native Mynewt Tools\n\n\nThis page shows how to install tools for native Mynewt targets (simulated targets on your laptop/computer) without using a Docker container. In other words, it allows you to run Mynewt OS as a native application on your Mac or Linux machine to simulate a target and use the Newt tool running natively on your machine to manage the simulated target. It also allows you to run the test suites for all packages not requiring HW support. You may choose to do this instead of using the build toolchain and Newt tool available in a Docker container.\n\n\nThis page provides guidance for MAC and Linux. See the relevant sections below.\n\n\n\n\nSet up toolchain for Mac\n\n\nInstall Brew\n\n\nIf you have not already installed Homebrew from the \n\nnewt\n tutorials pages\n, install it. \n\n\n\n\nInstall gcc/libc\n\n\nOS X ships with a C compiler called Clang. To build applications for the Mynewt simulator with, a different compiler is used as default: gcc.\n\n\n$ brew install gcc\n...\n...\n==\n Summary\n\ud83c\udf7a /usr/local/Cellar/gcc/5.2.0: 1353 files, 248M\n\n\n\n\n\n\n\nCheck the gcc version you have installed (either using brew or previously installed). The brew-installed version can be checked using \nbrew list gcc\n. The default compiler.yml configuration file in Mynewt expects version 5.x for Mac users, so if the installed version is 6.x and you wish to continue with this newer version, modify the \nmynewt-src-directory\n/repos/apache-mynewt-core/compiler/sim/compiler.yml\n file to change the default \ngcc-5\n defined there to \ngcc-6\n. In other words, replace the lines shown highlighted below:\n\n\n# OS X.\n\ncompiler.path.cc.DARWIN.OVERWRITE: \n/usr/local/bin/gcc-5\n\n\ncompiler.path.as.DARWIN.OVERWRITE: \n/usr/local/bin/gcc-5 -x assembler-with-cpp\n\n\ncompiler.path.objdump.DARWIN.OVERWRITE: \ngobjdump\n\ncompiler.path.objsize.DARWIN.OVERWRITE: \nobjsize\n\ncompiler.path.objcopy.DARWIN.OVERWRITE: \ngobjc opy\n\n\n\n\n\n\nwith the following:\n\n\ncompiler.path.cc.DARWIN.OVERWRITE: \n/usr/local/bin/gcc-6\n\ncompiler.path.as.DARWIN.OVERWRITE: \n/usr/local/bin/gcc-6 -x assembler-with-cpp\u201d\n\n\n\n\n\n\n\nIn case you wish to use Clang, you can change your \nmynewt-src-directory\n/repos/apache-mynewt-core/compiler/sim/compiler.yml\n to use Clang. Delete the gcc-5 DARWIN.OVERWRITE lines highlighted below.\n\n\n# OS X.\n\ncompiler.path.cc.DARWIN.OVERWRITE: \n/usr/local/bin/gcc-5\n\n\ncompiler.path.as.DARWIN.OVERWRITE: \n/usr/local/bin/gcc-5 -x assembler-with-cpp\n\n\ncompiler.path.objdump.DARWIN.OVERWRITE: \ngobjdump\n\ncompiler.path.objsize.DARWIN.OVERWRITE: \nobjsize\n\ncompiler.path.objcopy.DARWIN.OVERWRITE: \ngobjcopy\n\n\n\n\n\n\n\n\nNOTE:\n Both the newer gcc 6.x and Clang report a few warnings but they can be ignored.\n\n\n\n\nFURTHER NOTE:\n Mynewt developers mostly use gcc 5.x for sim builds; so it may take a little while to fix issues reported by the newer compiler. One option is to \ndisable warnings\n. To do that, remove the \n-Werror\n flag as an option for the compiler in the \nmynewt-src-directory\n/repos/apache-mynewt-core/compiler/sim/compiler.yml\n file as shown below. \n\n\ncompiler.flags.base: \n\n\n -m32 -Wall -ggdb\n\n\n\n\n\nYou may alternatively choose to \nspecify the precise warnings to ignore\n depending on the error thrown by the compiler. For example, if you see a \n[-Werror=misleading-indentation]\n error while building the sim image, add \n-Wno-misleading-indentation]\n as a compiler flag in the same line from the \nmynewt-src-directory\n/repos/apache-mynewt-core/compiler/sim/compiler.yml\n file.\n\n\ncompiler.flags.base: \n\n\n -m32 -Wall -Werror -ggdb -Wno-misleading-indentation\n\n\n\n\n\nA third option is to simply \ndowngrade to gcc 5.x\n.\n\n\n\n\nInstall gdb\n\n\n$ brew install gdb\n...\n...\n==\n Summary\n\ud83c\udf7a /usr/local/Cellar/gdb/7.10.1: XXX files,YYM\n\n\n\n\n\n\n\nNOTE:\n When running a program with gdb, y ou may need to sign your gdb\nexecutable. \nThis page\n\nshows a recipe for gdb signing. Alternately you can skip this step and\ncontinue without the ability to debug your mynewt application on your PC.*\n\n\n\n\nSet up toolchain for Linux\n\n\nThe below procedure can be used to set up a Debian-based Linux system (e.g.,\nUbuntu). If you are running a different Linux distribution, you will need to\nsubstitute invocations of \napt-get\n in the below steps with the package manager\nthat your distro uses.\n\n\n\n\nInstall gcc/libc that will produce 32-bit executables:\n\n\n$ sudo apt-get install gcc-multilib libc6-i386\n\n\n\n\n\n\n\nInstall gdb\n\n\n$ sudo apt-get install gdb\n\nReading package lists... Done\nBuilding dependency tree \nReading state information... Done\nSuggested packages:\n gdb-doc gdbserver\nThe following NEW packages will be installed:\n gdb\n...\nProcessing triggers for man-db (2.6.7.1-1ubuntu1) ...\nSetting up gdb (7.7.1-0ubuntu5~14.04.2) ...\n\n\n\n\n\n \n\nAt this point you have installed all the necessary software to build and test code on a simluator running on your Mac or Linux. Proceed to the \nCreate Your First Project\n section.", "title": "toc" @@ -351,6 +306,51 @@ "title": "Install OpenOCD" }, { + "location": "/os/get_started/docker/", + "text": "Everything You Need in a Docker Container\n\n\nDocker provides a quick and easy way to get up and running with Mynewt. The\nnewt command line tool and the entire build toolchain is available in a single\ndocker container. The container is all that's needed to run your Mynewt based\napplication in the simulator. Enabling USB2 with your docker installation will\nallow you to load your application on a supported device.\n\n\nDocker is the only supported option if you are working on a Windows machine. If you are using Mac OS X or Linux, you have the choice of installing a Docker container of tools and toolchains or installing them natively. This chapter describes how to set up the Docker image for all three platforms.\n\n\n\n\nInstall Docker\n\n\nInstall docker for your platform. \nMac OS X\n / \nWindows\n / \nLinux\n\n\nMac and Windows\n\n\nMac and Windows require Docker Toolbox to interact with USB devices. Docker\nfor Mac and Docker for Windows do not support U SB. Docker Toolbox uses\nVirtualBox and allows you to map USB devices into docker containers as\ndescribed below.\n\n\nMake sure to double click the Docker Quickstart Terminal application if you're\non Mac or Windows.\n\n\nLinux\n\n\nThe docker daemon listens on a Unix domain socket on Linux. That socket is\nowned by root, which means by default you must be root to start a container.\nMake sure to follow the optional step of adding yourself to the docker group so\nyou can start the newt container as yourself.\n\n\n\n\nUse the newt wrapper script\n\n\nUse the newt wrapper script to invoke newt. Create the following file, name it\n\nnewt\n, make it executable, and put it in your path. This will allow you to run newt as if it was natively installed. You can now follow the normal tutorials using the newt wrapper script.\n\n\n#!/bin/bash\n\n\n\nif\n \n[\n \n$1\n \n=\n \ndebug\n \n]\n \n||\n \n[\n \n$1\n \n=\n \nrun\n \n]\n\n\nthen\n\n \nti=\n-ti\n\n\nfi\n\n\ndocker run -e \nNEWT_US ER=\n$(\nid -u\n)\n -e \nNEWT_GROUP=\n$(\nid -g\n)\n -e \nNEWT_HOST=\n$(\nuname\n)\n \n$ti\n --rm --device\n=\n/dev/bus/usb --privileged -v \n$(pwd)\n:/workspace -w /workspace mynewt/newt:latest /newt \n$@\n\n\n\n\n\n\n\n\nNote 1:\n Remember to point to the correct subdirectory level when invoking \nnewt\n. For example, invoke it using \n../newt\n in the example below.\n\n\nuser@~/dockertest$ ls\nmyproj newt\nuser@~/dockertest$ cd myproj\n\nuser@~/dockertest/myproj$ ../newt version\n\nApache Newt (incubating) version: 0.8.0-b2\n\n\n\n\n\n\n\nNote 2:\n You can upgrade your container by running \ndocker pull mynewt/newt:latest\n when updates are made available.\n\n\n\n\nEnable USB2 Support for Mac or Windows\n\n\nIf you plan on loading your application on an actual device, do the steps below.\n\n\n\n\nInstall VirtualBox extension pack\n\n\nDocker uses a VirtualBox Linux VM to run containers. A free VirtualBox\nextension pack is required to enable USB2 support. Download the \nVirtua lBox\n5.0.16 Oracle VM VirtualBox Extension\nPack\n\nand double click to install\n\n\n\n\nEnable USB2 and select your device\n\n\n\n\n\n\nThe \"default\" VM created by docker-machine must first be stopped before you\n can enable USB2. You have two options:\n\n\n\n\nRun the command \ndocker-machine stop default\n in the terminal window or\n\n\nUse the VirtualBox UI. Right click on \ndefault\n -\n Close -\n Power Off\n\n\n\n\n\n\n\n\nEnable USB2 using the VirtualBox UI. Select the \"default\"\n VM-\nSettings-\nPorts-\nUSB2 to enable USB2. Add your device to the USB Device\n Filters to make the device visible in the docker container. See the image below.\n\n\n\n\n\n\n\n\n\n\nRestart the \"default\" VM. You have two options:\n\n\nRun \ndocker-machine start default\n in the terminal window or \n\n\nUse the VirtualBox UI. Make sure the \"default\" machine is highlighted. Click the green \"Start\" button. Select \"Headless Start\".\n\n\n\n\n\n\n\n\n\n\nNote 3\n: When working with ac tual hardware, remember that each board has an ID. If you swap boards and do not refresh the USB Device Filter on the VirtualBox UI, the ID might be stale and the Docker instance may not be able to see the board correctly. For example, you may see an error message like \nError: unable to find CMSIS-DAP device\n when you try to load or run an image on the board. In that case, you need to click on the USB link in VirtualBox UI, remove the existing USB Device Filter (e.g. \"Atmel Corp. EDBG CMSIS-DAP[0101]\") by clicking on the \"Removes selected USB filter\" button, and add a new filter by clicking on the \"Adds new USB filter\" button.", + "title": "Docker Container Option" + }, + { + "location": "/os/get_started/docker/#everything-you-need-in-a-docker-container", + "text": "Docker provides a quick and easy way to get up and running with Mynewt. The\nnewt command line tool and the entire build toolchain is available in a single\ndocker container. The container is all that's needed to run your Mynewt based\napplication in the simulator. Enabling USB2 with your docker installation will\nallow you to load your application on a supported device. Docker is the only supported option if you are working on a Windows machine. If you are using Mac OS X or Linux, you have the choice of installing a Docker container of tools and toolchains or installing them natively. This chapter describes how to set up the Docker image for all three platforms.", + "title": "Everything You Need in a Docker Container" + }, + { + "location": "/os/get_started/docker/#install-docker", + "text": "Install docker for your platform. Mac OS X / Windows / Linux", + "title": "Install Docker" + }, + { + "location": "/os/get_started/docker/#mac-and-windows", + "text": "Mac and Windows require Docker Toolbox to interact with USB devices. Docker\nfor Mac and Docker for Windows do not support USB. Docker Toolbox uses\nVirtualBox and allows you to map USB devices into docker containers as\ndescribed below. Make sure to double click the Docker Quickstart Terminal application if you're\non Mac or Windows.", + "title": "Mac and Windows" + }, + { + "location": "/os/get_started/docker/#linux", + "text": "The docker daemon listens on a Unix domain socket on Linux. That socket is\nowned by root, which means by default you must be root to start a container.\nMake sure to follow the optional step of adding yourself to the docker group so\nyou can start the newt container as yourself.", + "title": "Linux" + }, + { + "location": "/os/get_started/docker/#use-the-newt-wrapper-script", + "text": "Use the newt wrapper script to invoke newt. Create the following file, name it newt , make it executable, and put it in your path. This will allow you to run newt as if it was natively installed. You can now follow the normal tutorials using the newt wrapper script. #!/bin/bash if [ $1 = debug ] || [ $1 = run ] then \n ti= -ti fi \n\ndocker run -e NEWT_USER= $( id -u ) -e NEWT_GROUP= $( id -g ) -e NEWT_HOST= $( uname ) $ti --rm --device = /dev/bus/usb --privileged -v $(pwd) :/workspace -w /workspace mynewt/newt:latest /newt $@ Note 1: Remember to point to the correct subdirectory level when invoking newt . For example, invoke it using ../newt in the example below. user@~/dockertest$ ls\nmyproj newt\nuser@~/dockertest$ cd myproj user@~/dockertest/myproj$ ../newt version Apache Newt (incubating) version: 0.8.0-b2 Note 2: You can upgrade your container by running docker pull mynewt/newt:latest when updates are made available.", + "title": "Use the newt wrapper script" + }, + { + "location": "/os/get_started/docker/#enable-usb2-support-for-mac-or-windows", + "text": "If you plan on loading your application on an actual device, do the steps below.", + "title": "Enable USB2 Support for Mac or Windows" + }, + { + "location": "/os/get_started/docker/#install-virtualbox-extension-pack", + "text": "Docker uses a VirtualBox Linux VM to run containers. A free VirtualBox\nextension pack is required to enable USB2 support. Download the VirtualBox\n5.0.16 Oracle VM VirtualBox Extension\nPack \nand double click to install", + "title": "Install VirtualBox extension pack" + }, + { + "location": "/os/get_started/docker/#enable-usb2-and-select-your-device", + "text": "The \"default\" VM created by docker-machine must first be stopped before you\n can enable USB2. You have two options: Run the command docker-machine stop default in the terminal window or Use the VirtualBox UI. Right click on default - Close - Power Off Enable USB2 using the VirtualBox UI. Select the \"default\"\n VM- Settings- Ports- USB2 to enable USB2. Add your device to the USB Device\n Filters to make the device visible in the docker container. See the image below. Restart the \"default\" VM. You have two options: Run docker-machine start default in the terminal window or Use the VirtualBox UI. Make sure the \"default\" machine is highlighted. Click the green \"Start\" button. Select \"Headless Start\". Note 3 : When working with actual hardware, remember that each board has an ID. If you swap boards and do not refresh the USB Device Filter on the VirtualBox UI, the ID might be stale and the Docker instance may not be abl e to see the board correctly. For example, you may see an error message like Error: unable to find CMSIS-DAP device when you try to load or run an image on the board. In that case, you need to click on the USB link in VirtualBox UI, remove the existing USB Device Filter (e.g. \"Atmel Corp. EDBG CMSIS-DAP[0101]\") by clicking on the \"Removes selected USB filter\" button, and add a new filter by clicking on the \"Adds new USB filter\" button.", + "title": "Enable USB2 and select your device" + }, + { "location": "/os/get_started/project_create/", "text": "Create Your First Mynewt Project\n\n\nThis page shows how to create a Mynewt Project using the \nnewt\n command-line tool.\n\n\n\n\nPre-Requisites\n\n\n\n\nNewt:\n\n\nIf you have taken the Docker route, you have already installed Newt.\n\n\nIf you have taken the native install route, you have to ensure that you have installed the Newt tool following the instructions for \nMac\n or \nLinux\n as appropriate, and that the \nnewt\n command is in your system path. \n\n\n\n\n\n\nYou must have Internet connectivity to fetch remote Mynewt components.\n\n\nYou must \ninstall the compiler tools\n to \nsupport native compiling to build the project this tutorial creates. \n\n\n\n\n\n\nNewt New\n\n\nChoose a project name. For this tutorial we will call this project \nmyproj\n.\nEnter the \nnewt new myproj\n command. \n\n\n$ newt new myproj\nDownloading project skeleton from apache/incubator-mynewt-blinky...\nInstalling skeleton in myproj...\nProject myproj successfully crea ted.\n\n\n\n\n\n\n\nNewt populates this new project with a base skeleton of a new Apache Mynewt \nproject. It has the following structure. \n\n\nNote\n: If you do not have \ntree\n, install it by running \nbrew install tree\n.\n\n\n$ cd myproj\n$ tree \n.\n\u251c\u2500\u2500 DISCLAIMER\n\u251c\u2500\u2500 LICENSE\n\u251c\u2500\u2500 NOTICE\n\u251c\u2500\u2500 README.md\n\u251c\u2500\u2500 apps\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 blinky\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 pkg.yml\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 src\n\u251c\u2500\u2500 project.yml\n\u2514\u2500\u2500 targets\n \u251c\u2500\u2500 my_blinky_sim\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 pkg.yml\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 target.yml\n \u2514\u2500\u2500 unittest\n \u251c\u2500\u2500 pkg.yml\n \u2514\u2500\u2500 target.yml\n\n6 directories, 10 files\n\n\n\n\n\n\n\nThe Newt tool has installed the base files for a project comprising the following:\n\n\n\n\nThe file \ nproject.yml\n contains the repository list that the project uses to fetch\nits packages. Your project is a collection of repositories. In this case, the project just\ncomprises the core mynewt repository. Later you will add more repositories\nto include other mynewt components.\n\n\nThe file \napps/blinky/pkg.yml\n contains the description of your application\nand its package dependencies.\n\n\nA \ntarget\n directory containing \nmy_blinky_sim\n, a target descriptor used to\nbuild a version of myproj. Use \nnewt target show\n to see available build \ntargets.\n\n\nA non-buildable target called \nunittest\n. This is used internally by \nnewt\n and is not a formal build target.\n\n\n\n\nNOTE:\n the actual code and package files are not installed \n(except the template for \nmain.c\n). See the next step for installing the packages.\n\n\n\n\nNewt Install\n\n\nOnce you've switched into your new project's directory, the next step is to fetch\nany dependencies this project has. By d efault, all Newt projects rely on a\nsingle remote repository, apache-mynewt-core. The \nnewt install\n command will\nfetch this repository.\n\n\n$ newt install\napache-mynewt-core\n\n\n\n\n\nNOTE:\n \napache-mynewt-core\n may take a while to download. To see progress,\nuse the \n-v\n (verbose) option to install. \n\n\n\n\nOnce \nnewt install\n has successfully finished, the contents of \napache-mynewt-core\n will have been downloaded into your local directory. You can view them by issuing the following commands in the base directory of the new project:\n\n\n$ tree -L 2 repos/apache-mynewt-core/\n.\n\nsnip\n\n\u251c\u2500\u2500 fs\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 fs\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 nffs\n\u251c\u2500\u2500 hw\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 bsp\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 hal\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 mcu\n\u251c\u2500\u2500 libs\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 baselibc\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 bootu til\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 cmsis-core\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 console\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 elua\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 flash_test\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 imgmgr\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 json\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 mbedtls\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 newtmgr\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 os\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 shell\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 testreport\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 testutil\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 util\n\u251c\u2500\u2500 net\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 nimble\n\nsnip\n\n\n\n\n\n\nAs you can see, the core of the Apache Mynewt operating system has been brought \ninto your local directory. \n\n\n\n\nTest the project's packages\n\n\nYou have already built your first basic project. You can ask Newt to execute the unit tests in a package. For example, to test the \nlibs/os\n pac kage in the \napache-mynewt-core\n repo, call newt as shown below.\n\n\n$ newt test @apache-mynewt-core/libs/os\nTesting package @apache-mynewt-core/libs/os\nCompiling hal_bsp.c\nCompiling os_bsp.c\nCompiling sbrk.c\nArchiving native.a\nCompiling flash_map.c\n\nsnip\n\n\n\n\n\n\n\n\nTo test all the packages in a project, specify \nall\n instead of the package name.\n\n\n$ newt test all\n...lots of compiling and testing...\n...about 2 minutes later ...\nArchiving bootutil.a\nLinking test_bootutil\nExecuting test: /myproj/bin/unittest/libs/bootutil/test_bootutil\nPassed tests: [net/nimble/host fs/nffs libs/os hw/hal libs/mbedtls libs/util sys/config libs/bootutil]\nAll tests passed\n\n\n\n\n\n\n\nBuild the Project\n\n\nTo build and run your new application, simply issue the following command:\n\n\n$ newt build my_blinky_sim \nCompiling base64.c\nCompiling cbmem.c\nCompiling datetime.c\nCompiling tpq.c\nArchiving util.a\nCompiling main.c\nArchiving blinky.a\nCompiling flash_map.c\nComp iling hal_flash.c\nArchiving hal.a\nCompiling cons_fmt.c\nCompiling cons_tty.c\n\nsnip\n\nLinking blinky.elf\nApp successfully built: /Users/sterling/dev/tmp/my_app/bin/my_blinky_sim/apps/blinky/blinky.elf\n\n\n\n\n\n\n\nRun the Project\n\n\nYou can run the simulated version of your project and see the simulated LED\nblink.\n\n\n$ newt run my_blinky_sim\nNo download script for BSP hw/bsp/native\nDebugging /workspace/bin/my_blinky_sim/apps/blinky/blinky.elf\n\nsnip\n\nReading symbols from /workspace/bin/my_blinky_sim/apps/blinky/blinky.elf...done.\n(gdb)\n\n\n\n\n\nType \nr\n at the \n(gdb)\n prompt to run the project. You will see an output indicating that the \nhal_gpio\n pin is toggling between 1 and 0 in a simulated blink. \n\n\n\n\nComplete\n\n\nCongratulations, you have created your first project! The blinky application\nis not terribly exciting when it is run in the simulator, as there is no LED to\nblink. Apache Mynewt has a lot more functionality than just running simulate d\napplications. It provides all the features you'll need to cross-compile your\napplication, run it on real hardware and develop a full featured application.\n\n\nIf you're interested in learning more, a good next step is to dig in to one of\nthe \ntutorials\n and get a Mynewt project running on real hardware.\n\n\nHappy Hacking!", "title": "Create Your First Project" http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b3522a13/newt/install/newt_linux/index.html ---------------------------------------------------------------------- diff --git a/newt/install/newt_linux/index.html b/newt/install/newt_linux/index.html index c74c467..e955517 100644 --- a/newt/install/newt_linux/index.html +++ b/newt/install/newt_linux/index.html @@ -211,14 +211,6 @@ - <li > - <a href="../../../os/get_started/docker/">Docker Container Option</a> - </li> - - - - - <li ><a href="../../../os/get_started/native_tools/">Native install Option</a> @@ -261,6 +253,14 @@ <li > + <a href="../../../os/get_started/docker/">Docker Container Option</a> + </li> + + + + + + <li > <a href="../../../os/get_started/project_create/">Create Your First Project</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b3522a13/newt/install/newt_mac/index.html ---------------------------------------------------------------------- diff --git a/newt/install/newt_mac/index.html b/newt/install/newt_mac/index.html index b0c51b6..a2aee70 100644 --- a/newt/install/newt_mac/index.html +++ b/newt/install/newt_mac/index.html @@ -211,14 +211,6 @@ - <li > - <a href="../../../os/get_started/docker/">Docker Container Option</a> - </li> - - - - - <li ><a href="../../../os/get_started/native_tools/">Native install Option</a> @@ -261,6 +253,14 @@ <li > + <a href="../../../os/get_started/docker/">Docker Container Option</a> + </li> + + + + + + <li > <a href="../../../os/get_started/project_create/">Create Your First Project</a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b3522a13/os/get_started/cross_tools/index.html ---------------------------------------------------------------------- diff --git a/os/get_started/cross_tools/index.html b/os/get_started/cross_tools/index.html index 29ac564..9e3a4a8 100644 --- a/os/get_started/cross_tools/index.html +++ b/os/get_started/cross_tools/index.html @@ -211,14 +211,6 @@ - <li > - <a href="../docker/">Docker Container Option</a> - </li> - - - - - <li ><a href="../native_tools/">Native install Option</a> @@ -261,6 +253,14 @@ <li > + <a href="../docker/">Docker Container Option</a> + </li> + + + + + + <li > <a href="../project_create/">Create Your First Project</a> </li> @@ -471,8 +471,8 @@ The direct link to the amd64 build is </li> <li class="pull-right"> - <a href=../project_create/> - Next: Create Your First Project + <a href=../docker/> + Next: Docker Container Option <span class="fa fa-arrow-right"></span> </a> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b3522a13/os/get_started/docker/index.html ---------------------------------------------------------------------- diff --git a/os/get_started/docker/index.html b/os/get_started/docker/index.html index 39efa87..21c30de 100644 --- a/os/get_started/docker/index.html +++ b/os/get_started/docker/index.html @@ -211,19 +211,19 @@ - <li class="active"> - <a href="./">Docker Container Option</a> + + + <li ><a href="../native_tools/">Native install Option</a> + + </li> - - - <li ><a href="../native_tools/">Native install Option</a> - - + <li class="active"> + <a href="./">Docker Container Option</a> </li> @@ -449,16 +449,16 @@ and double click to install</p> <ul class="nav nav-pills" style="margin-bottom: 10px"> <li> - <a href=../get_started/> + <a href=../cross_tools/> <span class="fa fa-arrow-left"></span> - Previous: Basic Setup + Previous: Install Cross Tools for ARM </a> </li> <li class="pull-right"> - <a href=../native_tools/> - Next: Native install Option + <a href=../project_create/> + Next: Create Your First Project <span class="fa fa-arrow-right"></span> </a> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b3522a13/os/get_started/get_started/index.html ---------------------------------------------------------------------- diff --git a/os/get_started/get_started/index.html b/os/get_started/get_started/index.html index 3e6cfb2..b3027ef 100644 --- a/os/get_started/get_started/index.html +++ b/os/get_started/get_started/index.html @@ -211,19 +211,19 @@ - <li > - <a href="../docker/">Docker Container Option</a> + + + <li ><a href="../native_tools/">Native install Option</a> + + </li> - - - <li ><a href="../native_tools/">Native install Option</a> - - + <li > + <a href="../docker/">Docker Container Option</a> </li> @@ -381,8 +381,8 @@ </li> <li class="pull-right"> - <a href=../docker/> - Next: Docker Container Option + <a href=../native_tools/> + Next: Native install Option <span class="fa fa-arrow-right"></span> </a> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b3522a13/os/get_started/native_tools/index.html ---------------------------------------------------------------------- diff --git a/os/get_started/native_tools/index.html b/os/get_started/native_tools/index.html index 460542e..b90cff0 100644 --- a/os/get_started/native_tools/index.html +++ b/os/get_started/native_tools/index.html @@ -211,14 +211,6 @@ - <li > - <a href="../docker/">Docker Container Option</a> - </li> - - - - - <li class="active"><a href="./">Native install Option</a> @@ -261,6 +253,14 @@ <li > + <a href="../docker/">Docker Container Option</a> + </li> + + + + + + <li > <a href="../project_create/">Create Your First Project</a> </li> @@ -499,9 +499,9 @@ Setting up gdb (7.7.1-0ubuntu5~14.04.2) ... <ul class="nav nav-pills" style="margin-bottom: 10px"> <li> - <a href=../docker/> + <a href=../get_started/> <span class="fa fa-arrow-left"></span> - Previous: Docker Container Option + Previous: Basic Setup </a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b3522a13/os/get_started/project_create/index.html ---------------------------------------------------------------------- diff --git a/os/get_started/project_create/index.html b/os/get_started/project_create/index.html index 3fadafa..04ccfe7 100644 --- a/os/get_started/project_create/index.html +++ b/os/get_started/project_create/index.html @@ -211,19 +211,19 @@ - <li > - <a href="../docker/">Docker Container Option</a> + + + <li ><a href="../native_tools/">Native install Option</a> + + </li> - - - <li ><a href="../native_tools/">Native install Option</a> - - + <li > + <a href="../docker/">Docker Container Option</a> </li> @@ -553,9 +553,9 @@ the <a href="../../tutorials/tutorials">tutorials</a> and get a Mynewt project r <ul class="nav nav-pills" style="margin-bottom: 10px"> <li> - <a href=../cross_tools/> + <a href=../docker/> <span class="fa fa-arrow-left"></span> - Previous: Install Cross Tools for ARM + Previous: Docker Container Option </a> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b3522a13/sitemap.xml ---------------------------------------------------------------------- diff --git a/sitemap.xml b/sitemap.xml index e6b3f19..4efdb16 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -4,7 +4,7 @@ <url> <loc>http://mynewt.apache.org/</loc> - <lastmod>2017-04-07</lastmod> + <lastmod>2017-04-18</lastmod> <changefreq>daily</changefreq> </url> @@ -13,13 +13,13 @@ <url> <loc>http://mynewt.apache.org/pages/ble/</loc> - <lastmod>2017-04-07</lastmod> + <lastmod>2017-04-18</lastmod> <changefreq>daily</changefreq> </url> <url> <loc>http://mynewt.apache.org/pages/securitybullets/</loc> - <lastmod>2017-04-07</lastmod> + <lastmod>2017-04-18</lastmod> <changefreq>daily</changefreq> </url> @@ -28,7 +28,7 @@ <url> <loc>http://mynewt.apache.org/quick-start/</loc> - <lastmod>2017-04-07</lastmod> + <lastmod>2017-04-18</lastmod> <changefreq>daily</changefreq> </url> @@ -36,7 +36,7 @@ <url> <loc>http://mynewt.apache.org/about/</loc> - <lastmod>2017-04-07</lastmod> + <lastmod>2017-04-18</lastmod> <changefreq>daily</changefreq> </url> @@ -44,7 +44,7 @@ <url> <loc>http://mynewt.apache.org/talks/</loc> - <lastmod>2017-04-07</lastmod> + <lastmod>2017-04-18</lastmod> <changefreq>daily</changefreq> </url> @@ -52,7 +52,7 @@ <url> <loc>http://mynewt.apache.org/download/</loc> - <lastmod>2017-04-07</lastmod> + <lastmod>2017-04-18</lastmod> <changefreq>daily</changefreq> </url> @@ -60,7 +60,7 @@ <url> <loc>http://mynewt.apache.org/community/</loc> - <lastmod>2017-04-07</lastmod> + <lastmod>2017-04-18</lastmod> <changefreq>daily</changefreq> </url> @@ -68,7 +68,7 @@ <url> <loc>http://mynewt.apache.org/events/</loc> - <lastmod>2017-04-07</lastmod> + <lastmod>2017-04-18</lastmod> <changefreq>daily</changefreq> </url> @@ -77,7 +77,7 @@ <url> <loc>http://mynewt.apache.org/os/introduction/</loc> - <lastmod>2017-04-07</lastmod> + <lastmod>2017-04-18</lastmod> <changefreq>daily</changefreq> </url> @@ -89,7 +89,7 @@ <url> <loc>http://mynewt.apache.org/os/get_started/vocabulary/</loc> - <lastmod>2017-04-07</lastmod> + <lastmod>2017-04-18</lastmod> <changefreq>daily</changefreq> </url> @@ -129,13 +129,13 @@ <url> <loc>http://mynewt.apache.org/faq/how_to_edit_docs/</loc> - <lastmod>2017-04-07</lastmod> + <lastmod>2017-04-18</lastmod> <changefreq>daily</changefreq> </url> <url> <loc>http://mynewt.apache.org/faq/answers/</loc> - <lastmod>2017-04-07</lastmod> + <lastmod>2017-04-18</lastmod> <changefreq>daily</changefreq> </url> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b3522a13/v0_9_0/sitemap.xml ---------------------------------------------------------------------- diff --git a/v0_9_0/sitemap.xml b/v0_9_0/sitemap.xml index e6b3f19..4efdb16 100644 --- a/v0_9_0/sitemap.xml +++ b/v0_9_0/sitemap.xml @@ -4,7 +4,7 @@ <url> <loc>http://mynewt.apache.org/</loc> - <lastmod>2017-04-07</lastmod> + <lastmod>2017-04-18</lastmod> <changefreq>daily</changefreq> </url> @@ -13,13 +13,13 @@ <url> <loc>http://mynewt.apache.org/pages/ble/</loc> - <lastmod>2017-04-07</lastmod> + <lastmod>2017-04-18</lastmod> <changefreq>daily</changefreq> </url> <url> <loc>http://mynewt.apache.org/pages/securitybullets/</loc> - <lastmod>2017-04-07</lastmod> + <lastmod>2017-04-18</lastmod> <changefreq>daily</changefreq> </url> @@ -28,7 +28,7 @@ <url> <loc>http://mynewt.apache.org/quick-start/</loc> - <lastmod>2017-04-07</lastmod> + <lastmod>2017-04-18</lastmod> <changefreq>daily</changefreq> </url> @@ -36,7 +36,7 @@ <url> <loc>http://mynewt.apache.org/about/</loc> - <lastmod>2017-04-07</lastmod> + <lastmod>2017-04-18</lastmod> <changefreq>daily</changefreq> </url> @@ -44,7 +44,7 @@ <url> <loc>http://mynewt.apache.org/talks/</loc> - <lastmod>2017-04-07</lastmod> + <lastmod>2017-04-18</lastmod> <changefreq>daily</changefreq> </url> @@ -52,7 +52,7 @@ <url> <loc>http://mynewt.apache.org/download/</loc> - <lastmod>2017-04-07</lastmod> + <lastmod>2017-04-18</lastmod> <changefreq>daily</changefreq> </url> @@ -60,7 +60,7 @@ <url> <loc>http://mynewt.apache.org/community/</loc> - <lastmod>2017-04-07</lastmod> + <lastmod>2017-04-18</lastmod> <changefreq>daily</changefreq> </url> @@ -68,7 +68,7 @@ <url> <loc>http://mynewt.apache.org/events/</loc> - <lastmod>2017-04-07</lastmod> + <lastmod>2017-04-18</lastmod> <changefreq>daily</changefreq> </url> @@ -77,7 +77,7 @@ <url> <loc>http://mynewt.apache.org/os/introduction/</loc> - <lastmod>2017-04-07</lastmod> + <lastmod>2017-04-18</lastmod> <changefreq>daily</changefreq> </url> @@ -89,7 +89,7 @@ <url> <loc>http://mynewt.apache.org/os/get_started/vocabulary/</loc> - <lastmod>2017-04-07</lastmod> + <lastmod>2017-04-18</lastmod> <changefreq>daily</changefreq> </url> @@ -129,13 +129,13 @@ <url> <loc>http://mynewt.apache.org/faq/how_to_edit_docs/</loc> - <lastmod>2017-04-07</lastmod> + <lastmod>2017-04-18</lastmod> <changefreq>daily</changefreq> </url> <url> <loc>http://mynewt.apache.org/faq/answers/</loc> - <lastmod>2017-04-07</lastmod> + <lastmod>2017-04-18</lastmod> <changefreq>daily</changefreq> </url>
