FAQ - Revision history

Mwood: /* List Devices */

2026-04-20T15:58:07Z

‎List Devices

Mwood: /* Example */ Remove example section since each language implementation provides its own example

2026-04-20T15:07:33Z

‎Example: Remove example section since each language implementation provides its own example

Mwood: /* Zsh */

2026-04-20T15:06:14Z

‎Zsh

Mwood: /* Implementations */ Add a Zsh implementation

2026-04-20T15:04:49Z

‎Implementations: Add a Zsh implementation

Mwood: /* Implementations */

2026-04-20T15:01:17Z

‎Implementations

Mwood: /* Implementations */

2026-04-20T15:00:52Z

‎Implementations

Mwood: /* PHP */

2026-04-20T14:57:44Z

‎PHP

Mwood: /* Bash */

2026-04-20T14:57:25Z

‎Bash

Mwood: /* Bash */ Update Bash example

2026-04-20T14:53:54Z

‎Bash: Update Bash example

Mwood: /* PHP */ Update PHP example

2026-04-20T14:49:30Z

‎PHP: Update PHP example

@@ Line 87: / Line 87: @@
 =====List Devices=====
-First let's list all devices associated with our account and choose one from the results.
+First let's list all devices associated with our account and choose one from the results.  To do this we will make a call to the Dashboard resource, requesting the name and device_id of each device on our account.
 <syntaxhighlight lang="JavaScript">
@@ Line 105: / Line 105: @@
 </syntaxhighlight>
-Under the '''response''' object in the reply from the server is an array of devices.  The device_id is listed in this information.  For the remainder of this example let's assume we have acquired the following device_id:
+The array of device data can be found in the '''response''' object in the server's reply.  For the remainder of this example let's assume we have acquired the following device_id:
    device_id = 9191

