nerves_time

defmodule NervesTime do
  @moduledoc """
  Keep time in sync on Nerves devices

  `NervesTime` keeps the system clock on [Nerves](http://nerves-project.org)
  devices in sync when connected to the network and close to in sync when
  disconnected. It's especially useful for devices lacking a [Battery-backed
  real-time clock](https://en.wikipedia.org/wiki/Real-time_clock) and will
  advance the clock at startup to a reasonable guess.

  Nearly all configuration is via the application config (`config.exs`). The
  following keys are available:

  * `:servers` - a list of NTP servers for time synchronization. Specifying an
    empty list turns off NTP
  * `:time_file` - a file path for tracking the time. It allows the system to
    start with a reasonable time quickly on boot and before the Internet is
    available for NTP to work.
  * `:earliest_time` - times before this are considered invalid and adjusted
  * `:latest_time` - times after this are considered invalid and adjusted
  * `:ntpd` - the absolute path to the Busybox `ntpd`. This only needs to be
    set if your system does not provide `ntpd` in the `$PATH`.
  """

  @doc """
  Check whether NTP is synchronized with the configured NTP servers

  It's possible that the time is already set correctly when this returns false.
  `NervesTime` decides that NTP is synchronized when `ntpd` sends a
  notification that the device's clock stratum is 4 or less. Clock adjustments
  occur before this, though.

  Once NTP is synchronized, it will remain that way until the `nerves_time`
  application is restarted.
  """
  @spec synchronized?() :: boolean()
  defdelegate synchronized?, to: NervesTime.Ntpd

  @doc """
  Set the list of NTP servers

  Use this function to replace the list of NTP servers that are queried for
  time. It is also possible to set this list in your `config.exs` by doing
  something like the following:

  ```elixir
  config :nerves_time, :servers, [
    "0.pool.ntp.org",
    "1.pool.ntp.org",
    "2.pool.ntp.org",
    "3.pool.ntp.org"
  ]
  ```

  `NervesTime` uses [NTP Pool](https://www.ntppool.org/en/) by default. To
  disable this and configure servers solely at runtime, specify an empty list
  in `config.exs`:

  ```elixir
  config :nerves_time, :servers, []
  ```
  """
  @spec set_ntp_servers([String.t()]) :: :ok
  defdelegate set_ntp_servers(servers), to: NervesTime.Ntpd

  @doc """
  Return the current NTP servers
  """
  @spec ntp_servers() :: [String.t()] | {:error, term()}
  defdelegate ntp_servers(), to: NervesTime.Ntpd

  @doc """
  Manually restart the NTP daemon

  This is normally not necessary since `NervesTime` handles restarting it
  automatically. An example of a reason to call this function is if you know
  when the Internet becomes available. For this case, calling `restart_ntp`
  will cancel `ntpd`'s internal timeouts and cause it to immediately send time
  requests. If using NTP Pool, be sure not to violate its terms of service by
  calling this function too frequently.
  """
  @spec restart_ntpd() :: :ok | {:error, term()}
  defdelegate restart_ntpd(), to: NervesTime.Ntpd
end