Nerves.Env (nerves v1.7.12) View Source

Contains package info for Nerves dependencies

The Nerves Env is used to load information from dependencies that contain a nerves.exs config file in the root of the dependency path. Nerves loads this config because it needs access to information about Nerves compile time dependencies before any code is compiled.

Link to this section Summary

Functions

bootstrap()

Export environment variables used by Elixir, Erlang, C/C++ and other tools so that they use Nerves toolchain parameters and not the host's.

change_target(target)

Re evaluates the mix file under a different target.

clean(pkgs)

Cleans the artifacts for the package build_runners of all specified packages.

data_dir()

The location for storing global nerves data.

disable()

Disable the Nerves Env compilers

download_dir()

The download location for artifact downloads.

enable()

Enable the Nerves Env compilers

enabled?()

Check if the env compilers are disabled

ensure_loaded(app, path \\ nil)

Ensures that an application which contains a Nerves package config has been loaded into the environment agent.

export_package_env(package)

firmware_path(config \\ mix_config())

The path to the firmware file

host_arch()

Returns the architecture for the host system.

host_os()

Returns the os for the host system.

images_path(config \\ mix_config())

The path to where firmware build files are stored This can be overridden in a Mix project by setting the :images_path key.

loaded?()

Check if the Nerves.Env is loaded

package(name)

Gets a package by app name.

packages()

Lists all Nerves packages loaded in the Nerves environment.

packages_by_type(type, packages \\ nil)

Lists packages by package type.

source_date_epoch()

start()

Starts the Nerves environment agent and loads package information. If the Nerves.Env is already started, the function returns {:error, {:already_started, pid}} with the pid of that process

stop()

Stop the Nerves environment agent.

system()

Helper function for returning the system type package

system_platform()

Helper function for returning the system_platform type package

toolchain()

Helper function for returning the toolchain type package

toolchain_platform()

Helper function for returning the toolchain_platform type package

Link to this section Functions

bootstrap()

Specs

bootstrap() :: :ok

Export environment variables used by Elixir, Erlang, C/C++ and other tools so that they use Nerves toolchain parameters and not the host's.

For a comprehensive list of environment variables, see the documentation for the package defining system_platform.

change_target(target)

Specs

change_target(String.t()) :: :ok

Re evaluates the mix file under a different target.

This allows you to start in one target, like host, but then switch to a different target.

clean(pkgs)

Specs

clean([Nerves.Package.t()]) :: :ok

Cleans the artifacts for the package build_runners of all specified packages.

data_dir()

Specs

data_dir() :: path :: String.t()

The location for storing global nerves data.

The base directory is normally set by the XDG_DATA_HOME environment variable (i.e. $XDG_DATA_HOME/nerves/). If XDG_DATA_HOME is unset, the user's home directory is used (i.e. $HOME/.nerves).

disable()

Specs

disable() :: :ok

Disable the Nerves Env compilers

download_dir()

Specs

download_dir() :: path :: String.t()

The download location for artifact downloads.

Placing an artifact tar in this location will bypass the need for it to be downloaded.

enable()

Specs

enable() :: :ok

Enable the Nerves Env compilers

enabled?()

Specs

enabled?() :: boolean()

Check if the env compilers are disabled

ensure_loaded(app, path \\ nil)

Specs

ensure_loaded(app :: atom(), path :: String.t()) ::
  {:ok, Nerves.Package.t()} | {:error, term()}

Ensures that an application which contains a Nerves package config has been loaded into the environment agent.

Options

app - The atom of the app to load
path - Optional path for the app

export_package_env(package)

firmware_path(config \\ mix_config())

Specs

firmware_path(keyword()) :: String.t()

The path to the firmware file

host_arch()

Specs

host_arch() :: String.t()

Returns the architecture for the host system.

Example return values

"x86_64" "arm"

host_os()

Specs

host_os() :: String.t()

Returns the os for the host system.

Example return values

"win" "linux" "darwin"

images_path(config \\ mix_config())

Specs

images_path(keyword()) :: String.t()

The path to where firmware build files are stored This can be overridden in a Mix project by setting the :images_path key.

images_path: "/some/other/location"

Defaults to (build_path)/nerves/images

loaded?()

Specs

loaded?() :: boolean()

Check if the Nerves.Env is loaded

package(name)

Specs

package(name :: atom()) :: Nerves.Package.t() | nil

Gets a package by app name.

packages()

Specs

packages() :: [Nerves.Package.t()]

Lists all Nerves packages loaded in the Nerves environment.

packages_by_type(type, packages \\ nil)

Lists packages by package type.

source_date_epoch()

start()

Specs

start() :: Agent.on_start()

Starts the Nerves environment agent and loads package information. If the Nerves.Env is already started, the function returns {:error, {:already_started, pid}} with the pid of that process

stop()

Specs

stop() :: :ok

Stop the Nerves environment agent.

system()

Specs

system() :: Nerves.Package.t()

Helper function for returning the system type package

system_platform()

Specs

system_platform() :: module()

Helper function for returning the system_platform type package

toolchain()

Specs

toolchain() :: Nerves.Package.t()

Helper function for returning the toolchain type package

toolchain_platform()

Specs

toolchain_platform() :: Nerves.Package.t()

Helper function for returning the toolchain_platform type package