@@ Line 437: / Line 437: @@
 sensaphoneTime(date); // --> 671113800
 </syntaxhighlight>
 ===References===
 * [[Sensaphone.net API/history#Timestamps|Sensaphone-encoded timestamps]]:  More info regarding timestamp encoding
 * [https://en.wikipedia.org/wiki/Modulo_operation Modulo (mod) operation]: Information about the modulo operation.

@@ Line 324: / Line 324: @@
      local year=$(( t[year]   + 0 ))
-     echo $(( (second % 60) +
+     echo $(( (second            % 60) +
-        ((minute * 60) % 3600) +
+             ((minute      * 60) % 3600) +
-        ((hour * 3600) % 86400) +
+             ((hour        * 3600) % 86400) +
-        ((day * 86400) % 2678400) +
+             ((day         * 86400) % 2678400) +
-        ((month * 2678400) % 32140800) +
+             ((month       * 2678400) % 32140800) +
-        ((year % 100) * 32140800) ))
+             ((year % 100) * 32140800) ))
+}
 </syntaxhighlight>
@@ Line 350: / Line 350: @@
 environment.
 |}
 ====Python====

← Older revision		Revision as of 15:04, 20 April 2026
Line 287:		Line 287:
	</syntaxhighlight>		</syntaxhighlight>

		+	==== Zsh ====
		+	This implementation uses the <code>zsh/datetime</code> module's <code>strptime</code>
		+	and <code>strftime</code> builtins to parse and decompose dates without invoking
		+	an external <code>date</code> program. It accepts ISO 8601 format date strings
		+	and handles base-0 conversion internally.
		+
		+	<syntaxhighlight lang="bash" line>
		+	sensaphone_time() {
		+	local date_string="$1"
		+	local unix_time
		+
		+	# Load zsh datetime module for strptime and strftime builtins
		+	zmodload zsh/datetime
		+
		+	# Parse date string to Unix timestamp using the strptime builtin.
		+	# Accepts ISO 8601 format: "YYYY-MM-DD HH:MM:SS"
		+	strptime -s unix_time "%Y-%m-%d %H:%M:%S" "$date_string"
		+
		+	# Decompose Unix timestamp into named components using strftime -s.
		+	# strftime zero-pads values (e.g. "08"), so we use (( x + 0 )) to
		+	# strip leading zeros before arithmetic to avoid octal interpretation.
		+	# Day and month are adjusted to base-0 as required by the API.
		+	local -A t
		+	strftime -s t[second] "%S" $unix_time
		+	strftime -s t[minute] "%M" $unix_time
		+	strftime -s t[hour] "%H" $unix_time
		+	strftime -s t[day] "%d" $unix_time
		+	strftime -s t[month] "%m" $unix_time
		+	strftime -s t[year] "%Y" $unix_time
		+
		+	local second=$(( t[second] + 0 ))
		+	local minute=$(( t[minute] + 0 ))
		+	local hour=$(( t[hour] + 0 ))
		+	local day=$(( t[day] + 0 - 1 ))
		+	local month=$(( t[month] + 0 - 1 ))
		+	local year=$(( t[year] + 0 ))
		+
		+	echo $(( (second % 60) +
		+	((minute * 60) % 3600) +
		+	((hour * 3600) % 86400) +
		+	((day * 86400) % 2678400) +
		+	((month * 2678400) % 32140800) +
		+	((year % 100) * 32140800) ))
		+	}
		+	</syntaxhighlight>
		+
		+	Example usage:
		+
		+	<syntaxhighlight lang="bash" line>
		+	# Accepts ISO 8601 format date strings
		+	sensaphone_time "2020-11-18 12:30:00" # --> 671113800
		+	</syntaxhighlight>
		+
		+	{\| class="wikitable" style="border-left: 4px solid #f90; background-color: #fff8e6; width: 100%;"
		+	\|-
		+	\| '''⚠ Note: <code>zsh/datetime</code> and timezone behavior'''
		+
		+	The <code>zsh/datetime</code> module is included in all standard zsh
		+	distributions and does not require separate installation. As with the other
		+	implementations on this page, dates are interpreted in local time. To use UTC,
		+	set <code>TZ=UTC</code> before calling the function, or export it in your
		+	environment.
		+	\|}
	====Python====		====Python====

@@ Line 235: / Line 235: @@
 ===Implementations===
-Provided below are some helpful functions to convert date and time into Sensaphone time.
+Provided below are some helpful functions to convert date and time into Sensaphone time stamps.
 ==== Bash ====

@@ Line 314: / Line 314: @@
 </syntaxhighlight>
-=== PHP ===
+==== PHP ====
 This implementation accepts a standard <code>DateTime</code> object.

← Older revision		Revision as of 14:57, 20 April 2026
Line 238:		Line 238:


−	=== Bash ===	+	==== Bash ====

	This implementation accepts a natural language date string and uses the		This implementation accepts a natural language date string and uses the

@@ Line 236: / Line 236: @@
 ===Implementations===
 While all largely the same basic syntax, the following are implementations of the conversion algorithm in various languages.
-====Bash====
 This snippet is useful if you are using cURL to make your REST calls from the command line.
-<syntaxhighlight lang="bash" line='line'>
 sensaphone_time() {
-     local year=$1
+     local date_string="$1"
      local month=$2
-     local day=$3
+     # Parse date string to Unix timestamp
-     local hours=$4
+    # GNU date (Linux) accepts free-form strings via -d
-     local minutes=$5
+    # BSD date (macOS) requires ISO 8601 format: "YYYY-MM-DD HH:MM:SS"
-     local seconds=$6
+    if date --version &>/dev/null 2>&1; then
      echo $sensaphone_timestamp
+}
 </syntaxhighlight>

@@ Line 283: / Line 283: @@
 </syntaxhighlight>
-====PHP====
+=== PHP ===
-<syntaxhighlight lang="PHP" line>
 <?php
-function sensaphoneTime($year, $month, $day, $hours, $minutes, $seconds) {
+function sensaphone_time(DateTime $dt): int {
-     return ( $seconds         % 60) +
+    $second = (int)$dt->format('s');
-           (($minutes     * 60) % 3600) +
+    $minute = (int)$dt->format('i');
-           (($hours       * 3600) % 86400) +
+    $hour   = (int)$dt->format('G');
-           (($day         * 86400) % 2678400) +
+    $day    = (int)$dt->format('j') - 1;
-           (($month       * 2678400) % 32140800) +
+    $month  = (int)$dt->format('n') - 1;
-           (($year % 100) * 32140800);
+    $year   = (int)$dt->format('Y');
+}
 ?>
 </syntaxhighlight>