aboutsummaryrefslogtreecommitdiff
path: root/nixpkgs/nixos/modules/services/misc/gpsd.nix
diff options
context:
space:
mode:
Diffstat (limited to 'nixpkgs/nixos/modules/services/misc/gpsd.nix')
-rw-r--r--nixpkgs/nixos/modules/services/misc/gpsd.nix119
1 files changed, 119 insertions, 0 deletions
diff --git a/nixpkgs/nixos/modules/services/misc/gpsd.nix b/nixpkgs/nixos/modules/services/misc/gpsd.nix
new file mode 100644
index 00000000000..3bfcb636a3c
--- /dev/null
+++ b/nixpkgs/nixos/modules/services/misc/gpsd.nix
@@ -0,0 +1,119 @@
+{ config, lib, pkgs, ... }:
+
+with lib;
+
+let
+
+ uid = config.ids.uids.gpsd;
+ gid = config.ids.gids.gpsd;
+ cfg = config.services.gpsd;
+
+in
+
+{
+
+ ###### interface
+
+ options = {
+
+ services.gpsd = {
+
+ enable = mkOption {
+ type = types.bool;
+ default = false;
+ description = ''
+ Whether to enable `gpsd', a GPS service daemon.
+ '';
+ };
+
+ device = mkOption {
+ type = types.str;
+ default = "/dev/ttyUSB0";
+ description = ''
+ A device may be a local serial device for GPS input, or a URL of the form:
+ <literal>[{dgpsip|ntrip}://][user:passwd@]host[:port][/stream]</literal>
+ in which case it specifies an input source for DGPS or ntrip data.
+ '';
+ };
+
+ readonly = mkOption {
+ type = types.bool;
+ default = true;
+ description = ''
+ Whether to enable the broken-device-safety, otherwise
+ known as read-only mode. Some popular bluetooth and USB
+ receivers lock up or become totally inaccessible when
+ probed or reconfigured. This switch prevents gpsd from
+ writing to a receiver. This means that gpsd cannot
+ configure the receiver for optimal performance, but it
+ also means that gpsd cannot break the receiver. A better
+ solution would be for Bluetooth to not be so fragile. A
+ platform independent method to identify
+ serial-over-Bluetooth devices would also be nice.
+ '';
+ };
+
+ nowait = mkOption {
+ type = types.bool;
+ default = false;
+ description = ''
+ don't wait for client connects to poll GPS
+ '';
+ };
+
+ port = mkOption {
+ type = types.int;
+ default = 2947;
+ description = ''
+ The port where to listen for TCP connections.
+ '';
+ };
+
+ debugLevel = mkOption {
+ type = types.int;
+ default = 0;
+ description = ''
+ The debugging level.
+ '';
+ };
+
+ };
+
+ };
+
+
+ ###### implementation
+
+ config = mkIf cfg.enable {
+
+ users.users = singleton
+ { name = "gpsd";
+ inherit uid;
+ description = "gpsd daemon user";
+ home = "/var/empty";
+ };
+
+ users.groups = singleton
+ { name = "gpsd";
+ inherit gid;
+ };
+
+ systemd.services.gpsd = {
+ description = "GPSD daemon";
+ wantedBy = [ "multi-user.target" ];
+ after = [ "network.target" ];
+ serviceConfig = {
+ Type = "forking";
+ ExecStart = ''
+ ${pkgs.gpsd}/sbin/gpsd -D "${toString cfg.debugLevel}" \
+ -S "${toString cfg.port}" \
+ ${optionalString cfg.readonly "-b"} \
+ ${optionalString cfg.nowait "-n"} \
+ "${cfg.device}"
+ '';
+ };
+ };
+
+ };
+
+}