Since Doberman developed quite a lot during the last year and humans tend to be bad at documenting what they do, let's collect here what needs to be updated in the documentation and execute the changes step by step:
Home
[x] Infrastructure -> Python: This is most likely outdated. We should identify and document the easiest way to do this.
[x] There is probably some information missing on /etc/hosts and/or /etc/hostname. Need to check whether this is necessary.
Alarms
[x] Alarms are not logged to the DB anymore.
[x] Alarm acknowledgement: Here the doc is ahead of its time. This is related to #35. Somewhat of a unimportant feature IMHO but maybe someone disagrees and wants to implement it.
BigPicture
Need to check
Database
sensors missing fields:
[x] alarm_values
[ ] control_quantity
[x] is_int
[x] is_normally_open
[x] multi_sensor
[ ] valuemap
experiment_config
{name: 'influx'} missing fields:
[ ] schema
[ ] version
Remark: I don't see why we use schema and version here. Also, it might be reasonable to ditch the Influx v1 compatibility to simplify a bit.
{name: 'hypervisor'}:
[x] remote_heartbeat: changes according to #211
[ ] add reference to check heartbeat node
[x] startup_sequence
[x] comms
[x] remove global_dispatch
{name: 'alarm'}
[x] connection_details: somewhat of a mess
[x] max_reading_delay
[x] silence_duration_cant_send
Pipelines
[x] Pipelines have no more status: silenced but a field silenced_until
[x] SensorRespondingAlarm does not exists anymore but DeviceRespondingInfluxNode and DeviceRespondingSyncNode
[x] missing CheckRemoteHeartbeatNode
[x] missing IntegerAlarmNode
[x] missing BitmaskIntegerAlarmNode
[x] DifferentialNode -> DerivativeNode
[ ] missing SensorSourceNode
[ ] missing PipelineSourceNode
Plugins
[x] TestDevice -> CheapSocketDevice
[x] additional_params -> params. This duplicates Database.Device so maybe delete in one location.
Usage
[ ] Common Things: comm ports are handled differently now
[ ] Interprocess communication: Deprecated. Commands don't go through the DB anymore.
Since Doberman developed quite a lot during the last year and humans tend to be bad at documenting what they do, let's collect here what needs to be updated in the documentation and execute the changes step by step:
Home
/etc/hostsand/or/etc/hostname. Need to check whether this is necessary.Alarms
BigPicture
Database
sensors missing fields:
alarm_valuescontrol_quantityis_intis_normally_openmulti_sensorvaluemapexperiment_config
{name: 'influx'}missing fields:schemaversionschemaandversionhere. Also, it might be reasonable to ditch the Influx v1 compatibility to simplify a bit.{name: 'hypervisor'}:remote_heartbeat: changes according to #211startup_sequencecommsglobal_dispatch{name: 'alarm'}connection_details: somewhat of a messmax_reading_delaysilence_duration_cant_sendPipelines
status: silencedbut a fieldsilenced_untilSensorRespondingAlarmdoes not exists anymore butDeviceRespondingInfluxNodeandDeviceRespondingSyncNodeCheckRemoteHeartbeatNodeIntegerAlarmNodeBitmaskIntegerAlarmNodeDifferentialNode->DerivativeNodeSensorSourceNodePipelineSourceNodePlugins
TestDevice->CheapSocketDeviceadditional_params->params. This duplicates Database.Device so maybe delete in one location.Usage