versions/v0_9_0/mkdocs.yml (405 lines of code) (raw):

site_name: Apache Mynewt site_url: http://mynewt.apache.org theme: name: null custom_dir: "custom-theme" nav: - Home: 'index.md' - Quick Start: 'quick-start.md' - About: 'about.md' - Download: 'download.md' - Community: 'community.md' - Events: 'events.md' - Mynewt Documentation: - toc: 'os/introduction.md' - Basic Setup: - toc: 'os/get_started/get_started.md' - 'Docker Container Option': 'os/get_started/docker.md' - 'Native install Option': - toc: 'os/get_started/native_tools.md' - 'Install Newt on Mac': 'newt/install/newt_mac.md' - 'Install Newt on Linux': 'newt/install/newt_linux.md' - 'Install Cross Tools for ARM': 'os/get_started/cross_tools.md' - 'Create Your First Project': 'os/get_started/project_create.md' - Concepts: 'os/get_started/vocabulary.md' - Tutorials: - toc: 'os/tutorials/tutorials.md' - 'Project Blinky': - 'Blinky on Arduino Zero': 'os/tutorials/arduino_zero.md' - 'Blinky on Arduino Primo': 'os/tutorials/blinky_primo.md' - 'Blinky on Olimex': 'os/tutorials/olimex.md' - 'Blinky on STM32F303': - toc: 'os/tutorials/STM32F303.md' - 'Pinwheel Blinky': 'os/tutorials/pin-wheel-mods.md' - 'Blinky on nRF52': 'os/tutorials/nRF52.md' - 'Run Blinky from SRAM, no bootloader': 'os/tutorials/blinky_sram_olimex.md' - 'Work with repositories': - toc: 'os/tutorials/repo/add_repos.md' - 'Upgrade a repo': 'os/tutorials/repo/upgrade_repo.md' - 'Turn project into a repo': 'os/tutorials/repo/create_repo.md' - 'Write a Test Suite for a Package': 'os/tutorials/unit_test.md' - 'Air-quality Sensor project': 'os/tutorials/air_quality_sensor.md' - 'Add task to manage multiple events': 'os/tutorials/event_queue.md' - 'Enable remote comms on sim device': 'os/tutorials/project-slinky.md' - 'Enable remote comms on STM32 board': 'os/tutorials/project-target-slinky.md' - 'BLE app to check stats via console': 'os/tutorials/bletiny_project.md' - 'BLE peripheral project': - toc: 'os/tutorials/bleprph/bleprph-intro.md' - 'Service Registration': 'os/tutorials/bleprph/bleprph-svc-reg.md' - 'Characteristic Access': 'os/tutorials/bleprph/bleprph-chr-access.md' - 'Advertising': 'os/tutorials/bleprph/bleprph-adv.md' - 'Connection Callbacks': 'os/tutorials/bleprph/bleprph-conn.md' - 'BLE iBeacon': 'os/tutorials/ibeacon.md' - 'BLE HCI interface': 'os/tutorials/blehci_project.md' - OS User Guide: - toc: 'os/os_user_guide.md' - OS Core: - toc: 'os/core_os/mynewt_os.md' - System-level Functions: - 'os_init': 'os/core_os/os_init.md' - 'os_start': 'os/core_os/os_start.md' - 'os_started': 'os/core_os/os_started.md' - Scheduler: - toc: 'os/core_os/context_switch/context_switch.md' - 'Functions': - 'os_sched': 'os/core_os/context_switch/os_sched.md' - 'os_arch_ctx_sw': 'os/core_os/context_switch/os_arch_ctx_sw.md' - 'os_sched_ctx_sw_hook': 'os/core_os/context_switch/os_sched_ctx_sw_hook.md' - 'os_sched_get_current_task': 'os/core_os/context_switch/os_sched_get_current_task.md' - 'os_sched_insert': 'os/core_os/context_switch/os_sched_insert.md' - 'os_sched_next_task': 'os/core_os/context_switch/os_sched_next_task.md' - 'os_sched_os_timer_exp': 'os/core_os/context_switch/os_sched_os_timer_exp.md' - 'os_sched_resort': 'os/core_os/context_switch/os_sched_resort.md' - 'os_sched_set_current_task': 'os/core_os/context_switch/os_sched_set_current_task.md' - 'os_sched_sleep': 'os/core_os/context_switch/os_sched_sleep.md' - 'os_sched_wakeup': 'os/core_os/context_switch/os_sched_wakeup.md' - Time: - toc: 'os/core_os/time/os_time.md' - 'Functions': - 'os_time_delay': 'os/core_os/time/os_time_delay.md' - 'os_time_get': 'os/core_os/time/os_time_get.md' - 'os_time_tick': 'os/core_os/time/os_time_tick.md' - 'os_gettimeofday': 'os/core_os/time/os_gettimeofday.md' - 'os_settimeofday': 'os/core_os/time/os_settimeofday.md' - Tasks: - toc: 'os/core_os/task/task.md' - 'Functions': - 'os_task_count': 'os/core_os/task/os_task_count.md' - 'os_task_info_get_next': 'os/core_os/task/os_task_info_get_next.md' - 'os_task_init': 'os/core_os/task/os_task_init.md' - Event Queues: - toc: 'os/core_os/event_queue/event_queue.md' - 'Functions': - 'os_eventq_get': 'os/core_os/event_queue/os_eventq_get.md' - 'os_eventq_init': 'os/core_os/event_queue/os_eventq_init.md' - 'os_eventq_put': 'os/core_os/event_queue/os_eventq_put.md' - 'os_eventq_remove': 'os/core_os/event_queue/os_eventq_remove.md' - Semaphores: - toc: 'os/core_os/semaphore/semaphore.md' - 'Functions': - 'os_sem_init': 'os/core_os/semaphore/os_sem_init.md' - 'os_sem_pend': 'os/core_os/semaphore/os_sem_pend.md' - 'os_sem_release': 'os/core_os/semaphore/os_sem_release.md' - Mutexes: - toc: 'os/core_os/mutex/mutex.md' - 'Functions': - 'os_mutex_init': 'os/core_os/mutex/os_mutex_init.md' - 'os_mutex_pend': 'os/core_os/mutex/os_mutex_pend.md' - 'os_mutex_release': 'os/core_os/mutex/os_mutex_release.md' - Memory Pools: - toc: 'os/core_os/memory_pool/memory_pool.md' - 'Functions/Macros': - 'os_memblock_get': 'os/core_os/memory_pool/os_memblock_get.md' - 'os_mempool_init': 'os/core_os/memory_pool/os_mempool_init.md' - 'os_memblock_put': 'os/core_os/memory_pool/os_memblock_put.md' - 'OS_MEMPOOL_BYTES': 'os/core_os/memory_pool/OS_MEMPOOL_BYTES.md' - 'OS_MEMPOOL_SIZE': 'os/core_os/memory_pool/OS_MEMPOOL_SIZE.md' - Heap: - toc: 'os/core_os/heap/heap.md' - 'Functions': - 'os_free': 'os/core_os/heap/os_free.md' - 'os_malloc': 'os/core_os/heap/os_malloc.md' - 'os_realloc': 'os/core_os/heap/os_realloc.md' - Memory Buffers: - Mbuf: - toc: 'os/core_os/mbuf/mbuf.md' - 'Functions/Macros': - 'OS_MBUF_PKTHDR': 'os/core_os/mbuf/OS_MBUF_PKTHDR.md' - 'OS_MBUF_PKTHDR_TO_MBUF': 'os/core_os/mbuf/OS_MBUF_PKTHDR_TO_MBUF.md' - 'OS_MBUF_PKTLEN': 'os/core_os/mbuf/OS_MBUF_PKTLEN.md' - 'OS_MBUF_DATA': 'os/core_os/mbuf/OS_MBUF_DATA.md' - 'OS_MBUF_USRHDR': 'os/core_os/mbuf/OS_MBUF_USRHDR.md' - 'OS_MBUF_USRHDR_LEN': 'os/core_os/mbuf/OS_MBUF_USRHDR_LEN.md' - 'OS_MBUF_LEADINGSPACE': 'os/core_os/mbuf/OS_MBUF_LEADINGSPACE.md' - 'OS_MBUF_TRAILINGSPACE': 'os/core_os/mbuf/OS_MBUF_TRAILINGSPACE.md' - 'os_mbuf_adj': 'os/core_os/mbuf/os_mbuf_adj.md' - 'os_mbuf_append': 'os/core_os/mbuf/os_mbuf_append.md' - 'os_mbuf_concat': 'os/core_os/mbuf/os_mbuf_concat.md' - 'os_mbuf_copydata': 'os/core_os/mbuf/os_mbuf_copydata.md' - 'os_mbuf_copyinto': 'os/core_os/mbuf/os_mbuf_copyinto.md' - 'os_mbuf_dup': 'os/core_os/mbuf/os_mbuf_dup.md' - 'os_mbuf_extend': 'os/core_os/mbuf/os_mbuf_extend.md' - 'os_mbuf_free_chain': 'os/core_os/mbuf/os_mbuf_free_chain.md' - 'os_mbuf_get': 'os/core_os/mbuf/os_mbuf_get.md' - 'os_mbuf_get_pkthdr': 'os/core_os/mbuf/os_mbuf_get_pkthdr.md' - 'os_mbuf_memcmp': 'os/core_os/mbuf/os_mbuf_memcmp.md' - 'os_mbuf_off': 'os/core_os/mbuf/os_mbuf_off.md' - 'os_mbuf_pool_init': 'os/core_os/mbuf/os_mbuf_pool_init.md' - 'os_mbuf_prepend': 'os/core_os/mbuf/os_mbuf_prepend.md' - 'os_mbuf_pullup': 'os/core_os/mbuf/os_mbuf_pullup.md' - Msys: - toc: 'os/core_os/msys/msys.md' - 'Functions': - 'os_msys_get': 'os/core_os/msys/os_msys_get.md' - 'os_msys_get_pkthdr': 'os/core_os/msys/os_msys_get_pkthdr.md' - 'os_msys_register': 'os/core_os/msys/os_msys_register.md' - 'os_msys_reset': 'os/core_os/msys/os_msys_reset.md' - MQueue: - toc: 'os/core_os/mqueue/mqueue.md' - Functions: - 'os_mqueue_init': 'os/core_os/mqueue/os_mqueue_init.md' - 'os_mqueue_get': 'os/core_os/mqueue/os_mqueue_get.md' - 'os_mqueue_put': 'os/core_os/mqueue/os_mqueue_put.md' - Sanity: - toc: 'os/core_os/sanity/sanity.md' - 'Functions': - 'os_sanity_check_init': 'os/core_os/sanity/os_sanity_check_init.md' - 'os_sanity_check_register': 'os/core_os/sanity/os_sanity_check_register.md' - 'os_sanity_check_reset': 'os/core_os/sanity/os_sanity_check_reset.md' - 'os_sanity_task_checkin': 'os/core_os/sanity/os_sanity_task_checkin.md' - 'os_sanity_task_init': 'os/core_os/sanity/os_sanity_task_init.md' - Callouts: - toc: 'os/core_os/callout/callout.md' - 'Functions': - 'os_callout_func_init': 'os/core_os/callout/os_callout_func_init.md' - 'os_callout_init': 'os/core_os/callout/os_callout_init.md' - 'os_callout_queued': 'os/core_os/callout/os_callout_queued.md' - 'os_callout_reset': 'os/core_os/callout/os_callout_reset.md' - 'os_callout_stop': 'os/core_os/callout/os_callout_stop.md' - Porting to your Platform: - toc: 'os/core_os/porting/port_os.md' - 'BSP Porting': 'os/core_os/porting/port_bsp.md' - 'MCU Porting': 'os/core_os/porting/port_mcu.md' - 'CPU Porting': 'os/core_os/porting/port_cpu.md' - Console: - toc: 'os/modules/console/console.md' - 'Functions': - 'console_blocking_mode': 'os/modules/console/console_blocking_mode.md' - 'console_echo': 'os/modules/console/console_echo.md' - 'console_init': 'os/modules/console/console_init.md' - 'console_is_init': 'os/modules/console/console_is_init.md' - 'console_printf': 'os/modules/console/console_printf.md' - 'console_read': 'os/modules/console/console_read.md' - 'console_write': 'os/modules/console/console_write.md' - Shell: - toc: 'os/modules/shell/shell.md' - 'Functions': - 'shell_task_init': 'os/modules/shell/shell_task_init.md' - 'shell_cmd_register': 'os/modules/shell/shell_cmd_register.md' - 'shell_nlip_input_register': 'os/modules/shell/shell_nlip_input_register.md' - 'shell_nlip_output': 'os/modules/shell/shell_nlip_output.md' - Bootloader: - toc: 'os/modules/bootloader/bootloader.md' - 'Functions': - 'boot_build_status': 'os/modules/bootloader/boot_build_status.md' - 'boot_build_status_one': 'os/modules/bootloader/boot_build_status_one.md' - 'boot_clear_status': 'os/modules/bootloader/boot_clear_status.md' - 'boot_copy_area': 'os/modules/bootloader/boot_copy_area.md' - 'boot_copy_image': 'os/modules/bootloader/boot_copy_image.md' - 'boot_erase_area': 'os/modules/bootloader/boot_erase_area.md' - 'boot_fill_slot': 'os/modules/bootloader/boot_fill_slot.md' - 'boot_find_image_area_idx': 'os/modules/bootloader/boot_find_image_area_idx.md' - 'boot_find_image_part': 'os/modules/bootloader/boot_find_image_part.md' - 'boot_find_image_slot': 'os/modules/bootloader/boot_find_image_slot.md' - 'boot_go': 'os/modules/bootloader/boot_go.md' - 'boot_init_flash': 'os/modules/bootloader/boot_init_flash.md' - 'boot_move_area': 'os/modules/bootloader/boot_move_area.md' - 'boot_read_image_header': 'os/modules/bootloader/boot_read_image_header.md' - 'boot_read_image_headers': 'os/modules/bootloader/boot_read_image_headers.md' - 'boot_read_status': 'os/modules/bootloader/boot_read_status.md' - 'boot_select_image_slot': 'os/modules/bootloader/boot_select_image_slot.md' - 'boot_slot_addr': 'os/modules/bootloader/boot_slot_addr.md' - 'boot_slot_to_area_idx': 'os/modules/bootloader/boot_slot_to_area_idx.md' - 'boot_swap_areas': 'os/modules/bootloader/boot_swap_areas.md' - 'boot_vect_delete_main': 'os/modules/bootloader/boot_vect_delete_main.md' - 'boot_vect_delete_test': 'os/modules/bootloader/boot_vect_delete_test.md' - 'boot_vect_read_main': 'os/modules/bootloader/boot_vect_read_main.md' - 'boot_vect_read_one': 'os/modules/bootloader/boot_vect_read_one.md' - 'boot_vect_read_test': 'os/modules/bootloader/boot_vect_read_test.md' - 'boot_write_status': 'os/modules/bootloader/boot_write_status.md' - File System: - 'File System Abstraction': - toc: 'os/modules/fs/fs/fs.md' - 'Return Codes': 'os/modules/fs/fs/fs_return_codes.md' - 'Data Structures': - 'struct fs_ops': 'os/modules/fs/fs/fs_ops.md' - 'Functions': - 'fs_close': 'os/modules/fs/fs/fs_close.md' - 'fs_closedir': 'os/modules/fs/fs/fs_closedir.md' - 'fs_dirent_is_dir': 'os/modules/fs/fs/fs_dirent_is_dir.md' - 'fs_dirent_name': 'os/modules/fs/fs/fs_dirent_name.md' - 'fs_filelen': 'os/modules/fs/fs/fs_filelen.md' - 'fs_getpos': 'os/modules/fs/fs/fs_getpos.md' - 'fs_mkdir': 'os/modules/fs/fs/fs_mkdir.md' - 'fs_open': 'os/modules/fs/fs/fs_open.md' - 'fs_opendir': 'os/modules/fs/fs/fs_opendir.md' - 'fs_read': 'os/modules/fs/fs/fs_read.md' - 'fs_readdir': 'os/modules/fs/fs/fs_readdir.md' - 'fs_register': 'os/modules/fs/fs/fs_register.md' - 'fs_rename': 'os/modules/fs/fs/fs_rename.md' - 'fs_seek': 'os/modules/fs/fs/fs_seek.md' - 'fs_unlink': 'os/modules/fs/fs/fs_unlink.md' - 'fs_write': 'os/modules/fs/fs/fs_write.md' - 'fsutil_read_file': 'os/modules/fs/fs/fsutil_read_file.md' - 'fsutil_write_file': 'os/modules/fs/fs/fsutil_write_file.md' - 'Newtron Flash File System': - toc: 'os/modules/fs/nffs/nffs.md' - 'Data Structures': - 'struct nffs_area_desc': 'os/modules/fs/nffs/nffs_area_desc.md' - 'struct nffs_config': 'os/modules/fs/nffs/nffs_config.md' - 'Functions': - 'nffs_detect': 'os/modules/fs/nffs/nffs_detect.md' - 'nffs_format': 'os/modules/fs/nffs/nffs_format.md' - 'nffs_init': 'os/modules/fs/nffs/nffs_init.md' - 'Internals': 'os/modules/fs/nffs/nffs_internals.md' - 'Other File Systems': 'os/modules/fs/otherfs.md' - Hardware Abstraction Layer: - toc: 'os/modules/hal/hal.md' - Architecture: 'os/modules/hal/hal_architecture.md' - 'API': - 'Summary': 'os/modules/hal/hal_api.md' - 'ADC': 'os/modules/hal/hal_adc/hal_adc.md' - 'CPU timer': 'os/modules/hal/hal_cputime/hal_cpu_timer.md' - 'DAC': 'os/modules/hal/hal_dac/hal_dac.md' - 'Flash memory': - 'Overview': 'os/modules/hal/hal_flash/hal_flash.md' - 'flash_int': 'os/modules/hal/hal_flash/hal_flash_int.md' - 'flash_map': 'os/modules/hal/hal_flash/hal_flash_map.md' - 'GPIO': 'os/modules/hal/hal_gpio/hal_gpio.md' - 'I2C': 'os/modules/hal/hal_i2c/hal_i2c.md' - 'PWM': 'os/modules/hal/hal_pwm/hal_pwm.md' - 'SPI': 'os/modules/hal/hal_spi/hal_spi.md' - 'System': 'os/modules/hal/hal_system/hal_sys.md' - 'UART': 'os/modules/hal/hal_uart/hal_uart.md' - 'Using HAL': 'os/modules/hal/hal_in_libraries.md' - 'Creating HAL': 'os/modules/hal/hal_creation.md' - Test Utilities: - toc: 'os/modules/testutil/testutil.md' - 'Functions/Macros': - 'tu_init': 'os/modules/testutil/tu_init.md' - 'TEST_ASSERT': 'os/modules/testutil/test_assert.md' - 'TEST_PASS': 'os/modules/testutil/test_pass.md' - 'TEST_SUITE': 'os/modules/testutil/test_suite.md' - 'TEST_CASE': 'os/modules/testutil/test_case.md' - 'TEST_CASE_DECL': 'os/modules/testutil/test_decl.md' - 'tu_restart': 'os/modules/testutil/tu_restart.md' - Image Manager: - toc: 'os/modules/imgmgr/imgmgr.md' - 'Functions': - 'imgmgr_module_init': 'os/modules/imgmgr/imgmgr_module_init.md' - 'imgr_ver_parse': 'os/modules/imgmgr/imgr_ver_parse.md' - 'imgr_ver_str': 'os/modules/imgmgr/imgr_ver_str.md' - 'Baselibc library': 'os/modules/baselibc.md' - Embedded Lua: - toc: 'os/modules/elua/elua.md' - 'Functions': - 'lua_init': 'os/modules/elua/lua_init.md' - 'lua_main': 'os/modules/elua/lua_main.md' - JSON: - toc: 'os/modules/json/json.md' - 'Functions': - 'json_encode_object_entry': 'os/modules/json/json_encode_object_entry.md' - 'json_encode_object_finish': 'os/modules/json/json_encode_object_finish.md' - 'json_encode_object_key': 'os/modules/json/json_encode_object_key.md' - 'json_encode_object_start': 'os/modules/json/json_encode_object_start.md' - 'json_read_object': 'os/modules/json/json_read_object.md' - Stats: - toc: 'os/modules/stats/stats.md' - Logs: - toc: 'os/modules/logs/logs.md' - BLE User Guide: - NimBLE Introduction: 'network/ble/ble_intro.md' - NimBLE Security: 'network/ble/ble_sec.md' - Set up application: 'network/ble/nimble_setup.md' - Initialize stack: - toc: 'network/ble/ini_stack/ble_ini_intro.md' - 'Add cputime': 'network/ble/ini_stack/ble_add_cpu.md' - 'Create mem pool': 'network/ble/ini_stack/ble_mempool.md' - 'Initialize device addr': 'network/ble/ini_stack/ble_devadd.md' - 'Initialize stats pkg': 'network/ble/ini_stack/ble_statpkg.md' - 'Initialize console pkg': 'network/ble/ini_stack/ble_consolepkg.md' - 'Initialize controller': 'network/ble/ini_stack/ble_controller_ini.md' - 'Initialize parent task': 'network/ble/ini_stack/ble_parent_ini.md' - 'Initialize host': 'network/ble/ini_stack/ble_host_ini.md' - API for bletiny app: - toc: 'network/ble/bletiny_api.md' - 'GAP in bletiny': 'network/ble/bletiny/bletiny_GAP.md' - 'GATT in bletiny': 'network/ble/bletiny/bletiny_GATT.md' - 'Advertisement Data Fields': 'network/ble/bletiny/bletiny_advdata.md' - Newt Tool Guide: - toc: 'newt/newt_intro.md' - Newt Theory of Ops: 'newt/newt_operation.md' - Command Guide: - toc: 'newt/newt_ops.md' - 'newt build': 'newt/command_list/newt_build.md' - 'newt clean': 'newt/command_list/newt_clean.md' - 'newt create-image': 'newt/command_list/newt_create_image.md' - 'newt debug': 'newt/command_list/newt_debug.md' - 'newt help': 'newt/command_list/newt_help.md' - 'newt info': 'newt/command_list/newt_info.md' - 'newt install': 'newt/command_list/newt_install.md' - 'newt load': 'newt/command_list/newt_load.md' - 'newt new': 'newt/command_list/newt_new.md' - 'newt run': 'newt/command_list/newt_run.md' - 'newt size': 'newt/command_list/newt_size.md' - 'newt target': 'newt/command_list/newt_target.md' - 'newt test': 'newt/command_list/newt_test.md' - 'newt upgrade': 'newt/command_list/newt_upgrade.md' - 'newt version': 'newt/command_list/newt_version.md' - Newt Manager Guide: - toc: 'newtmgr/overview.md' - 'Install': 'newtmgr/installing.md' - Known Issues: 'known_issues.md' - Appendix: - 'Edit Docs': 'faq/how_to_edit_docs.md' - 'FAQ': 'faq/answers.md' markdown_extensions: - toc: permalink: False - sane_lists - codehilite: guess_lang: False use_pygments: True noclasses: True pygments_style: xcode extra: version: 'v0_9_0' versions: - label: 'develop' dir: 'latest' latest: True - label: '0.9.0' dir: 'v0_9_0' - label: '1.0.0' dir: 'v1_0_0' doc_path: 'os/introduction' chapters: Chapter 1 - Get Started: 'The chapter organization is outlined below. Each chapter will include one or more tutorials for hands-on experience with the material in each chapter.' Chapter 2 - Get Acclimated: 'Delves deeper into the concepts crucial to the software development effort.' Chapter 3 - Newt Tool: 'Describes the command structure and details all the available commands to help you with your project.' Chapter 4 - Mynewt OS: 'Provides an overview of the features available and how to customize for your hardware and software application.' Chapter 5 - Modules: 'Lays out all the available modules such as HAL (Hardware Abstraction Layer), console, le system, networking stacks, and other middleware components.' Chapter 6 - Packaging it: 'Packages for distribution delineates the process of creating complete packages to load on your embedded device to get it up, connected, and ready for remote management.' events: event 1: title: 'Embedded Systems Conference' description: 'Meet up to discuss Apache Mynewt.' location: "San Jose Convention Center, San Jose, CA, USA" date: '6-8 December, 2016' event 2: title: 'CES' description: 'Contact runtime.io or email us at dev@mynewt.incubator.apache.org to check out and discuss Apache Mynewt and its many uses.' location: "Las Vegas, NV" date: '5-8 January, 2017' copyright: 'Apache Mynewt (incubating) is available under Apache License, version 2.0.' google_analytics: ['UA-72162311-1', 'auto']