nerves
▼
Project version
v1.11.3
v1.11.2
v1.11.1
v1.11.0
v1.10.5
v1.10.4
v1.10.3
v1.10.2
v1.10.1
v1.10.0
v1.9.3
v1.9.2
v1.9.1
v1.9.0
v1.8.0
v1.7.17
v1.7.16
v1.7.15
v1.7.14
v1.7.13
v1.7.12
v1.7.11
v1.7.10
v1.7.9
v1.7.8
v1.7.7
v1.7.6
v1.7.5
v1.7.4
v1.7.3
v1.7.2
v1.7.1
v1.7.0
v1.6.7
v1.6.6
v1.6.5
v1.6.4
v1.6.3
v1.6.2
v1.6.1
v1.6.0
v1.5.5
v1.5.4
v1.5.3
v1.5.2
v1.5.1
v1.5.0
v1.4.5
v1.4.4
v1.4.3
v1.4.2
v1.4.1
v1.4.0
v1.3.4
v1.3.3
v1.3.2
v1.3.1
v1.3.0
v1.2.1
v1.2.0
v1.1.1
v1.1.0
v1.0.1
v1.0.0
v1.0.0-rc.2
v1.0.0-rc.1
v1.0.0-rc.0
v0.11.0
v0.10.1
v0.10.0
v0.9.4
v0.9.3
v0.9.2
v0.9.1
v0.9.0
v0.8.3
v0.8.2
v0.8.1
v0.8.0
v0.7.5
v0.7.4
v0.7.3
v0.7.2
v0.7.1
v0.7.0
v0.6.1
v0.6.0
v0.5.2
v0.5.1
v0.5.0
v0.4.8
v0.4.7
v0.4.6
v0.4.5
v0.4.4
v0.4.3
v0.4.2
v0.4.1
v0.4.0
v0.4.0-rc.0
v0.3.4
v0.3.3
v0.3.2
v0.3.1
v0.3.0
GUIDES
Modules
Mix
Tasks
API Reference
Modules
Mix Tasks
Changelog
v1.11.3 - 2025-01-06
v1.11.2 - 2024-09-27
v1.11.1 - 2024-08-05
v1.11.0 - 2024-07-05
v1.10.5 - 2023-12-26
v1.10.4 - 2023-09-13
v1.10.3 - 2023-07-07
v1.10.2 - 2023-04-11
v1.10.1 - 2023-03-08
v1.10.0 - 2023-03-03
v1.9.3 - 2023-02-11
v1.9.2 - 2023-02-05
v1.9.1 - 2022-09-11
v1.9.0 - 2022-08-23
v1.8.0 - 2022-05-11
v1.7.16
v1.7.15
v1.7.14
v1.7.13
v1.7.12
v1.7.11
v1.7.10
v1.7.9
v1.7.8
v1.7.7
v1.7.6
v1.7.5
v1.7.4
v1.7.3
v1.7.2
v1.7.1
v1.7.0
v1.6.5
v1.6.4
v1.6.3
v1.6.2
v1.6.1
v1.6.0
v1.5.4
v1.5.3
v1.5.2
v1.5.1
v1.5.0
v1.4.5
v1.4.4
v1.4.3
v1.4.2
v1.4.1
v1.4.0
v1.3.4
v1.3.3
v1.3.2
v1.3.1
v1.3.0
v1.2.1
v1.2.0
v1.1.1
v1.1.0
v1.0.1
v1.0.0
v1.0.0-rc.2
v1.0.0-rc.1
v1.0.0-rc.0
v0.11.0
v0.10.1
v0.10.0
v0.9.4
v0.9.3
v0.9.2
v0.9.1
v0.9.0
v0.8.3
v0.8.2
v0.8.1
v0.8.0
v0.7.5
v0.7.4
v0.7.3
v0.7.2
v0.7.1
0.7.0
0.6.1
0.6.0
0.5.2
0.5.1
0.5.0
0.4.8
0.4.7
0.4.6
0.4.5
0.4.4
0.4.3
0.4.2
0.4.1
0.4.0
0.4.0-rc.0
0.3.4
0.3.3
0.3.2
0.3.1
0.3.0
0.2.0
Introduction
Getting Started
Introduction
Common terms
Development environment
Nerves + Livebook
Creating a project
Deploying your firmware
Connecting to your device
Using IEx
Example projects
Community links
Installation
MacOS
Windows
Linux
All platforms
Core
Connecting to a Nerves Target
USB to TTL serial cable (UART)
HDMI cable
USB data cable
Wireless and wired Ethernet connections
Frequently Asked Questions
Where can persistent data be stored?
How can I apply a firmware update manually?
How do I push firmware updates remotely?
Change Behavior on BEAM Failure
Platform-Specific Hardware Support
IEx with Nerves
Viewing log messages
Other loggers
Networking
Toolshed
Linux shell commands
Customizing the IEx session
Changing the IEx console output
Remote console access
Erlang and LFE prompts
Supported Targets
Supported Targets and Systems
Supporting New Target Hardware
User Interfaces
Phoenix web interface
Scenic
Kiosk
eInk displays
OLED
Advanced
Advanced Configuration
Target-Specific Configuration
Root Filesystem Overlays
Partitions
Kernel Parameters
Building Nerves Systems with the nerves_systems Repository
Prerequisites
Step 1: Configuring the Build Environment
Step 2: Building Your Nerves Systems
Step 3: Using Your Custom Nerves System
Step 4: Customizing the Build (Optional)
Compiling Non-BEAM Code
Library recommendations
Customizing Your Nerves System
Getting Setup to Build a System
Building the System
Buildroot Package Configuration
Adding a custom Buildroot Package
Creating an Artifact
Custom System Maintenance
Environment variables
Overridable variables
Nerves-provided environment variables
Target CPU, ARCH, OS, and ABI
Experimental features
Firmware patches
Nerves package environment variables
Nerves Internals
Call Tree
Key Files/Variables
Systems
Using a Nerves System
Compatibility
Anatomy of a Nerves System
Nerves Package Configuration
Customizing Your Own Nerves System
Updating Projects
Updating from v0.8 to v0.9
Updating from v0.9 to v1.0.0-rc.0
Updating from v1.0.0-rc.0 to v1.0.0-rc.2
Updating from v1.0 to v1.3
Updating from v1.3 to v1.4
Updating from v1.4 to v1.5
Updating from v1.5 to v1.6
Updating from v1.6 to v1.7
Nerves.Artifact
Summary
Functions
archive/3
base_dir/0
build/2
build_path/1
build_path_link/1
build_runner/1
checksum/2
clean/1
dir/1
download_name/2
download_path/1
env_var/1
env_var?/1
expand_sites/1
ext/1
host_tuple/1
name/1
stale?/1
Nerves.Artifact.BuildRunner
Summary
Types
archive_result/0
build_result/0
clean_result/0
Callbacks
archive/3
build/3
clean/1
Nerves.Artifact.BuildRunners.Docker
Sections
Images
Volumes and Cache
Cleanup
Summary
Functions
build/3
parse_docker_version/1
system_shell/1
Nerves.Artifact.BuildRunners.Local
Summary
Functions
archive/3
build/3
clean/1
system_shell/1
Nerves.Artifact.Resolvers.URI
Summary
Functions
get/1
Nerves.Env
Summary
Functions
bootstrap/0
change_target/1
clean/1
data_dir/0
disable/0
download_dir/0
enable/0
enabled?/0
ensure_loaded/2
export_package_env/1
firmware_path/1
host_arch/0
host_os/0
images_path/1
loaded?/0
package/1
packages/0
packages_by_type/2
start/0
stop/0
system/0
system_platform/0
toolchain/0
toolchain_platform/0
Nerves.Erlinit
Summary
Types
option/0
t/0
Functions
decode_config/1
encode_config/1
merge_opts/2
system_config_file/1
Nerves.Package
Summary
Types
t/0
Functions
config/2
config_path/1
load_config/1
shell/1
Nerves.Package.Platform
Summary
Callbacks
bootstrap/1
build_path_link/1
Nerves.Port
Summary
Functions
cmd/3
exec_path/0
Nerves.System.BR
Summary
Functions
archive/3
bootstrap/1
build/3
build_path_link/1
clean/1
Nerves.Utils.WSL
Summary
Functions
admin_powershell_command/2
cleanup_file/2
execute_wslpath/2
get_fwup_devices/0
get_temp_file_location/1
get_wsl_paths/2
has_wslpath?/0
make_file_accessible/3
path_accessible_in_windows?/2
running_on_wsl?/0
valid_windows_path?/1
valid_wsl_path?/1
mix burn
Sections
Command line options
Examples
Summary
Functions
firmware_file/1
mix compile.nerves_package
mix firmware
Sections
Command line options
Environment variables
mix firmware.burn
Sections
Command line options
Environment variables
Examples
mix firmware.gen.gdb
mix firmware.image
Sections
Usage
Examples
mix firmware.metadata
Sections
Command line options
Examples
Summary
Functions
firmware_file/1
mix firmware.patch
Sections
Command line options
mix firmware.unpack
Sections
Usage
Command line options
Examples
mix nerves.artifact
Sections
Command line options
Examples
mix nerves.artifact.details
Sections
Examples
mix nerves.clean
mix nerves.info
mix nerves.system.shell
Sections
Examples
Search documentation of nerves
Settings
View Source
Nerves.Artifact.Resolvers.URI
(nerves v1.11.3)
Downloads an artifact from a remote http location.
Summary
Functions
get(arg)
Download the artifact from an http location
Functions
get(arg)
Download the artifact from an http location
×