Differences

This shows you the differences between two versions of the page.

--- tables_fields:other_tables:coldchain [2023/01/31 02:52] – Adam Dewey
+++ tables_fields:other_tables:coldchain [2023/02/01 02:55] (current) – Adam Dewey
@@ Line 7: / Line 7: @@
 ====== Sensor ======
+<WRAP center round alert 100%>
+Central data</WRAP>
 ^ Field name ^ Description ^ Type ^ Indexed ^
@@ Line 14: / Line 17: @@
 | macAddress       | The mac address of the sensor | Text |  |
 | batteryLevel       | The most recent battery % reading of the sensor | Real |  |
-| temperature      | | Real |  |
+| temperature      | The most recent temperature reading of the sensor | Real |  |
 | lastConnectionDate      |  | Date |  |
-| lasstConnectionTime          |  | Time |  |
+| lastConnectionTime          |  | Time |  |
 | **storeID**          | The ID of the store to which this sensor belongs | Alpha | * |
 | logInterval           | The interval between taking temperature readings (in seconds) | Long |  |
 | numberOfLogs          |  | Long |  |
 | is_active       | Whether the sensor is marked as active or not | Boolean |  |
-| log_delay_time          |  | Time |  |
+| log_delay_time          | The date that the user selected to start recording temperature logs | Time |  |
-| log_delay_date          |  | Date |  |
+| log_delay_date          | The time that the user selected to start recording temperature logs | Date |  |
 | programmed_date          |  | Date | |
 | programmed_time          |  | Time |  |
@@ Line 39: / Line 42: @@
 | isInBreach       |  | Boolean |  |
 | **storeID**       |  | Alpha | * |
-| temperature       |  | Long |  |
+| temperature       |  | Real |  |
@@ Line 52: / Line 55: @@
 ^ Field name ^ Description ^ Type ^ Indexed ^
-| **ID**         |  | Alpha | * |
+| **ID**         | The unique identifying number assigned to this breach | Alpha | * |
-| start_date    |  | Date |  |
+| start_date    | The date that the breach began (the temperature entered the range of temperatures defining the breach) | Date |  |
-| start_time    |  | Time |  |
+| start_time    | The time that the breach began (entered the range of temperatures defining the breach)  | Time |  |
-| end_date    |  | Date |  |
+| end_date    | The date that the breach completed (exited the temperature range) | Date |  |
-| end_time    |  | Time |  |
+| end_time    | The time the breach completed (exited the temperature range). | Time |  |
-| location_ID    |  | Alpha |  |
+| location_ID    | The location of the sensor at the time that the breach was reported | Alpha |  |
-| store_ID    |  | Alpha |  |
+| store_ID    | The store of the sensor at the time that the breach was reported | Alpha |  |
-| temperature_breach_config_ID    |  | Alpha |  |
+| temperature_breach_config_ID    | The ID of the breach configuration that defines the duration and temperature for this breach | Alpha |  |
-| acknowledged    |  | Boolean |  |
+| acknowledged    | Whether the breach has been marked as 'acknowledged' by the user | Boolean |  |
-| sensor_ID    |  | Alpha |  |
+| sensor_ID    | The ID of the sensor that reported this breach | Alpha |  |
-| threshold_maximum_temperature    |  | Long|  |
+| threshold_maximum_temperature    | The upper bound temperature for the breach configuration | Real|  |
-| threshold_minimum_temperature    |  | Long |  |
+| threshold_minimum_temperature    | The lower bound temperature for the breach configuration | Real |  |
-| threshold_duration    |  | Int |  |
+| threshold_duration    | The duration threshold for the breach configuration | Int |  |
-| type    |  | Alpha |  |
+| type    | The type of breach - Hot / Cold, Consecutive or Cumulative | Alpha |  |
@@ Line 71: / Line 74: @@
 ====== temperature_breach_config ======
-====== temperature_log ======
+^ Field name ^ Description ^ Type ^ Indexed ^
+| **ID**         | The unique identifying number assigned to this breach configuration | Alpha | * |
+| maximum_temperature    | The upper bound temperature for the range of temperatures the breach is defined for. For example, if a breach is defined for all temperatures over 8 degrees, the maximum will be infinity.  | Real |  |
+| minimum_temperature    | The lower bound temperature for the range of temperatures the breach is defined for. For example, if a breach is defined for all temperatures over 8 degrees, the minimum will be 8. | Real |  |
+| duration    | The duration a temperature must have been within the thresholds for it to be considered a breach. (milliseconds) | Long |  |
+| colour    | Contains hexidecimal codes for colours. Use case: Displaying a line on a graph in a certain colour - red for a 'hot breach', blue for a 'cold breach' | Alpha |  |
+| description    | Description of the breach configuration, e.g. 'Hot breach' | Alpha |  |
+| is_active    | Whether the breach is currently ongoing or not | Boolean |  |
+| location_type_ID    |  | Alpha |  |
+| store_ID    |  | Alpha |  |
+| type    | The type of breach - Hot / Cold, Consecutive or Cumulative  | Alpha |  |
+| location_ID    |  | Alpha |  |
+====== temperature_log ======
+^ Field name ^ Description ^ Type ^ Indexed ^
+| **ID**         | The unique identifying number assigned to this temperature log | Alpha | * |
+| temperature    | The temperature of the log (in Celsius) | Real |  |
+| date    | The date of the log | Date |  |
+| time    | The time of the log | Time |  |
+| location_ID    | The location of the sensor at the time of the log | Alpha |  |
+| temperature_breach_ID    | Indicates that this temperature log is contributing to a temperature_breach, which can span many temperature logs | Alpha |  |
+| store_ID    | The store of the sensor at the time of the log | Alpha |  |
+| sensor_ID    | The unique identifying number of the sensor that took the log | Alpha |  |
+| log_interval    | The interval between taking temperature readings of the sensor at the time of the log (in seconds) | Long |  |
 ---- struct data ----
 pagestatus.status    :
 ----